From cde4a51d70d0e08cea271cc75e6cc8c234d7e062 Mon Sep 17 00:00:00 2001 From: Greg Pfeil Date: Thu, 1 Jun 2023 13:30:23 -0600 Subject: [PATCH 01/11] Add packaging This adds an [Eldev](https://doublep.github.io/eldev/) build and a [Nix](https://nixos.org/manual/nix/stable/) flake around it. --- .dir-locals.el | 4 + .editorconfig | 22 ++++ .envrc | 1 + .gitattributes | 2 + .gitignore | 12 ++ Eldev | 10 ++ flake.lock | 192 ++++++++++++++++++++++++++++++++ flake.nix | 253 +++++++++++++++++++++++++++++++++++++++++++ nix/dependencies.nix | 12 ++ 9 files changed, 508 insertions(+) create mode 100644 .dir-locals.el create mode 100644 .editorconfig create mode 100644 .envrc create mode 100644 .gitattributes create mode 100644 Eldev create mode 100644 flake.lock create mode 100644 flake.nix create mode 100644 nix/dependencies.nix diff --git a/.dir-locals.el b/.dir-locals.el new file mode 100644 index 0000000..32563be --- /dev/null +++ b/.dir-locals.el @@ -0,0 +1,4 @@ +((nil + (fill-column . 80) + (indent-tabs-mode . nil) + (sentence-end-double-space . t))) diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..67515d4 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,22 @@ +### This configures basic cross-editor formatting. +### +### See https://editorconfig.org/ for more info, and to see if your editor +### requires a plugin to take advantage of it. + +root = true + +[*] +charset = utf-8 +end_of_line = lf +indent_size = 2 +indent_style = space +insert_final_newline = true +trim_trailing_whitespace = true + +[*.{diff,patch}] +trim_trailing_whitespace = false + +[*.{el,lisp}] +## Lisps have a fairly consistent indentation style that doesn’t collapse well +## to a single value, so we let the editor do what it wants here. +indent_size = unset diff --git a/.envrc b/.envrc new file mode 100644 index 0000000..3550a30 --- /dev/null +++ b/.envrc @@ -0,0 +1 @@ +use flake diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..25fb6d4 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +# Don’t render generated files by default in GitHub diffs +flake.lock linguist-generated diff --git a/.gitignore b/.gitignore index c531d98..5a8cd58 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,13 @@ +# Direnv +/.direnv + +# Nix build +/outputs +/result +/source + +# Compiled *.elc + +# Packaging +/.eldev diff --git a/Eldev b/Eldev new file mode 100644 index 0000000..a04d582 --- /dev/null +++ b/Eldev @@ -0,0 +1,10 @@ +;; -*- mode: emacs-lisp; lexical-binding: t; -*- + +(require 'eldev) + +(setq + ;; run all linters by default + eldev-lint-default t + ;; except ‘package-lint’, because it’s also run within ‘elisp-lint’ (see + ;; ‘eldev-linter-elisp’) + eldev-lint-default-excluded '(package-lint)) diff --git a/flake.lock b/flake.lock new file mode 100644 index 0000000..14ae7d7 --- /dev/null +++ b/flake.lock @@ -0,0 +1,192 @@ +{ + "nodes": { + "bash-strict-mode": { + "inputs": { + "flake-utils": "flake-utils", + "home-manager": "home-manager", + "nixpkgs": [ + "nixpkgs" + ], + "shellcheck-nix-attributes": "shellcheck-nix-attributes" + }, + "locked": { + "lastModified": 1674014107, + "narHash": "sha256-UgrmDzeSp+li0/wtn0zRZicqy2595bUftW1bMBfP+5Y=", + "owner": "sellout", + "repo": "bash-strict-mode", + "rev": "da573e33174d7078e62eb2a9d9eb7d662e5b4913", + "type": "github" + }, + "original": { + "owner": "sellout", + "repo": "bash-strict-mode", + "type": "github" + } + }, + "flake-utils": { + "locked": { + "lastModified": 1667395993, + "narHash": "sha256-nuEHfE/LcWyuSWnS8t12N1wc105Qtau+/OdUAjtQ0rA=", + "owner": "numtide", + "repo": "flake-utils", + "rev": "5aed5285a952e0b949eb3ba02c12fa4fcfef535f", + "type": "github" + }, + "original": { + "owner": "numtide", + "repo": "flake-utils", + "type": "github" + } + }, + "flake-utils_2": { + "inputs": { + "systems": "systems" + }, + "locked": { + "lastModified": 1685518550, + "narHash": "sha256-o2d0KcvaXzTrPRIo0kOLV0/QXHhDQ5DTi+OxcjO8xqY=", + "owner": "numtide", + "repo": "flake-utils", + "rev": "a1720a10a6cfe8234c0e93907ffe81be440f4cef", + "type": "github" + }, + "original": { + "owner": "numtide", + "repo": "flake-utils", + "type": "github" + } + }, + "home-manager": { + "inputs": { + "nixpkgs": [ + "bash-strict-mode", + "nixpkgs" + ], + "utils": "utils" + }, + "locked": { + "lastModified": 1672244468, + "narHash": "sha256-xaZb8AZqoXRCSqPusCk4ouf+fUNP8UJdafmMTF1Ltlw=", + "owner": "nix-community", + "repo": "home-manager", + "rev": "89a8ba0b5b43b3350ff2e3ef37b66736b2ef8706", + "type": "github" + }, + "original": { + "owner": "nix-community", + "ref": "release-22.11", + "repo": "home-manager", + "type": "github" + } + }, + "home-manager_2": { + "inputs": { + "nixpkgs": [ + "nixpkgs" + ], + "utils": "utils_2" + }, + "locked": { + "lastModified": 1681092193, + "narHash": "sha256-JerCqqOqbT2tBnXQW4EqwFl0hHnuZp21rIQ6lu/N4rI=", + "owner": "nix-community", + "repo": "home-manager", + "rev": "f9edbedaf015013eb35f8caacbe0c9666bbc16af", + "type": "github" + }, + "original": { + "owner": "nix-community", + "ref": "release-22.11", + "repo": "home-manager", + "type": "github" + } + }, + "nixpkgs": { + "locked": { + "lastModified": 1685587708, + "narHash": "sha256-kd+vA/n7cmCL1QWbKcrcwfq2fl6u6By2t6mS7tQgw7Y=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "041fc5df0031224c56bbd47165d45b16cb628ca9", + "type": "github" + }, + "original": { + "owner": "NixOS", + "ref": "release-22.11", + "repo": "nixpkgs", + "type": "github" + } + }, + "root": { + "inputs": { + "bash-strict-mode": "bash-strict-mode", + "flake-utils": "flake-utils_2", + "home-manager": "home-manager_2", + "nixpkgs": "nixpkgs" + } + }, + "shellcheck-nix-attributes": { + "flake": false, + "locked": { + "lastModified": 1586929030, + "narHash": "sha256-a0WyWaz+nMYFWI43Ip9EUnPuBW0O4EIiTzYZKGqNjss=", + "owner": "Fuuzetsu", + "repo": "shellcheck-nix-attributes", + "rev": "51b49d5fe65ece69eb5e2003396bf096083ec281", + "type": "github" + }, + "original": { + "owner": "Fuuzetsu", + "repo": "shellcheck-nix-attributes", + "type": "github" + } + }, + "systems": { + "locked": { + "lastModified": 1681028828, + "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", + "owner": "nix-systems", + "repo": "default", + "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", + "type": "github" + }, + "original": { + "owner": "nix-systems", + "repo": "default", + "type": "github" + } + }, + "utils": { + "locked": { + "lastModified": 1667395993, + "narHash": "sha256-nuEHfE/LcWyuSWnS8t12N1wc105Qtau+/OdUAjtQ0rA=", + "owner": "numtide", + "repo": "flake-utils", + "rev": "5aed5285a952e0b949eb3ba02c12fa4fcfef535f", + "type": "github" + }, + "original": { + "owner": "numtide", + "repo": "flake-utils", + "type": "github" + } + }, + "utils_2": { + "locked": { + "lastModified": 1667395993, + "narHash": "sha256-nuEHfE/LcWyuSWnS8t12N1wc105Qtau+/OdUAjtQ0rA=", + "owner": "numtide", + "repo": "flake-utils", + "rev": "5aed5285a952e0b949eb3ba02c12fa4fcfef535f", + "type": "github" + }, + "original": { + "owner": "numtide", + "repo": "flake-utils", + "type": "github" + } + } + }, + "root": "root", + "version": 7 +} diff --git a/flake.nix b/flake.nix new file mode 100644 index 0000000..3457f52 --- /dev/null +++ b/flake.nix @@ -0,0 +1,253 @@ +{ + description = "A custom Lisp reader written in Elisp."; + + nixConfig = { + ## https://github.com/NixOS/rfcs/blob/master/rfcs/0045-deprecate-url-syntax.md + extra-experimental-features = ["no-url-literals"]; + extra-trusted-public-keys = [ + "cache.garnix.io:CTFPyKSLcx5RMJKfLo5EEPUObbA78b0YQ2DTCJXqr9g=" + ]; + extra-trusted-substituters = ["https://cache.garnix.io"]; + ## Isolate the build. + registries = false; + sandbox = true; + }; + + outputs = inputs: let + pname = "elisp-reader"; + ename = "emacs-${pname}"; + in + { + overlays = { + default = final: prev: { + emacsPackagesFor = emacs: + (prev.emacsPackagesFor emacs).overrideScope' + (inputs.self.overlays.emacs final prev); + }; + + emacs = final: prev: efinal: eprev: { + "${pname}" = inputs.self.packages.${final.system}.${ename}; + }; + }; + + homeConfigurations = + builtins.listToAttrs + (builtins.map + (system: { + name = "${system}-example"; + value = inputs.home-manager.lib.homeManagerConfiguration { + pkgs = import inputs.nixpkgs { + inherit system; + overlays = [inputs.self.overlays.default]; + }; + + modules = [ + ./nix/home-manager-example.nix + { + # These attributes are simply required by home-manager. + home = { + homeDirectory = /tmp/${ename}-example; + stateVersion = "22.11"; + username = "${ename}-example-user"; + }; + } + ]; + }; + }) + inputs.flake-utils.lib.defaultSystems); + } + // inputs.flake-utils.lib.eachDefaultSystem (system: let + pkgs = import inputs.nixpkgs { + inherit system; + overlays = [(import ./nix/dependencies.nix)]; + }; + + emacsPath = package: "${package}/share/emacs/site-lisp/elpa/${package.pname}-${package.version}"; + + ## Read version in format: ;; Version: xx.yy + readVersion = fp: + builtins.elemAt + (builtins.match + ".*(;; Version: ([[:digit:]]+\.[[:digit:]]+(\.[[:digit:]]+)?)).*" + (builtins.readFile fp)) + 1; + + src = pkgs.lib.cleanSource ./.; + + ## We need to tell Eldev where to find its Emacs package. + ELDEV_LOCAL = emacsPath pkgs.emacsPackages.eldev; + in { + packages = { + default = inputs.self.packages.${system}.${ename}; + + "${ename}" = + inputs.bash-strict-mode.lib.checkedDrv pkgs + (pkgs.emacsPackages.trivialBuild { + inherit ELDEV_LOCAL pname src; + + version = readVersion ./${pname}.el; + + nativeBuildInputs = [ + (pkgs.emacsWithPackages (epkgs: [epkgs.buttercup])) + # Emacs-lisp build tool, https://doublep.github.io/eldev/ + pkgs.emacsPackages.eldev + ]; + + doCheck = true; + + checkPhase = '' + runHook preCheck + ## TODO: Currently needed to make a temp file in + ## `eldev--create-internal-pseudoarchive-descriptor`. + export HOME="$PWD/fake-home" + mkdir -p "$HOME" + eldev test + runHook postCheck + ''; + + doInstallCheck = true; + + installCheckPhase = '' + runHook preInstallCheck + eldev --packaged test + runHook postInstallCheck + ''; + }); + }; + + devShells.default = + ## TODO: Use `inputs.bash-strict-mode.lib.checkedDrv` here after + ## NixOS/nixpkgs#204606 makes it into a release. + inputs.bash-strict-mode.lib.drv pkgs + (pkgs.mkShell { + inputsFrom = + builtins.attrValues inputs.self.checks.${system} + ++ builtins.attrValues inputs.self.packages.${system}; + + nativeBuildInputs = [ + # Nix language server, + # https://github.com/oxalica/nil#readme + pkgs.nil + # Bash language server, + # https://github.com/bash-lsp/bash-language-server#readme + pkgs.nodePackages.bash-language-server + ]; + }); + + checks = { + doctor = + inputs.bash-strict-mode.lib.checkedDrv pkgs + (pkgs.stdenv.mkDerivation { + inherit ELDEV_LOCAL src; + + name = "eldev-doctor"; + + nativeBuildInputs = [ + pkgs.emacs + # Emacs-lisp build tool, https://doublep.github.io/eldev/ + pkgs.emacsPackages.eldev + ]; + + buildPhase = '' + runHook preBuild + eldev doctor + runHook postBuild + ''; + + installPhase = '' + runHook preInstall + mkdir -p "$out" + runHook postInstall + ''; + }); + + lint = + ## TODO: Can’t currently use `inputs.bash-strict-mode.lib.checkedDrv` + ## because the `emacs` wrapper script checks for existence of a + ## variable with `-n` intead of `-v`. + inputs.bash-strict-mode.lib.shellchecked pkgs + (pkgs.stdenv.mkDerivation { + inherit ELDEV_LOCAL src; + + name = "eldev-lint"; + + nativeBuildInputs = [ + pkgs.emacs + pkgs.emacsPackages.eldev + ]; + + postPatch = '' + { + echo + echo "(mapcar" + echo " 'eldev-use-local-dependency" + echo " '(\"${emacsPath pkgs.emacsPackages.dash}\"" + echo " \"${emacsPath pkgs.emacsPackages.elisp-lint}\"" + echo " \"${emacsPath pkgs.emacsPackages.package-lint}\"" + echo " \"${emacsPath pkgs.emacsPackages.relint}\"" + echo " \"${emacsPath pkgs.emacsPackages.xr}\"))" + } >> Eldev + ''; + + buildPhase = '' + runHook preBuild + ## TODO: Currently needed to make a temp file in + ## `eldev--create-internal-pseudoarchive-descriptor`. + export HOME="$PWD/fake-home" + mkdir -p "$HOME" + ## Need `--external` here so that we don’t try to download any + ## package archives (which would break the sandbox). + eldev --external lint + runHook postBuild + ''; + + installPhase = '' + runHook preInstall + mkdir -p "$out" + runHook preInstall + ''; + }); + + nix-fmt = + inputs.bash-strict-mode.lib.checkedDrv pkgs + (pkgs.stdenv.mkDerivation { + inherit src; + + name = "nix fmt"; + + nativeBuildInputs = [inputs.self.formatter.${system}]; + + buildPhase = '' + runHook preBuild + alejandra --check . + runHook postBuild + ''; + + installPhase = '' + runHook preInstall + mkdir -p "$out" + runHook preInstall + ''; + }); + }; + + # Nix code formatter, https://github.com/kamadorueda/alejandra#readme + formatter = pkgs.alejandra; + }); + + inputs = { + bash-strict-mode = { + inputs.nixpkgs.follows = "nixpkgs"; + url = "github:sellout/bash-strict-mode"; + }; + + flake-utils.url = "github:numtide/flake-utils"; + + home-manager = { + inputs.nixpkgs.follows = "nixpkgs"; + url = "github:nix-community/home-manager/release-22.11"; + }; + + nixpkgs.url = "github:NixOS/nixpkgs/release-22.11"; + }; +} diff --git a/nix/dependencies.nix b/nix/dependencies.nix new file mode 100644 index 0000000..9c3e435 --- /dev/null +++ b/nix/dependencies.nix @@ -0,0 +1,12 @@ +final: prev: { + emacsPackagesFor = emacs: + (prev.emacsPackagesFor emacs).overrideScope' (efinal: eprev: { + # The `eldev` package doesn’t expose the executable. + eldev = eprev.eldev.overrideAttrs (old: { + postInstall = '' + mkdir -p "$out" + cp -R "$src/bin" "$out/" + ''; + }); + }); +} From 2d0fd914132ce8a7322955aced21a97864a0903b Mon Sep 17 00:00:00 2001 From: Greg Pfeil Date: Thu, 1 Jun 2023 13:38:21 -0600 Subject: [PATCH 02/11] Minimal changes for the build to succeed The Nix checks do not yet succeed, but this makes it possible to create the Emacs package. --- elisp-reader.el | 4 ++++ tmp.el | 3 +++ 2 files changed, 7 insertions(+) diff --git a/elisp-reader.el b/elisp-reader.el index f68656f..1952107 100644 --- a/elisp-reader.el +++ b/elisp-reader.el @@ -5,6 +5,7 @@ ;; Author: Mihai Bazon ;; Keywords: languages +;; Version: 0.1.0 ;; This program is free software; you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by @@ -126,6 +127,8 @@ ;;; Code: +(require 'cl-lib) + (defvar *er-orig-read* (symbol-function #'read) "Remember the original `read' function, because we'll have to use it in some situations that can't be handled from Lisp code.") @@ -648,3 +651,4 @@ during byte compilation." (setq load-read-function (symbol-function 'er-read))) (provide 'elisp-reader) +;;; elisp-reader.el ends here diff --git a/tmp.el b/tmp.el index ace6cdf..c6c5972 100644 --- a/tmp.el +++ b/tmp.el @@ -1,3 +1,6 @@ +(require 'cl-lib) +(require 'elisp-reader) + (defun er-test (buffer) (with-current-buffer buffer (save-excursion From 3ea3efcf7f91cef826d258f0fb3877dbaa9269e8 Mon Sep 17 00:00:00 2001 From: Greg Pfeil Date: Thu, 1 Jun 2023 16:19:22 -0600 Subject: [PATCH 03/11] Fix linter complaints This is an attempt to be as minimal as possible in the edits, but there is certainly room for discussion. E.g.,. creation & rephrasing of various docstrings, renaming of symbols, etc. --- .dir-locals.el | 2 + Eldev | 11 +- elisp-reader.el | 672 +++++++++++++++++++++++++----------------------- flake.nix | 7 + tmp.el | 41 ++- 5 files changed, 391 insertions(+), 342 deletions(-) diff --git a/.dir-locals.el b/.dir-locals.el index 32563be..dcd1abb 100644 --- a/.dir-locals.el +++ b/.dir-locals.el @@ -1,3 +1,5 @@ +;; TODO: We have to be careful what variables we set here. Some can cause the +;; Eldev linters to not read the settings here. See emacs-eldev/eldev#83. ((nil (fill-column . 80) (indent-tabs-mode . nil) diff --git a/Eldev b/Eldev index a04d582..154bdab 100644 --- a/Eldev +++ b/Eldev @@ -5,6 +5,11 @@ (setq ;; run all linters by default eldev-lint-default t - ;; except ‘package-lint’, because it’s also run within ‘elisp-lint’ (see - ;; ‘eldev-linter-elisp’) - eldev-lint-default-excluded '(package-lint)) + ;; and disable the ‘elisp-lint’ validators that are already covered by + ;; ‘eldev-lint’ (see ‘eldev-linter-elisp’). + elisp-lint-ignored-validators '("checkdoc" "package-lint")) + +;; Allow `read-symbol-shorthands` to work (see purcell/package-lint#238). +(eval-after-load 'package-lint + '(add-to-list 'package-lint--allowed-prefix-mappings + '("elisp-reader" . ("er")))) diff --git a/elisp-reader.el b/elisp-reader.el index 1952107..87063e5 100644 --- a/elisp-reader.el +++ b/elisp-reader.el @@ -1,10 +1,15 @@ -;;; -*- lexical-binding: t -*- -;;; elisp-reader.el --- A customizable Lisp reader for Emacs +;;; elisp-reader.el --- A customizable Lisp reader -*- lexical-binding: t -*- + +;; Local Variables: +;; read-symbol-shorthands: (("er-" . "elisp-reader-")) +;; End: ;; Copyright (C) 2016 Mihai Bazon ;; Author: Mihai Bazon ;; Keywords: languages +;; Package-Requires: ((emacs "24.3")) +;; URL: https://github.com/mishoo/elisp-reader.el ;; Version: 0.1.0 ;; This program is free software; you can redistribute it and/or modify @@ -33,7 +38,7 @@ ;; It works nicely, if a bit slow. To make it much faster you should ;; byte-compile this file: ;; -;; emacs --batch --eval '(byte-compile-file "elisp-reader.el")' +;; "emacs --batch --eval '(byte-compile-file "elisp-reader.el")'" ;; ;; After loading this file, everything you eval with C-M-x in an Emacs ;; Lisp buffer, or via M-: or via M-x `eval-region' or in the REPL, @@ -71,11 +76,11 @@ ;; Example of defining custom syntax (note this function uses ;; `er-read-list', which see, to get a list of Lisp datums): ;; -;; (def-reader-syntax ?{ -;; (lambda (in ch) -;; (let ((list (er-read-list in ?} t))) -;; `(list ,@(cl-loop for (key val) on list by #'cddr -;; collect `(cons ,key ,val)))))) +;; (er-def-syntax ?{ +;; (lambda (in ch) +;; (let ((list (er-read-list in ?} t))) +;; `(list ,@(cl-loop for (key val) on list by #'cddr +;; collect `(cons ,key ,val)))))) ;; ;; and now you can type into the REPL: ;; @@ -99,10 +104,10 @@ ;; FILE-LOCAL SYMBOLS ;; ------------------ ;; -;; A `local' macro is provided which allows you to declare a list of +;; An `er-local' macro is provided which allows you to declare a list of ;; names to be kept "internal" to the current file. Example: ;; -;; (local "my-package" ("foo" "bar")) +;; (er-local "my-package" ("foo" "bar")) ;; ;; After this declaration, you can use freely foo and bar in the ;; current file: @@ -112,11 +117,11 @@ ;; ;; In other files, or in the REPL, they are accessible as ;; my-package-foo and my-package-bar. But if you place the same -;; `local' declaration in another file, they'd be auto-prefixed as +;; `er-local' declaration in another file, they'd be auto-prefixed as ;; well so you can refer to them just as foo and bar. This is a poor ;; man's package system. ;; -;; See the docstring of `local' for more information. +;; See the docstring of `er-local' for more information. ;; ;; Another idea I was thinking about (did not do it but it's trivial) ;; is to support some special character, say $ — if some symbol is @@ -129,30 +134,29 @@ (require 'cl-lib) -(defvar *er-orig-read* (symbol-function #'read) - "Remember the original `read' function, because we'll have to -use it in some situations that can't be handled from Lisp code.") +(defvar er-*orig-read* (symbol-function #'read) + "Remember the original `read' function. +We'll have to use it in some situations that can't be handled from Lisp code.") -(defvar *er-macro-chars* (make-hash-table :test 'eq) - "Custom read functions. A hash that maps character to a -function of two arguments, stream (as a function) and character. -This function should return the AST that has been read. See -usage of `def-reader-syntax' later on.") +(defvar er-*macro-chars* (make-hash-table :test 'eq) + "Custom read functions. +A hash that maps character to a function of two arguments, stream (as a +function) and character. This function should return the AST that has been +read. See usage of `er-def-syntax' later on.") -(defvar *er-read-filename* nil - "This dynamic variable will be bound by our read functions -while parsing is in progress. It'll contain the value of -`load-file-name', or the name of the current buffer if it doesn't -have an associated file.") +(defvar er-*read-filename* nil + "The name of the file (or buffer) currently being parsed. +This dynamic variable will be bound by our read functions while parsing is in +progress. It'll contain the value of `load-file-name', or the name of the +current buffer if it doesn't have an associated file.") (defun er-make-stream (in) - "Given an input stream (which can be a buffer, a marker, a -string, a function, or t or nil--see Elisp docs) this returns the -stream as a function of one optional argument. When called with -no arguments, this function should return the next character from -the stream. When called with a non-nil argument (character), -this function should arrange that character to be returned on -next invokation with no arguments. + "Return the input stream IN as a function of one optional argument. +IN can be a buffer, a marker, a string, a function, or t or nil--see Elisp docs. +When called with no arguments, this function should return the next character +from the stream. When called with a non-nil argument (character), this function +should arrange that character to be returned on next invokation with no +arguments. The Elisp docs aren't entirely clear about this, but the closures returned by this function will be able to push back multiple @@ -171,68 +175,65 @@ the position of the stream." (when (symbolp in) (setq in (symbol-function in))) (cond - ((bufferp in) (lambda (&optional ch) - (with-current-buffer in - (cond - (ch (push ch unget)) - (unget (pop unget)) - (t - (when (not (eobp)) - (prog1 (char-after) - (forward-char 1)))))))) - ((markerp in) (lambda (&optional ch) - (with-current-buffer (marker-buffer in) - (cond - (ch (push ch unget)) - (unget (pop unget)) - (t - (when (< (marker-position in) (point-max)) - (prog1 (char-after in) - (move-marker in - (1+ (marker-position in)) - (marker-buffer in))))))))) - ((stringp in) (let ((pos 0)) - (lambda (&optional ch) - (cond - ((eq ch :pos) - (if (< pos (length in)) - (- pos 1) - pos)) - (ch (push ch unget)) - (unget (pop unget)) - ((< pos (length in)) - (prog1 (aref in pos) - (setq pos (1+ pos)))))))) - ((functionp in) (lambda (&optional ch) - (cond - (ch (push ch unget)) - (unget (pop unget)) - (t (funcall in))))) - (t - (read-string "Lisp expression:"))))) + ((bufferp in) (lambda (&optional ch) + (with-current-buffer in + (cond + (ch (push ch unget)) + (unget (pop unget)) + (t + (when (not (eobp)) + (prog1 (char-after) + (forward-char 1)))))))) + ((markerp in) (lambda (&optional ch) + (with-current-buffer (marker-buffer in) + (cond + (ch (push ch unget)) + (unget (pop unget)) + (t + (when (< (marker-position in) (point-max)) + (prog1 (char-after in) + (move-marker in + (1+ (marker-position in)) + (marker-buffer in))))))))) + ((stringp in) (let ((pos 0)) + (lambda (&optional ch) + (cond + ((eq ch :pos) + (if (< pos (length in)) + (- pos 1) + pos)) + (ch (push ch unget)) + (unget (pop unget)) + ((< pos (length in)) + (prog1 (aref in pos) + (setq pos (1+ pos)))))))) + ((functionp in) (lambda (&optional ch) + (cond + (ch (push ch unget)) + (unget (pop unget)) + (t (funcall in))))) + (t + (read-string "Lisp expression:"))))) (defun er-orig-read () - "Calls the original (low-level C) `read'. This function should -be invoked only within the dynamic extent of some `read' or + "Call the original (low-level C) `read'. +This function should be invoked only within the dynamic extent of some `read' or `read-from-string' execution." - (funcall *er-orig-read* '%er-reader-insym)) + (funcall er-*orig-read* '%er-reader-insym)) (defun er-peek (in) - "Given a stream function, return the next character without -dropping it from the stream." + "Return the next character without dropping it from the IN stream." (let ((ch (funcall in))) (funcall in ch) ch)) (defun er-next (in) - "Given a stream function, return and discard the next -character." + "Return and discard the next character from the IN stream function." (funcall in)) (defun er-read-while (in pred) - "Read and return a string from the input stream, as long as the -predicate--which will be called for each character--returns -true." + "Read characters from the input stream, IN, until PRED is nil. +Return a string containing the read characters." (let ((chars (list)) ch) (while (and (setq ch (er-peek in)) (funcall pred ch)) @@ -240,207 +241,212 @@ true." (apply #'string (nreverse chars)))) (defun er-croak (msg &rest args) - "Error out in case of parse error." + "Error with message MSG applied to ARGS in case of parse error." (if args (apply #'error msg args) (error "%s" msg))) (defun er-read-string () - "Read a string from the current stream. It defers to -`er-orig-read' and thus this should only be called within the + "Read a string from the current stream. +It defers to `er-orig-read' and thus this should only be called within the dynamic extent of some `read' function." (er-orig-read)) (defun er-read-char () - "Read a character from the current stream. It defers to -`er-orig-read' and thus this should only be called within the + "Read a character from the current stream. +It defers to `er-orig-read' and thus this should only be called within the dynamic extent of some `read' function." (er-orig-read)) (defun er-letter? (ch) - "Tests whether the given character is a Unicode letter." + "Test whether the given character, CH, is a Unicode letter." (memq (get-char-code-property ch 'general-category) '(Ll Lu Lo Lt Lm Mn Mc Me Nl))) (defun er-whitespace? (ch) - "Tests if the given character is whitespace (XXX actually not -all Unicode whitespace chars are handled; I'm not even sure that -would be correct)." + "Test if the given character, CH, is whitespace. +\(XXX actually not all Unicode whitespace chars are handled; I'm not even sure +that would be correct)." (memq ch '(? ?\t ?\n ?\f ?\r #xa0))) (defun er-digit? (ch) - "Tests if the given character is a plain digit." + "Test if the given character, CH, is a plain digit." (<= ?0 ch ?9)) (defun er-number? (str) - "Tests if the given string should be interpreted as number." - (string-match "^[-+]?\\(?:\\(?:[0-9]+\\|[0-9]*\\.[0-9]+\\)\\(?:[E|e][+|-]?[0-9]+\\)?\\)$" str)) + "Test if the given string, STR, should be interpreted as number." + (string-match + "^[-+]?\\(?:\\(?:[0-9]+\\|[0-9]*\\.[0-9]+\\)\\(?:[E|e][+|-]?[0-9]+\\)?\\)$" + str)) (defun er-skip-whitespace (in) - "Skip whitespace in the given stream." + "Skip whitespace in the IN stream." (er-read-while in #'er-whitespace?)) (defun er-read-symbol-name (in) - "Read and return the name of a symbol." + "Read and return the name of a symbol from the stream IN." (er-read-while in (lambda (ch) (cond - ((eq ch ?\\) - (er-next in) - (if (er-peek in) t (er-croak "Unterminated input"))) - (t - (or (er-letter? ch) - (er-digit? ch) - (memq ch '(?- ?+ ?= ?* ?/ ?_ ?~ ?! ?@ ?. ?\| + ((eq ch ?\\) + (er-next in) + (if (er-peek in) t (er-croak "Unterminated input"))) + (t + (or (er-letter? ch) + (er-digit? ch) + (memq ch '( ?- ?+ ?= ?* ?/ ?_ ?~ ?! ?@ ?. ?\| ?$ ?% ?^ ?& ?: ?< ?> ?{ ?} ?\?)))))))) (defun er-read-integer (in) - "Read and return an integer (NIL if there is no integer at -current position in stream)." + "Read and return an integer. +\(NIL if there is no integer at current position in the IN stream)." (let ((num (er-read-while in #'er-digit?))) (when (< 0 (length num)) (string-to-number num)))) (defun er-skip-comment (in) - "Skip over a comment (move to end-of-line)." + "Skip over a comment (move to end-of-line) in the IN stream." (er-read-while in (lambda (ch) (not (eq ch ?\n))))) (defun er-read-symbol (in) - "Reads a symbol or a number. If what follows in the stream -looks like a number, a number will be returned (via the original -reader). If a symbol, it might be auto-prefixed if declared -`local' in the current file." + "Read a symbol or a number. +If what follows in the stream IN looks like a number, a number will be +returned (via the original reader). If a symbol, it might be auto-prefixed if +declared `er-local' in the current file." (let ((name (er-read-symbol-name in))) (cond - ((er-number? name) - (funcall *er-orig-read* name)) - ((zerop (length name)) - '##) - (t - (intern (er-maybe-prefixed name)))))) + ((er-number? name) + (funcall er-*orig-read* name)) + ((zerop (length name)) + '##) + (t + (intern (er-maybe-prefixed name)))))) -(defvar *er-prefixed-symbols* (make-hash-table :test #'equal)) +(defvar er-*prefixed-symbols* (make-hash-table :test #'equal)) (defun er-maybe-prefixed (name &optional filename) + "Add a prefix to NAME if it is intended to be local to FILENAME." (unless filename (setq filename (er-get-filename))) - (let* ((f (gethash filename *er-prefixed-symbols*)) + (let* ((f (gethash filename er-*prefixed-symbols*)) prefix) (cond - ((not f) - ;; nothing special with this file, return unchanged name - name) - ((and (setq prefix (gethash name f)) - (zerop (length prefix))) - ;; if defined but empty prefix for this name, this is actually - ;; an "exported" symbol -- leave as is. - name) - (prefix - ;; if we have a prefix, join it with a dash - (format "%s-%s" prefix name)) - ((intern-soft name) - ;; no prefix found and the symbol is already interned, so leave - ;; as is. - name) - ((setq prefix (gethash "" f)) - ;; "global" prefix registered for this file, and the symbol is - ;; uninterned -- let's join them - (format "%s-%s" prefix name)) - (t - ;; when none of the above, leave the name as is - name)))) + ((not f) + ;; nothing special with this file, return unchanged name + name) + ((and (setq prefix (gethash name f)) + (zerop (length prefix))) + ;; if defined but empty prefix for this name, this is actually + ;; an "exported" symbol -- leave as is. + name) + (prefix + ;; if we have a prefix, join it with a dash + (format "%s-%s" prefix name)) + ((intern-soft name) + ;; no prefix found and the symbol is already interned, so leave + ;; as is. + name) + ((setq prefix (gethash "" f)) + ;; "global" prefix registered for this file, and the symbol is + ;; uninterned -- let's join them + (format "%s-%s" prefix name)) + (t + ;; when none of the above, leave the name as is + name)))) (defun er-make-prefixed (name &optional prefix filename) + "Register NAME as a symbol that should have the prefix PREFIX in FILENAME." (unless filename (setq filename (er-get-filename))) (unless prefix (setq prefix filename)) - (let ((f (gethash filename *er-prefixed-symbols*))) + (let ((f (gethash filename er-*prefixed-symbols*))) (unless f (setq f (make-hash-table :test #'equal)) - (puthash filename f *er-prefixed-symbols*)) + (puthash filename f er-*prefixed-symbols*)) (puthash name prefix f) nil)) (defun er-read-list (in end &optional no-dot) - "Read a list of elements from the input stream, until the end -character has been observed. If `no-dot' is nil then it will -support a dot character before the last element, producing an -\"improper\" list. If `no-dot' is true, then if a single dot -character is encountered this will produce an error." + "Read a list of elements from the input stream IN. +This reads until the END character has been observed. If NO-DOT is nil then +it will support a dot character before the last element, producing an +\"improper\" list. If NO-DOT is true, then if a single dot character is +encountered this will produce an error." (let ((ret nil) (p nil) ch) (catch 'exit (while t (er-skip-whitespace in) (setq ch (er-peek in)) (cond - ((not ch) - (er-croak "Unterminated list")) - ((eq ch end) - (er-next in) - (throw 'exit ret)) - ((eq ch ?\;) - (er-skip-comment in)) - (t - (let ((x (er-read-datum in))) - (cond - ((eq x '\.) - (cond - (no-dot (er-croak "Dot in wrong context")) - (t - (rplacd p (er-read-datum in)) - (er-skip-whitespace in) - (setq ch (er-next in)) - (unless (eq ch end) - (er-croak "Dot in wrong context")) - (throw 'exit ret)))) + ((not ch) + (er-croak "Unterminated list")) + ((eq ch end) + (er-next in) + (throw 'exit ret)) + ((eq ch ?\;) + (er-skip-comment in)) + (t + (let ((x (er-read-datum in))) + (cond + ((eq x '\.) + (cond + (no-dot (er-croak "Dot in wrong context")) (t - (let ((cell (cons x nil))) - (setq p (if ret - (rplacd p cell) - (setq ret cell))))))))))))) + (rplacd p (er-read-datum in)) + (er-skip-whitespace in) + (setq ch (er-next in)) + (unless (eq ch end) + (er-croak "Dot in wrong context")) + (throw 'exit ret)))) + (t + (let ((cell (cons x nil))) + (setq p (if ret + (rplacd p cell) + (setq ret cell))))))))))))) (defun er-read-datum (in) - "Read and return a Lisp datum from the input stream." + "Read and return a Lisp datum from the stream IN." (er-skip-whitespace in) (let ((ch (er-peek in)) macrochar) (cond - ((not ch) - (er-croak "End of file during parsing")) - ((eq ch ?\;) - (er-skip-comment in) - (er-read-datum in)) - ((eq ch ?\") - (er-read-string)) - ((eq ch ?\?) - (er-read-char)) - ((eq ch ?\() - (er-next in) - (er-read-list in ?\))) - ((eq ch ?\[) - (er-next in) - (apply #'vector (er-read-list in ?\] t))) - ((eq ch ?\') - (er-next in) - (list 'quote (er-read-datum in))) - ((eq ch ?\`) - (er-next in) - (list '\` (er-read-datum in))) - ((eq ch ?\,) - (er-next in) - (cond - ((eq (er-peek in) ?\@) - (er-next in) - (list '\,@ (er-read-datum in))) - (t - (list '\, (er-read-datum in))))) - ((setq macrochar (gethash ch *er-macro-chars*)) - (er-next in) - (funcall macrochar in ch)) - (t - (er-read-symbol in))))) - -(defvar *er-substitutions*) + ((not ch) + (er-croak "End of file during parsing")) + ((eq ch ?\;) + (er-skip-comment in) + (er-read-datum in)) + ((eq ch ?\") + (er-read-string)) + ((eq ch ?\?) + (er-read-char)) + ((eq ch ?\() + (er-next in) + (er-read-list in ?\))) + ((eq ch ?\[) + (er-next in) + (apply #'vector (er-read-list in ?\] t))) + ((eq ch ?\') + (er-next in) + (list 'quote (er-read-datum in))) + ((eq ch ?\`) + (er-next in) + (list '\` (er-read-datum in))) + ((eq ch ?\,) + (er-next in) + (cond + ((eq (er-peek in) ?\@) + (er-next in) + (list '\,@ (er-read-datum in))) + (t + (list '\, (er-read-datum in))))) + ((setq macrochar (gethash ch er-*macro-chars*)) + (er-next in) + (funcall macrochar in ch)) + (t + (er-read-symbol in))))) + +(defvar er-*substitutions*) (defun er-read-internal (in) - ;; HACK: calling the original reader with (funcall *er-orig-read* + "Read a Lisp expression from the input stream IN." + ;; HACK: calling the original reader with (funcall er-*orig-read* ;; in) will not work. After digging the C code (lread.c) my ;; conclusion is that `read' does not support a (uncompiled) lambda ;; expression as input stream. This contradicts the documentation @@ -454,14 +460,17 @@ character is encountered this will produce an error." ;; [2] http://git.savannah.gnu.org/cgit/emacs.git/commit/?id=711ca36 (fset '%er-reader-insym in) (unwind-protect - (let ((*er-substitutions* (list))) - (er-read-datum in)) + (let ((er-*substitutions* (list))) + (er-read-datum in)) (fset '%er-reader-insym nil))) -(defun def-reader-syntax (ch reader) - (puthash ch reader *er-macro-chars*)) +(defun er-def-syntax (ch reader) + "Assign a READER function to execute when the character CH is encountered." + (puthash ch reader er-*macro-chars*)) (defun er-index (elt lst) + "Return the index of ELT in LST. +Returns nil if ELT isn’t in LST." (let ((index 0)) (catch 'exit (while lst @@ -471,8 +480,10 @@ character is encountered this will produce an error." (setq lst (cdr lst))))))) (defun er-substitute (orig cell) - (cl-labels ((subst-in (thing) - (cond + "Replace occurrences of CELL in ORIG with ORIG." + (cl-labels + ((subst-in (thing) + (cond ((eq thing cell) orig) ((consp thing) @@ -485,127 +496,136 @@ character is encountered this will produce an error." thing) (t thing))) - (subst-in-list (lst) - (rplaca lst (subst-in (car lst))) - (rplacd lst (subst-in (cdr lst)))) - (subst-in-array (array) - (cl-loop for el across array - for i upfrom 0 - do (aset array i (subst-in el))))) + (subst-in-list (lst) + (rplaca lst (subst-in (car lst))) + (rplacd lst (subst-in (cdr lst)))) + (subst-in-array (array) + (cl-loop for el across array + for i upfrom 0 + do (aset array i (subst-in el))))) (subst-in orig))) -(defconst *er-all-digits* '(?0 ?1 ?2 ?3 ?4 ?5 ?6 ?7 ?8 ?9 - ?a ?b ?c ?d ?e ?f ?g ?h ?i ?j - ?k ?l ?m ?n ?o ?p ?q ?r ?s ?t - ?u ?v ?w ?x ?y ?z)) - -(def-reader-syntax ?# - (lambda (in ch) - (let ((x (funcall in))) - (cond - ((er-digit? x) - (funcall in x) - (let ((num (er-read-integer in))) - (setq x (er-peek in)) - (cond - ((and read-circle (eq x ?=)) - ;; #1=... - (er-next in) - (let* ((placeholder (cons nil nil)) - (cell (cons num placeholder))) - (setq *er-substitutions* (cons cell *er-substitutions*)) - (let ((tok (er-read-datum in))) - (er-substitute tok placeholder) - (rplacd cell tok)))) - - ((and read-circle (eq x ?#)) - ;; #1# - (er-next in) - (let ((x (assq num *er-substitutions*))) - (if (consp x) - (cdr x) - (er-croak "Cannot find substitution for #%d#" num)))) - - ((and (<= num 36) - (or (eq x ?r) (eq x ?R))) - ;; #16rFF - (er-next in) - (let* ((base num) - (digits (cl-subseq *er-all-digits* 0 base)) - (num 0) - (negative? (cond ((eq ?- (er-peek in)) - (er-next in) - t) - ((eq ?+ (er-peek in)) - (er-next in) - nil)))) - (er-read-while in (lambda (ch) - (let ((v (er-index (downcase ch) digits))) - (when v - (setq num (+ v (* num base))))))) - (if negative? (- num) num))) - - (t (er-croak "Unsupported #%d%c syntax" num x))))) - - ((memq x '(?s ?^ ?& ?\[ ?\( ?@ ?! ?$ ?: ?# - ?x ?X ?o ?O ?b ?B)) - ;; let the original reader to deal with these. - (funcall in x) - (funcall in ch) - (er-orig-read)) - - ((eq x ?\') - (list 'function (er-read-datum in))) - - ((eq x ?\/) - (er-read-regexp in)) - - (t - (er-croak "Unsupported #%c syntax" x)))))) +(defconst er-*all-digits* '( ?0 ?1 ?2 ?3 ?4 ?5 ?6 ?7 ?8 ?9 + ?a ?b ?c ?d ?e ?f ?g ?h ?i ?j + ?k ?l ?m ?n ?o ?p ?q ?r ?s ?t + ?u ?v ?w ?x ?y ?z)) + +(er-def-syntax ?# + (lambda (in ch) + (let ((x (funcall in))) + (cond + ((er-digit? x) + (funcall in x) + (let ((num (er-read-integer in))) + (setq x (er-peek in)) + (cond + ((and read-circle (eq x ?=)) + ;; #1=... + (er-next in) + (let* ((placeholder (cons nil nil)) + (cell (cons num placeholder))) + (setq er-*substitutions* + (cons cell er-*substitutions*)) + (let ((tok (er-read-datum in))) + (er-substitute tok placeholder) + (rplacd cell tok)))) + + ((and read-circle (eq x ?#)) + ;; #1# + (er-next in) + (let ((x (assq num er-*substitutions*))) + (if (consp x) + (cdr x) + (er-croak "Cannot find substitution for #%d#" + num)))) + + ((and (<= num 36) + (or (eq x ?r) (eq x ?R))) + ;; #16rFF + (er-next in) + (let* ((base num) + (digits (cl-subseq er-*all-digits* 0 base)) + (num 0) + (negative? (cond ((eq ?- (er-peek in)) + (er-next in) + t) + ((eq ?+ (er-peek in)) + (er-next in) + nil)))) + (er-read-while in + (lambda (ch) + (let ((v (er-index (downcase ch) + digits))) + (when v + (setq num + (+ v (* num base))))))) + (if negative? (- num) num))) + + (t (er-croak "Unsupported #%d%c syntax" num x))))) + + ((memq x '( ?s ?^ ?& ?\[ ?\( ?@ ?! ?$ ?: ?# + ?x ?X ?o ?O ?b ?B)) + ;; let the original reader to deal with these. + (funcall in x) + (funcall in ch) + (er-orig-read)) + + ((eq x ?\') + (list 'function (er-read-datum in))) + + ((eq x ?\/) + (er-read-regexp in)) + + (t + (er-croak "Unsupported #%c syntax" x)))))) (defun er-read-regexp (in) + "Read a regular expression from the input stream IN." (let ((ret (list))) (catch 'exit (while t (let ((ch (funcall in))) (cond - ((eq ch ?\\) - (let ((next (funcall in))) - (cond - ((memq next '(?\\ ?/ ?\) ?\( ?\| ?\{ ?\})) - (push next ret)) - ((eq next ?n) - (push ?\n ret)) - ((eq next ?f) - (push ?\f ret)) - ((eq next ?r) - (push ?\r ret)) - ((eq next ?t) - (push ?\t ret)) - (t - (when (memq next '(?\* ?\+ ?\. ?\? ?\[ ?\] ?\^ ?\$ ?\\)) - (push ?\\ ret)) - (funcall in next))))) - ((memq ch '(?\) ?\( ?\| ?\{ ?\})) - (push ?\\ ret) - (push ch ret)) - ((eq ch ?/) - (throw 'exit nil)) - ((not ch) - (er-croak "Unterminated regexp")) - (t - (push ch ret)))))) + ((eq ch ?\\) + (let ((next (funcall in))) + (cond + ((memq next '(?\\ ?/ ?\) ?\( ?\| ?\{ ?\})) + (push next ret)) + ((eq next ?n) + (push ?\n ret)) + ((eq next ?f) + (push ?\f ret)) + ((eq next ?r) + (push ?\r ret)) + ((eq next ?t) + (push ?\t ret)) + (t + (when (memq next '(?\* ?\+ ?\. ?\? ?\[ ?\] ?\^ ?\$ ?\\)) + (push ?\\ ret)) + (funcall in next))))) + ((memq ch '(?\) ?\( ?\| ?\{ ?\})) + (push ?\\ ret) + (push ch ret)) + ((eq ch ?/) + (throw 'exit nil)) + ((not ch) + (er-croak "Unterminated regexp")) + (t + (push ch ret)))))) (apply #'string (nreverse ret)))) (defun er-read (&optional in) + "Read a Lisp expression from the input stream IN." (if (and load-file-name (string-match "\\.elc$" load-file-name)) - (funcall *er-orig-read* in) - (let ((*er-read-filename* (er-get-filename))) + (funcall er-*orig-read* in) + (let ((er-*read-filename* (er-get-filename))) (er-read-internal (er-make-stream in))))) (defun er-read-from-string (str &optional start end) - (let ((*er-read-filename* (er-get-filename))) + "Read a Lisp expression from the string STR. +Reading starts from position START and stops at END." + (let ((er-*read-filename* (er-get-filename))) (let* ((stream (er-make-stream (substring-no-properties str start end))) (token (er-read-internal stream))) @@ -613,19 +633,20 @@ character is encountered this will produce an error." (funcall stream :pos)))))) (defun er-get-filename () - (or *er-read-filename* + "Return the filename referring to the current context." + (or er-*read-filename* load-file-name (and (boundp 'byte-compile-current-file) byte-compile-current-file) (and (boundp 'byte-compile-dest-file) byte-compile-dest-file) (buffer-file-name (current-buffer)) (buffer-name (current-buffer)))) -(defmacro local (prefix &optional names) - "Declare that the given names (list of strings) should be -auto-prefixed with the given prefix (symbol, string or nil). +(defmacro er-local (prefix &optional names) + "Declare that the given NAMES (list of strings) should be auto-prefixed. +The given PREFIX can be a symbol, string or nil. This makes it possible to write: - (local \"my-library-name\" (\"foo\" \"bar\")) + (er-local \"my-library-name\" (\"foo\" \"bar\")) (defun foo (...) ...) (defun bar (...) ...) @@ -640,8 +661,9 @@ without a prefix, the full file name is recorded in the elc file during byte compilation." (unless names (setq names '(""))) `(eval-when-compile - ,@(mapcar (lambda (name) - `(er-make-prefixed ,name ,prefix)) names))) + ,@(mapcar (lambda (name) + `(er-make-prefixed ,name ,prefix)) + names))) ;; install in a prog, so they're read all at once with the original ;; reader diff --git a/flake.nix b/flake.nix index 3457f52..58fb0f0 100644 --- a/flake.nix +++ b/flake.nix @@ -186,6 +186,13 @@ echo " \"${emacsPath pkgs.emacsPackages.package-lint}\"" echo " \"${emacsPath pkgs.emacsPackages.relint}\"" echo " \"${emacsPath pkgs.emacsPackages.xr}\"))" + ## TODO: Remove this once purcell/package-lint#238 is fixed. + ## For now, it should be a reversed version of the values + ## of `read-symbol-shorthands` in the various .el files. + echo "(require 'package-lint" + echo " \"${emacsPath pkgs.emacsPackages.package-lint}/package-lint.el\")" + echo "(add-to-list 'package-lint--allowed-prefix-mappings" + echo " '(\"elisp-reader\" . (\"er\")))" } >> Eldev ''; diff --git a/tmp.el b/tmp.el index c6c5972..60ce133 100644 --- a/tmp.el +++ b/tmp.el @@ -1,22 +1,35 @@ +;;; tmp.el --- testing elisp-reader -*- lexical-binding: t; -*- + +;; Local Variables: +;; read-symbol-shorthands: (("er-" . "elisp-reader-")) +;; End: + +;;; Commentary: + +;;; Code: + (require 'cl-lib) (require 'elisp-reader) (defun er-test (buffer) + "Check for diffs between reading BUFFER with elisp-reader and the original." (with-current-buffer buffer (save-excursion - (while (not (eobp)) - (skip-chars-forward " \t\n\r\f\xa0") - (message "At: %d" (point)) - (when (not (eobp)) - (let ((ours (ignore-errors (save-excursion (er-read buffer)))) - (orig (ignore-errors (funcall *er-orig-read* buffer)))) - (unless (equal ours orig) - (error "Found difference before %S\nOurs: %S\nShould be: %S" - (point) ours orig)))))))) + (while (not (eobp)) + (skip-chars-forward " \t\n\r\f\xa0") + (message "At: %d" (point)) + (when (not (eobp)) + (let ((ours (ignore-errors (save-excursion (er-read buffer)))) + (orig (ignore-errors (funcall er-*orig-read* buffer)))) + (unless (equal ours orig) + (error "Found difference before %S\nOurs: %S\nShould be: %S" + (point) ours orig)))))))) -(def-reader-syntax ?{ - (lambda (in ch) - (let ((list (er-read-list in ?} t))) - `(list ,@(cl-loop for (key val) on list by #'cddr - collect `(cons ,key ,val)))))) +(er-def-syntax ?{ + (lambda (in _ch) + (let ((list (er-read-list in ?} t))) + `(list ,@(cl-loop for (key val) on list by #'cddr + collect `(cons ,key ,val)))))) +(provide 'tmp) +;;; tmp.el ends here From 25bb4b7895d4136e2f9cdcd7896fb9dcc5738e31 Mon Sep 17 00:00:00 2001 From: Greg Pfeil Date: Thu, 30 Nov 2023 21:21:54 -0700 Subject: [PATCH 04/11] Adopt Project Manager and Nixpkgs 23.11 --- .cache/git/config | 7 + .cache/git/hooks/pre-push | 3 + .cache/vale/Vocab/elisp-reader/accept.txt | 6 + .config/emacs/.dir-locals.el | 6 + .config/mustache.yaml | 9 + .config/project/default.nix | 77 +++ .editorconfig | 29 +- .envrc | 2 + .gitattributes | 15 +- .github/renovate.json | 1 + .github/settings.yml | 2 + .github/workflows/flakehub-publish.yml | 27 + .gitignore | 16 +- .vale.ini | 15 + LICENSE | 674 ++++++++++++++++++++++ README.md | 8 +- flake.lock | 309 ++++++++-- flake.nix | 274 ++------- garnix.yaml | 2 + nix/dependencies.nix | 12 - 20 files changed, 1189 insertions(+), 305 deletions(-) create mode 100644 .cache/git/config create mode 100755 .cache/git/hooks/pre-push create mode 100644 .cache/vale/Vocab/elisp-reader/accept.txt create mode 100644 .config/emacs/.dir-locals.el create mode 100644 .config/mustache.yaml create mode 100644 .config/project/default.nix create mode 100644 .github/renovate.json create mode 100644 .github/settings.yml create mode 100644 .github/workflows/flakehub-publish.yml create mode 100644 .vale.ini create mode 100644 LICENSE create mode 100644 garnix.yaml delete mode 100644 nix/dependencies.nix diff --git a/.cache/git/config b/.cache/git/config new file mode 100644 index 0000000..7978e82 --- /dev/null +++ b/.cache/git/config @@ -0,0 +1,7 @@ +; This file was generated by Project Manager. +[commit "template"] + contents = "" + path = ".config/git/template/commit.txt" + +[core] + hooksPath = "../.cache/git/hooks" diff --git a/.cache/git/hooks/pre-push b/.cache/git/hooks/pre-push new file mode 100755 index 0000000..af29406 --- /dev/null +++ b/.cache/git/hooks/pre-push @@ -0,0 +1,3 @@ +#!/usr/bin/env bash + +nix flake check diff --git a/.cache/vale/Vocab/elisp-reader/accept.txt b/.cache/vale/Vocab/elisp-reader/accept.txt new file mode 100644 index 0000000..b0bbe0d --- /dev/null +++ b/.cache/vale/Vocab/elisp-reader/accept.txt @@ -0,0 +1,6 @@ +direnv +garnix +[Nn]ix +Pfeil +ShellCheck +Eldev diff --git a/.config/emacs/.dir-locals.el b/.config/emacs/.dir-locals.el new file mode 100644 index 0000000..dcd1abb --- /dev/null +++ b/.config/emacs/.dir-locals.el @@ -0,0 +1,6 @@ +;; TODO: We have to be careful what variables we set here. Some can cause the +;; Eldev linters to not read the settings here. See emacs-eldev/eldev#83. +((nil + (fill-column . 80) + (indent-tabs-mode . nil) + (sentence-end-double-space . t))) diff --git a/.config/mustache.yaml b/.config/mustache.yaml new file mode 100644 index 0000000..72782b8 --- /dev/null +++ b/.config/mustache.yaml @@ -0,0 +1,9 @@ +project: + description: >- + This makes it possible to define syntax extensions, similar to what can + be done in Common Lisp with `set-macro-character`. + name: "elisp-reader" + repo: "sellout/elisp-reader.el" + summary: "A custom Lisp reader written in Elisp" + version: "0.1.0" +type: { name: "emacs-lisp" } diff --git a/.config/project/default.nix b/.config/project/default.nix new file mode 100644 index 0000000..31b0f98 --- /dev/null +++ b/.config/project/default.nix @@ -0,0 +1,77 @@ +{config, flaky, lib, ...}: { + project = { + name = "elisp-reader"; + summary = "A custom Lisp reader written in Elisp"; + }; + + ## dependency management + services.renovate.enable = true; + + ## development + programs = { + direnv.enable = true; + # This should default by whether there is a .git file/dir (and whether it’s + # a file (worktree) or dir determines other things – like where hooks + # are installed. + git = { + enable = true; + ignores = [ + # Compiled + "*.elc" + # Packaging + "/.eldev" + ]; + }; + }; + + ## formatting + editorconfig.enable = true; + ## See the file for why this needs to force a different version. + project.file.".dir-locals.el".source = lib.mkForce ../emacs/.dir-locals.el; + programs = { + treefmt = { + enable = true; + ## In elisp repos, we prefer Org over Markdown, so we don’t need this + ## formatter. + programs.prettier.enable = lib.mkForce false; + }; + vale = { + enable = true; + excludes = [ + "*.el" + "./.github/settings.yml" + "./Eldev" + ]; + vocab.${config.project.name}.accept = [ + "Eldev" + ]; + }; + }; + + ## CI + services.garnix = { + enable = true; + builds.exclude = [ + # TODO: Remove once garnix-io/garnix#285 is fixed. + "homeConfigurations.x86_64-darwin-${config.project.name}-example" + ]; + }; + ## FIXME: Shouldn’t need `mkForce` here (or to duplicate the base contexts). + ## Need to improve module merging. + services.github.settings.branches.main.protection.required_status_checks.contexts = + lib.mkForce + (lib.concatMap flaky.lib.garnixChecks [ + (sys: "check elisp-doctor [${sys}]") + (sys: "check elisp-lint [${sys}]") + (sys: "homeConfig ${sys}-${config.project.name}-example") + (sys: "package default [${sys}]") + (sys: "package emacs-${config.project.name} [${sys}]") + ## FIXME: These are duplicated from the base config + (sys: "check formatter [${sys}]") + (sys: "devShell default [${sys}]") + ]); + + ## publishing + services.flakehub.enable = true; + services.github.enable = true; +} diff --git a/.editorconfig b/.editorconfig index 67515d4..495a00c 100644 --- a/.editorconfig +++ b/.editorconfig @@ -1,22 +1,19 @@ -### This configures basic cross-editor formatting. -### -### See https://editorconfig.org/ for more info, and to see if your editor -### requires a plugin to take advantage of it. - -root = true +# This file was generated by Project Manager. +root=true [*] -charset = utf-8 -end_of_line = lf -indent_size = 2 -indent_style = space -insert_final_newline = true -trim_trailing_whitespace = true +binary_next_line=true +charset=utf-8 +end_of_line=lf +indent_size=2 +indent_style=space +insert_final_newline=true +space_redirects=true +switch_case_indent=true +trim_trailing_whitespace=true [*.{diff,patch}] -trim_trailing_whitespace = false +trim_trailing_whitespace=false [*.{el,lisp}] -## Lisps have a fairly consistent indentation style that doesn’t collapse well -## to a single value, so we let the editor do what it wants here. -indent_size = unset +indent_size=unset diff --git a/.envrc b/.envrc index 3550a30..5ee57c5 100644 --- a/.envrc +++ b/.envrc @@ -1 +1,3 @@ +# This file was generated by Project Manager. +direnv_layout_dir="$PWD/.cache/direnv" use flake diff --git a/.gitattributes b/.gitattributes index 25fb6d4..4a27d2c 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,2 +1,13 @@ -# Don’t render generated files by default in GitHub diffs -flake.lock linguist-generated +/.cache/git/config linguist-generated +/.cache/git/hooks/pre-push linguist-generated +/.cache/vale/Vocab/elisp-reader/accept.txt linguist-generated +/.dir-locals.el linguist-generated +/.editorconfig linguist-generated +/.envrc linguist-generated +/.gitattributes linguist-generated +/.github/renovate.json linguist-generated +/.github/settings.yml linguist-generated +/.gitignore linguist-generated +/.vale.ini linguist-generated +/.github/workflows/flakehub-publish.yml linguist-generated +/garnix.yaml linguist-generated diff --git a/.github/renovate.json b/.github/renovate.json new file mode 100644 index 0000000..0ff5254 --- /dev/null +++ b/.github/renovate.json @@ -0,0 +1 @@ +{"$schema":"https://docs.renovatebot.com/renovate-schema.json","extends":["config:base"],"lockFileMaintenance":{"enabled":true},"nix":{"enabled":true}} \ No newline at end of file diff --git a/.github/settings.yml b/.github/settings.yml new file mode 100644 index 0000000..c33cabc --- /dev/null +++ b/.github/settings.yml @@ -0,0 +1,2 @@ +# This file was generated by Project Manager. +{"actions":{"permissions":{"workflow":{"can_approve_pull_request_reviews":true}}},"branches":[{"name":"main","protection":{"allow_force_pushes":false,"enforce_admins":true,"required_linear_history":false,"required_pull_request_reviews":null,"required_status_checks":{"contexts":["check elisp-doctor [aarch64-darwin]","check elisp-doctor [aarch64-linux]","check elisp-doctor [i686-linux]","check elisp-doctor [x86_64-linux]","check elisp-lint [aarch64-darwin]","check elisp-lint [aarch64-linux]","check elisp-lint [i686-linux]","check elisp-lint [x86_64-linux]","homeConfig aarch64-darwin-elisp-reader-example","homeConfig aarch64-linux-elisp-reader-example","homeConfig i686-linux-elisp-reader-example","homeConfig x86_64-linux-elisp-reader-example","package default [aarch64-darwin]","package default [aarch64-linux]","package default [i686-linux]","package default [x86_64-linux]","package emacs-elisp-reader [aarch64-darwin]","package emacs-elisp-reader [aarch64-linux]","package emacs-elisp-reader [i686-linux]","package emacs-elisp-reader [x86_64-linux]","check formatter [aarch64-darwin]","check formatter [aarch64-linux]","check formatter [i686-linux]","check formatter [x86_64-linux]","devShell default [aarch64-darwin]","devShell default [aarch64-linux]","devShell default [i686-linux]","devShell default [x86_64-linux]"],"strict":false},"restrictions":null}}],"labels":[{"color":"","description":"Created automatically by some service or process","name":"automated"},{"color":"#d73a4a","description":"Something isn’t working","name":"bug"},{"color":"#333333","description":"Updates or other changes to dependencies","name":"dependencies"},{"color":"#0075ca","description":"Improvements or additions to documentation","name":"documentation"},{"color":"#a2eeef","description":"New feature or request","name":"enhancement"},{"color":"#7057ff","description":"Good for newcomers","name":"good first issue"},{"color":"#000000","description":"Issues you want contributors to help with.","name":"hacktoberfest"},{"color":"#ff7518","description":"Indicates acceptance for Hacktoberfest criteria, even if not merged yet.","name":"hacktoberfest-accepted"},{"color":"#008672","description":"Extra attention is needed","name":"help wanted"},{"color":"#333333","description":"Unaccepted contributions that haven’t been closed for some reason.","name":"invalid"},{"color":"#d876e3","description":"Further information is requested","name":"question"},{"color":"#ffc0cb","description":"Topic created in bad faith. Services like Hacktoberfest use this to identify bad actors.","name":"spam"},{"color":"#d4af37","description":"Work prioritized by a sponsor","name":"sponsored"}],"repository":{"allow_merge_commit":true,"allow_rebase_merge":false,"allow_squash_merge":false,"default_branch":"main","delete_branch_on_merge":true,"description":"A custom Lisp reader written in Elisp","enable_automated_security_fixes":true,"enable_vulnerability_alerts":true,"has_downloads":false,"has_issues":true,"has_projects":true,"has_wiki":true,"merge_commit_message":"PR_BODY","merge_commit_title":"PR_TITLE","name":"elisp-reader","private":false,"topics":"hacktoberfest"}} \ No newline at end of file diff --git a/.github/workflows/flakehub-publish.yml b/.github/workflows/flakehub-publish.yml new file mode 100644 index 0000000..49cf3f7 --- /dev/null +++ b/.github/workflows/flakehub-publish.yml @@ -0,0 +1,27 @@ +name: "Publish tags to FlakeHub" +on: + push: + tags: + - "v?[0-9]+.[0-9]+.[0-9]+*" + workflow_dispatch: + inputs: + tag: + description: "The existing tag to publish to FlakeHub" + type: "string" + required: true +jobs: + flakehub-publish: + runs-on: "ubuntu-latest" + permissions: + id-token: "write" + contents: "read" + steps: + - uses: "actions/checkout@v4" + with: + ref: "${{ (inputs.tag != null) && format('refs/tags/{0}', inputs.tag) || '' }}" + - uses: "DeterminateSystems/nix-installer-action@main" + - uses: "DeterminateSystems/flakehub-push@main" + with: + visibility: "public" + name: "sellout/elisp-reader" + tag: "${{ inputs.tag }}" diff --git a/.gitignore b/.gitignore index 5a8cd58..a5a0a2c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,13 +1,11 @@ -# Direnv -/.direnv - -# Nix build -/outputs /result /source - -# Compiled *.elc - -# Packaging /.eldev +/.cache/vale/* +!/.cache/vale/Vocab/ +/.cache/vale/Vocab/* +!/.cache/vale/Vocab/elisp-reader/ +/.local/state/project-manager/ +/.local/state/nix/profiles/ +/.cache/direnv/ diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 0000000..b87266f --- /dev/null +++ b/.vale.ini @@ -0,0 +1,15 @@ +; This file was generated by Project Manager. +MinAlertLevel=suggestion +Packages=Microsoft +StylesPath=.cache/vale +Vocab=elisp-reader + +[*] +BasedOnStyles=Vale, Microsoft +Microsoft.Dashes=NO +Microsoft.GeneralURL=NO +Microsoft.Headings=NO +Microsoft.Quotes=NO +Microsoft.Ranges=NO +Microsoft.Vocab=NO +Microsoft.We=NO diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md index fdc0f09..62f99e6 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,20 @@ elisp-reader.el =============== -A custom Lisp reader written in Elisp. This makes it possible to define syntax -extensions, similar to what can be done in Common Lisp with +A custom Lisp reader written in Emacs Lisp. This makes it possible to define +syntax extensions, similar to what one can do in Common Lisp with `set-macro-character`. Once loaded, this library will kick in when loading other `.el` files, when evaluating expressions in a buffer via `C-M-x` or via `M-x eval-region` or when -running commands in the REPL (`M-x ielm`) etc. If there are bugs, they will +running commands in the REPL (`M-x ielm`) etc. If there are bugs, they will most probably render your Emacs session unusable. It's recommended to byte-compile it before loading, otherwise it's quite slow: emacs --batch --eval '(byte-compile-file "elisp-reader.el")' -This isn't a final product. It's rather a request for brainstorming. It proves +This isn't a final product. It's rather a request for brainstorming. It proves that it's possible to implement file-local symbols or a better syntax for RegExp-s; a customizable reader in general—by just doing everything in Lisp rather than in C. diff --git a/flake.lock b/flake.lock index 14ae7d7..285a17e 100644 --- a/flake.lock +++ b/flake.lock @@ -2,19 +2,22 @@ "nodes": { "bash-strict-mode": { "inputs": { - "flake-utils": "flake-utils", - "home-manager": "home-manager", + "flake-utils": "flake-utils_2", + "flaky": [ + "flaky" + ], "nixpkgs": [ + "flaky", "nixpkgs" ], "shellcheck-nix-attributes": "shellcheck-nix-attributes" }, "locked": { - "lastModified": 1674014107, - "narHash": "sha256-UgrmDzeSp+li0/wtn0zRZicqy2595bUftW1bMBfP+5Y=", + "lastModified": 1704008028, + "narHash": "sha256-GZH+2RwRSK6Ten66Ij1NaVQCNKdzItHKWuoVnKUJmGk=", "owner": "sellout", "repo": "bash-strict-mode", - "rev": "da573e33174d7078e62eb2a9d9eb7d662e5b4913", + "rev": "f0d0c30a2a7eaf4e9c3f4dad4c674c5e9bd38bda", "type": "github" }, "original": { @@ -23,13 +26,48 @@ "type": "github" } }, + "flake-compat": { + "flake": false, + "locked": { + "lastModified": 1673956053, + "narHash": "sha256-4gtG9iQuiKITOjNQQeQIpoIB6b16fm+504Ch3sNKLd8=", + "owner": "edolstra", + "repo": "flake-compat", + "rev": "35bb57c0c8d8b62bbfd284272c928ceb64ddbde9", + "type": "github" + }, + "original": { + "owner": "edolstra", + "repo": "flake-compat", + "type": "github" + } + }, + "flake-schemas": { + "locked": { + "lastModified": 1701189173, + "narHash": "sha256-ieQZLjqfvOP+52WeMdkD/x5njEIAqjKuAc/jnmruaoc=", + "owner": "sellout", + "repo": "flake-schemas", + "rev": "68727227a8f349fe0831f6389d9a91064637b70c", + "type": "github" + }, + "original": { + "owner": "sellout", + "ref": "patch-1", + "repo": "flake-schemas", + "type": "github" + } + }, "flake-utils": { + "inputs": { + "systems": "systems" + }, "locked": { - "lastModified": 1667395993, - "narHash": "sha256-nuEHfE/LcWyuSWnS8t12N1wc105Qtau+/OdUAjtQ0rA=", + "lastModified": 1701680307, + "narHash": "sha256-kAuep2h5ajznlPMD9rnQyffWG8EM/C73lejGofXvdM8=", "owner": "numtide", "repo": "flake-utils", - "rev": "5aed5285a952e0b949eb3ba02c12fa4fcfef535f", + "rev": "4022d587cbbfd70fe950c1e2083a02621806a725", "type": "github" }, "original": { @@ -40,14 +78,14 @@ }, "flake-utils_2": { "inputs": { - "systems": "systems" + "systems": "systems_2" }, "locked": { - "lastModified": 1685518550, - "narHash": "sha256-o2d0KcvaXzTrPRIo0kOLV0/QXHhDQ5DTi+OxcjO8xqY=", + "lastModified": 1701680307, + "narHash": "sha256-kAuep2h5ajznlPMD9rnQyffWG8EM/C73lejGofXvdM8=", "owner": "numtide", "repo": "flake-utils", - "rev": "a1720a10a6cfe8234c0e93907ffe81be440f4cef", + "rev": "4022d587cbbfd70fe950c1e2083a02621806a725", "type": "github" }, "original": { @@ -56,58 +94,124 @@ "type": "github" } }, - "home-manager": { + "flaky": { "inputs": { + "bash-strict-mode": "bash-strict-mode", + "flake-utils": [ + "flake-utils" + ], + "home-manager": "home-manager", "nixpkgs": [ - "bash-strict-mode", "nixpkgs" ], - "utils": "utils" + "project-manager": "project-manager" }, "locked": { - "lastModified": 1672244468, - "narHash": "sha256-xaZb8AZqoXRCSqPusCk4ouf+fUNP8UJdafmMTF1Ltlw=", - "owner": "nix-community", - "repo": "home-manager", - "rev": "89a8ba0b5b43b3350ff2e3ef37b66736b2ef8706", + "lastModified": 1704242273, + "narHash": "sha256-rec9StIg9udQpQuodEZlRPSgXKpImBqg5wmdCnzeq1E=", + "owner": "sellout", + "repo": "flaky", + "rev": "b48abdadd47782b310c9e6efcfcf9d6d99f54442", "type": "github" }, "original": { - "owner": "nix-community", - "ref": "release-22.11", - "repo": "home-manager", + "owner": "sellout", + "repo": "flaky", "type": "github" } }, - "home-manager_2": { + "home-manager": { "inputs": { "nixpkgs": [ + "flaky", "nixpkgs" - ], - "utils": "utils_2" + ] }, "locked": { - "lastModified": 1681092193, - "narHash": "sha256-JerCqqOqbT2tBnXQW4EqwFl0hHnuZp21rIQ6lu/N4rI=", + "lastModified": 1703367386, + "narHash": "sha256-FMbm48UGrBfOWGt8+opuS+uLBLQlRfhiYXhHNcYMS5k=", "owner": "nix-community", "repo": "home-manager", - "rev": "f9edbedaf015013eb35f8caacbe0c9666bbc16af", + "rev": "d5824a76bc6bb93d1dce9ebbbcb09a9b6abcc224", "type": "github" }, "original": { "owner": "nix-community", - "ref": "release-22.11", + "ref": "release-23.11", "repo": "home-manager", "type": "github" } }, + "lowdown-src": { + "flake": false, + "locked": { + "lastModified": 1633514407, + "narHash": "sha256-Dw32tiMjdK9t3ETl5fzGrutQTzh2rufgZV4A/BbxuD4=", + "owner": "kristapsdz", + "repo": "lowdown", + "rev": "d2c2b44ff6c27b936ec27358a2653caaef8f73b8", + "type": "github" + }, + "original": { + "owner": "kristapsdz", + "repo": "lowdown", + "type": "github" + } + }, + "nix-schema": { + "inputs": { + "flake-compat": "flake-compat", + "flake-schemas": [ + "flaky", + "project-manager", + "flake-schemas" + ], + "lowdown-src": "lowdown-src", + "nixpkgs": [ + "flaky", + "project-manager", + "nixpkgs-23_11" + ], + "nixpkgs-regression": "nixpkgs-regression" + }, + "locked": { + "lastModified": 1697822067, + "narHash": "sha256-7HCcrF6GqIAreKvzt74do1/Urvp+b901Hckf5+WgR9M=", + "owner": "DeterminateSystems", + "repo": "nix", + "rev": "84867fa212fe08feeb27b668c4c78bc9eaf74e17", + "type": "github" + }, + "original": { + "owner": "DeterminateSystems", + "ref": "flake-schemas", + "repo": "nix", + "type": "github" + } + }, "nixpkgs": { "locked": { - "lastModified": 1685587708, - "narHash": "sha256-kd+vA/n7cmCL1QWbKcrcwfq2fl6u6By2t6mS7tQgw7Y=", + "lastModified": 1704420045, + "narHash": "sha256-C36QmoJd5tdQ5R9MC1jM7fBkZW9zBUqbUCsgwS6j4QU=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "c1be43e8e837b8dbee2b3665a007e761680f0c3d", + "type": "github" + }, + "original": { + "owner": "NixOS", + "ref": "release-23.11", + "repo": "nixpkgs", + "type": "github" + } + }, + "nixpkgs-22_11": { + "locked": { + "lastModified": 1688392541, + "narHash": "sha256-lHrKvEkCPTUO+7tPfjIcb7Trk6k31rz18vkyqmkeJfY=", "owner": "NixOS", "repo": "nixpkgs", - "rev": "041fc5df0031224c56bbd47165d45b16cb628ca9", + "rev": "ea4c80b39be4c09702b0cb3b42eab59e2ba4f24b", "type": "github" }, "original": { @@ -117,11 +221,109 @@ "type": "github" } }, + "nixpkgs-23_05": { + "locked": { + "lastModified": 1703950681, + "narHash": "sha256-veU5bE4eLOmi7aOzhE7LfZXcSOONRMay0BKv01WHojo=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "0aad9113182747452dbfc68b93c86e168811fa6c", + "type": "github" + }, + "original": { + "owner": "NixOS", + "ref": "release-23.05", + "repo": "nixpkgs", + "type": "github" + } + }, + "nixpkgs-23_11": { + "locked": { + "lastModified": 1703970664, + "narHash": "sha256-S5Y0wm15CMgcOSsChEz8++o4IEXduu+A/e/nztiNXsk=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "41dda835e2bce1270e837d9b5eaa5f78404aa45e", + "type": "github" + }, + "original": { + "owner": "NixOS", + "ref": "release-23.11", + "repo": "nixpkgs", + "type": "github" + } + }, + "nixpkgs-regression": { + "locked": { + "lastModified": 1643052045, + "narHash": "sha256-uGJ0VXIhWKGXxkeNnq4TvV3CIOkUJ3PAoLZ3HMzNVMw=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "215d4d0fd80ca5163643b03a33fde804a29cc1e2", + "type": "github" + }, + "original": { + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "215d4d0fd80ca5163643b03a33fde804a29cc1e2", + "type": "github" + } + }, + "nixpkgs-unstable": { + "locked": { + "lastModified": 1703499205, + "narHash": "sha256-lF9rK5mSUfIZJgZxC3ge40tp1gmyyOXZ+lRY3P8bfbg=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "e1fa12d4f6c6fe19ccb59cac54b5b3f25e160870", + "type": "github" + }, + "original": { + "owner": "NixOS", + "ref": "nixpkgs-unstable", + "repo": "nixpkgs", + "type": "github" + } + }, + "project-manager": { + "inputs": { + "bash-strict-mode": [ + "flaky", + "bash-strict-mode" + ], + "flake-schemas": "flake-schemas", + "flake-utils": [ + "flaky", + "flake-utils" + ], + "flaky": [ + "flaky" + ], + "nix-schema": "nix-schema", + "nixpkgs-22_11": "nixpkgs-22_11", + "nixpkgs-23_05": "nixpkgs-23_05", + "nixpkgs-23_11": "nixpkgs-23_11", + "nixpkgs-unstable": "nixpkgs-unstable", + "treefmt-nix": "treefmt-nix" + }, + "locked": { + "lastModified": 1704008255, + "narHash": "sha256-xpofWpf/2uND3j6VaIWwvcSHINsuLNuD6Az0MR18+aw=", + "owner": "sellout", + "repo": "project-manager", + "rev": "539a7b9799692fa4481373aedae530ddbc78822b", + "type": "github" + }, + "original": { + "owner": "sellout", + "repo": "project-manager", + "type": "github" + } + }, "root": { "inputs": { - "bash-strict-mode": "bash-strict-mode", - "flake-utils": "flake-utils_2", - "home-manager": "home-manager_2", + "flake-utils": "flake-utils", + "flaky": "flaky", "nixpkgs": "nixpkgs" } }, @@ -156,33 +358,40 @@ "type": "github" } }, - "utils": { + "systems_2": { "locked": { - "lastModified": 1667395993, - "narHash": "sha256-nuEHfE/LcWyuSWnS8t12N1wc105Qtau+/OdUAjtQ0rA=", - "owner": "numtide", - "repo": "flake-utils", - "rev": "5aed5285a952e0b949eb3ba02c12fa4fcfef535f", + "lastModified": 1681028828, + "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", + "owner": "nix-systems", + "repo": "default", + "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", "type": "github" }, "original": { - "owner": "numtide", - "repo": "flake-utils", + "owner": "nix-systems", + "repo": "default", "type": "github" } }, - "utils_2": { + "treefmt-nix": { + "inputs": { + "nixpkgs": [ + "flaky", + "project-manager", + "nixpkgs-23_11" + ] + }, "locked": { - "lastModified": 1667395993, - "narHash": "sha256-nuEHfE/LcWyuSWnS8t12N1wc105Qtau+/OdUAjtQ0rA=", + "lastModified": 1702979157, + "narHash": "sha256-RnFBbLbpqtn4AoJGXKevQMCGhra4h6G2MPcuTSZZQ+g=", "owner": "numtide", - "repo": "flake-utils", - "rev": "5aed5285a952e0b949eb3ba02c12fa4fcfef535f", + "repo": "treefmt-nix", + "rev": "2961375283668d867e64129c22af532de8e77734", "type": "github" }, "original": { "owner": "numtide", - "repo": "flake-utils", + "repo": "treefmt-nix", "type": "github" } } diff --git a/flake.nix b/flake.nix index 58fb0f0..4cf6bb1 100644 --- a/flake.nix +++ b/flake.nix @@ -1,260 +1,110 @@ { - description = "A custom Lisp reader written in Elisp."; + description = "A custom Lisp reader written in Elisp"; nixConfig = { ## https://github.com/NixOS/rfcs/blob/master/rfcs/0045-deprecate-url-syntax.md extra-experimental-features = ["no-url-literals"]; + extra-substituters = ["https://cache.garnix.io"]; extra-trusted-public-keys = [ "cache.garnix.io:CTFPyKSLcx5RMJKfLo5EEPUObbA78b0YQ2DTCJXqr9g=" ]; - extra-trusted-substituters = ["https://cache.garnix.io"]; ## Isolate the build. registries = false; - sandbox = true; + sandbox = false; }; - outputs = inputs: let + outputs = { + flake-utils, + flaky, + nixpkgs, + self, + }: let pname = "elisp-reader"; ename = "emacs-${pname}"; in { + schemas = { + inherit + (flaky.schemas) + overlays + homeConfigurations + packages + devShells + projectConfigurations + checks + formatter + ; + }; + overlays = { - default = final: prev: { - emacsPackagesFor = emacs: - (prev.emacsPackagesFor emacs).overrideScope' - (inputs.self.overlays.emacs final prev); - }; + default = + flaky.lib.elisp.overlays.default self.overlays.emacs; emacs = final: prev: efinal: eprev: { - "${pname}" = inputs.self.packages.${final.system}.${ename}; + "${pname}" = self.packages.${final.system}.${ename}; }; }; homeConfigurations = builtins.listToAttrs (builtins.map - (system: { - name = "${system}-example"; - value = inputs.home-manager.lib.homeManagerConfiguration { - pkgs = import inputs.nixpkgs { - inherit system; - overlays = [inputs.self.overlays.default]; - }; - - modules = [ - ./nix/home-manager-example.nix - { - # These attributes are simply required by home-manager. - home = { - homeDirectory = /tmp/${ename}-example; - stateVersion = "22.11"; - username = "${ename}-example-user"; - }; - } - ]; - }; - }) - inputs.flake-utils.lib.defaultSystems); + (flaky.lib.homeConfigurations.example + pname + self + [ + ({pkgs, ...}: { + programs.emacs = { + enable = true; + extraConfig = '' + (require '${pname}) + ''; + extraPackages = epkgs: [epkgs.${pname}]; + }; + }) + ]) + flake-utils.lib.defaultSystems); } - // inputs.flake-utils.lib.eachDefaultSystem (system: let - pkgs = import inputs.nixpkgs { + // flake-utils.lib.eachDefaultSystem (system: let + pkgs = import nixpkgs { inherit system; - overlays = [(import ./nix/dependencies.nix)]; + overlays = [flaky.overlays.elisp-dependencies]; }; - emacsPath = package: "${package}/share/emacs/site-lisp/elpa/${package.pname}-${package.version}"; - - ## Read version in format: ;; Version: xx.yy - readVersion = fp: - builtins.elemAt - (builtins.match - ".*(;; Version: ([[:digit:]]+\.[[:digit:]]+(\.[[:digit:]]+)?)).*" - (builtins.readFile fp)) - 1; - src = pkgs.lib.cleanSource ./.; - - ## We need to tell Eldev where to find its Emacs package. - ELDEV_LOCAL = emacsPath pkgs.emacsPackages.eldev; in { packages = { - default = inputs.self.packages.${system}.${ename}; - + default = self.packages.${system}.${ename}; "${ename}" = - inputs.bash-strict-mode.lib.checkedDrv pkgs - (pkgs.emacsPackages.trivialBuild { - inherit ELDEV_LOCAL pname src; - - version = readVersion ./${pname}.el; - - nativeBuildInputs = [ - (pkgs.emacsWithPackages (epkgs: [epkgs.buttercup])) - # Emacs-lisp build tool, https://doublep.github.io/eldev/ - pkgs.emacsPackages.eldev - ]; - - doCheck = true; - - checkPhase = '' - runHook preCheck - ## TODO: Currently needed to make a temp file in - ## `eldev--create-internal-pseudoarchive-descriptor`. - export HOME="$PWD/fake-home" - mkdir -p "$HOME" - eldev test - runHook postCheck - ''; - - doInstallCheck = true; - - installCheckPhase = '' - runHook preInstallCheck - eldev --packaged test - runHook postInstallCheck - ''; - }); + flaky.lib.elisp.package pkgs src pname (epkgs: [epkgs.buttercup]); }; devShells.default = - ## TODO: Use `inputs.bash-strict-mode.lib.checkedDrv` here after - ## NixOS/nixpkgs#204606 makes it into a release. - inputs.bash-strict-mode.lib.drv pkgs - (pkgs.mkShell { - inputsFrom = - builtins.attrValues inputs.self.checks.${system} - ++ builtins.attrValues inputs.self.packages.${system}; - - nativeBuildInputs = [ - # Nix language server, - # https://github.com/oxalica/nil#readme - pkgs.nil - # Bash language server, - # https://github.com/bash-lsp/bash-language-server#readme - pkgs.nodePackages.bash-language-server - ]; - }); - - checks = { - doctor = - inputs.bash-strict-mode.lib.checkedDrv pkgs - (pkgs.stdenv.mkDerivation { - inherit ELDEV_LOCAL src; - - name = "eldev-doctor"; + flaky.lib.devShells.default system self [] ""; - nativeBuildInputs = [ - pkgs.emacs - # Emacs-lisp build tool, https://doublep.github.io/eldev/ - pkgs.emacsPackages.eldev - ]; + projectConfigurations = + flaky.lib.projectConfigurations.default {inherit pkgs self;}; - buildPhase = '' - runHook preBuild - eldev doctor - runHook postBuild - ''; - - installPhase = '' - runHook preInstall - mkdir -p "$out" - runHook postInstall - ''; - }); - - lint = - ## TODO: Can’t currently use `inputs.bash-strict-mode.lib.checkedDrv` - ## because the `emacs` wrapper script checks for existence of a - ## variable with `-n` intead of `-v`. - inputs.bash-strict-mode.lib.shellchecked pkgs - (pkgs.stdenv.mkDerivation { - inherit ELDEV_LOCAL src; - - name = "eldev-lint"; - - nativeBuildInputs = [ - pkgs.emacs - pkgs.emacsPackages.eldev - ]; - - postPatch = '' - { - echo - echo "(mapcar" - echo " 'eldev-use-local-dependency" - echo " '(\"${emacsPath pkgs.emacsPackages.dash}\"" - echo " \"${emacsPath pkgs.emacsPackages.elisp-lint}\"" - echo " \"${emacsPath pkgs.emacsPackages.package-lint}\"" - echo " \"${emacsPath pkgs.emacsPackages.relint}\"" - echo " \"${emacsPath pkgs.emacsPackages.xr}\"))" - ## TODO: Remove this once purcell/package-lint#238 is fixed. - ## For now, it should be a reversed version of the values - ## of `read-symbol-shorthands` in the various .el files. - echo "(require 'package-lint" - echo " \"${emacsPath pkgs.emacsPackages.package-lint}/package-lint.el\")" - echo "(add-to-list 'package-lint--allowed-prefix-mappings" - echo " '(\"elisp-reader\" . (\"er\")))" - } >> Eldev - ''; - - buildPhase = '' - runHook preBuild - ## TODO: Currently needed to make a temp file in - ## `eldev--create-internal-pseudoarchive-descriptor`. - export HOME="$PWD/fake-home" - mkdir -p "$HOME" - ## Need `--external` here so that we don’t try to download any - ## package archives (which would break the sandbox). - eldev --external lint - runHook postBuild - ''; - - installPhase = '' - runHook preInstall - mkdir -p "$out" - runHook preInstall - ''; - }); - - nix-fmt = - inputs.bash-strict-mode.lib.checkedDrv pkgs - (pkgs.stdenv.mkDerivation { - inherit src; - - name = "nix fmt"; - - nativeBuildInputs = [inputs.self.formatter.${system}]; - - buildPhase = '' - runHook preBuild - alejandra --check . - runHook postBuild - ''; - - installPhase = '' - runHook preInstall - mkdir -p "$out" - runHook preInstall - ''; - }); - }; + checks = + self.projectConfigurations.${system}.checks + // { + elisp-doctor = flaky.lib.elisp.checks.doctor pkgs src; + elisp-lint = flaky.lib.elisp.checks.lint pkgs src (_: []); + }; - # Nix code formatter, https://github.com/kamadorueda/alejandra#readme - formatter = pkgs.alejandra; + formatter = self.projectConfigurations.${system}.formatter; }); inputs = { - bash-strict-mode = { - inputs.nixpkgs.follows = "nixpkgs"; - url = "github:sellout/bash-strict-mode"; - }; - flake-utils.url = "github:numtide/flake-utils"; - home-manager = { - inputs.nixpkgs.follows = "nixpkgs"; - url = "github:nix-community/home-manager/release-22.11"; + flaky = { + inputs = { + flake-utils.follows = "flake-utils"; + nixpkgs.follows = "nixpkgs"; + }; + url = "github:sellout/flaky"; }; - nixpkgs.url = "github:NixOS/nixpkgs/release-22.11"; + nixpkgs.url = "github:NixOS/nixpkgs/release-23.11"; }; } diff --git a/garnix.yaml b/garnix.yaml new file mode 100644 index 0000000..a78abd0 --- /dev/null +++ b/garnix.yaml @@ -0,0 +1,2 @@ +# This file was generated by Project Manager. +{"builds":{"exclude":["*.x86_64-darwin","*.x86_64-darwin.*","homeConfigurations.x86_64-darwin-elisp-reader-example","checks.*.project-manager-files","checks.*.vale","devShells.*.lax-checks"],"include":["*.*","*.*.*"]}} \ No newline at end of file diff --git a/nix/dependencies.nix b/nix/dependencies.nix deleted file mode 100644 index 9c3e435..0000000 --- a/nix/dependencies.nix +++ /dev/null @@ -1,12 +0,0 @@ -final: prev: { - emacsPackagesFor = emacs: - (prev.emacsPackagesFor emacs).overrideScope' (efinal: eprev: { - # The `eldev` package doesn’t expose the executable. - eldev = eprev.eldev.overrideAttrs (old: { - postInstall = '' - mkdir -p "$out" - cp -R "$src/bin" "$out/" - ''; - }); - }); -} From f9b99838728261a9e93929a7808ad66ed0d27c3d Mon Sep 17 00:00:00 2001 From: Greg Pfeil Date: Fri, 5 Jan 2024 10:36:04 +0100 Subject: [PATCH 05/11] Add support for other default Flaky systems MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Basically, i686-linux – a 32-bit platform --- flake.nix | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/flake.nix b/flake.nix index 4cf6bb1..d34c435 100644 --- a/flake.nix +++ b/flake.nix @@ -21,6 +21,8 @@ }: let pname = "elisp-reader"; ename = "emacs-${pname}"; + + supportedSystems = flaky.lib.defaultSystems; in { schemas = { @@ -62,9 +64,9 @@ }; }) ]) - flake-utils.lib.defaultSystems); + supportedSystems); } - // flake-utils.lib.eachDefaultSystem (system: let + // flake-utils.lib.eachSystem supportedSystems (system: let pkgs = import nixpkgs { inherit system; overlays = [flaky.overlays.elisp-dependencies]; From 875fa64a4c079c6f1938e90517c8b33aa6f7ebac Mon Sep 17 00:00:00 2001 From: Greg Pfeil Date: Thu, 1 Aug 2024 09:14:32 -0600 Subject: [PATCH 06/11] Sync Flaky template This also causes us to upgrade to Nixpkgs 24.05. --- .../vocabularies/elisp-reader/accept.txt | 6 + .config/mustache.yaml | 1 - .config/project/default.nix | 36 ++-- .gitattributes | 1 + .github/renovate.json | 2 +- .github/settings.yml | 2 +- .gitignore | 5 + elisp-reader.el | 36 ++-- flake.lock | 184 +++++++----------- flake.nix | 49 ++--- garnix.yaml | 2 +- 11 files changed, 143 insertions(+), 181 deletions(-) create mode 100644 .cache/vale/config/vocabularies/elisp-reader/accept.txt diff --git a/.cache/vale/config/vocabularies/elisp-reader/accept.txt b/.cache/vale/config/vocabularies/elisp-reader/accept.txt new file mode 100644 index 0000000..b0bbe0d --- /dev/null +++ b/.cache/vale/config/vocabularies/elisp-reader/accept.txt @@ -0,0 +1,6 @@ +direnv +garnix +[Nn]ix +Pfeil +ShellCheck +Eldev diff --git a/.config/mustache.yaml b/.config/mustache.yaml index 72782b8..6beade3 100644 --- a/.config/mustache.yaml +++ b/.config/mustache.yaml @@ -5,5 +5,4 @@ project: name: "elisp-reader" repo: "sellout/elisp-reader.el" summary: "A custom Lisp reader written in Elisp" - version: "0.1.0" type: { name: "emacs-lisp" } diff --git a/.config/project/default.nix b/.config/project/default.nix index 31b0f98..195fedc 100644 --- a/.config/project/default.nix +++ b/.config/project/default.nix @@ -1,4 +1,10 @@ -{config, flaky, lib, ...}: { +{ + config, + flaky, + lib, + supportedSystems, + ... +}: { project = { name = "elisp-reader"; summary = "A custom Lisp reader written in Elisp"; @@ -51,25 +57,25 @@ ## CI services.garnix = { enable = true; - builds.exclude = [ - # TODO: Remove once garnix-io/garnix#285 is fixed. - "homeConfigurations.x86_64-darwin-${config.project.name}-example" - ]; + ## TODO: Remove once garnix-io/garnix#285 is fixed. + builds.exclude = ["homeConfigurations.x86_64-darwin-example"]; }; ## FIXME: Shouldn’t need `mkForce` here (or to duplicate the base contexts). ## Need to improve module merging. services.github.settings.branches.main.protection.required_status_checks.contexts = lib.mkForce - (lib.concatMap flaky.lib.garnixChecks [ - (sys: "check elisp-doctor [${sys}]") - (sys: "check elisp-lint [${sys}]") - (sys: "homeConfig ${sys}-${config.project.name}-example") - (sys: "package default [${sys}]") - (sys: "package emacs-${config.project.name} [${sys}]") - ## FIXME: These are duplicated from the base config - (sys: "check formatter [${sys}]") - (sys: "devShell default [${sys}]") - ]); + (flaky.lib.forGarnixSystems supportedSystems (sys: [ + "check elisp-doctor [${sys}]" + "check elisp-lint [${sys}]" + "homeConfig ${sys}-example" + "package default [${sys}]" + "package emacs-${config.project.name} [${sys}]" + ## FIXME: These are duplicated from the base config + "check formatter [${sys}]" + "check project-manager-files [${sys}]" + "check vale [${sys}]" + "devShell default [${sys}]" + ])); ## publishing services.flakehub.enable = true; diff --git a/.gitattributes b/.gitattributes index 4a27d2c..1750d2f 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,6 +1,7 @@ /.cache/git/config linguist-generated /.cache/git/hooks/pre-push linguist-generated /.cache/vale/Vocab/elisp-reader/accept.txt linguist-generated +/.cache/vale/config/vocabularies/elisp-reader/accept.txt linguist-generated /.dir-locals.el linguist-generated /.editorconfig linguist-generated /.envrc linguist-generated diff --git a/.github/renovate.json b/.github/renovate.json index 0ff5254..6c7953d 100644 --- a/.github/renovate.json +++ b/.github/renovate.json @@ -1 +1 @@ -{"$schema":"https://docs.renovatebot.com/renovate-schema.json","extends":["config:base"],"lockFileMaintenance":{"enabled":true},"nix":{"enabled":true}} \ No newline at end of file +{"$schema":"https://docs.renovatebot.com/renovate-schema.json","extends":["config:base"],"lockFileMaintenance":{"automerge":true,"enabled":true},"nix":{"enabled":true},"packageRules":[{"automerge":true,"matchCurrentVersion":"!/^0/","matchUpdateTypes":["minor","patch"]}]} \ No newline at end of file diff --git a/.github/settings.yml b/.github/settings.yml index c33cabc..cd8c566 100644 --- a/.github/settings.yml +++ b/.github/settings.yml @@ -1,2 +1,2 @@ # This file was generated by Project Manager. -{"actions":{"permissions":{"workflow":{"can_approve_pull_request_reviews":true}}},"branches":[{"name":"main","protection":{"allow_force_pushes":false,"enforce_admins":true,"required_linear_history":false,"required_pull_request_reviews":null,"required_status_checks":{"contexts":["check elisp-doctor [aarch64-darwin]","check elisp-doctor [aarch64-linux]","check elisp-doctor [i686-linux]","check elisp-doctor [x86_64-linux]","check elisp-lint [aarch64-darwin]","check elisp-lint [aarch64-linux]","check elisp-lint [i686-linux]","check elisp-lint [x86_64-linux]","homeConfig aarch64-darwin-elisp-reader-example","homeConfig aarch64-linux-elisp-reader-example","homeConfig i686-linux-elisp-reader-example","homeConfig x86_64-linux-elisp-reader-example","package default [aarch64-darwin]","package default [aarch64-linux]","package default [i686-linux]","package default [x86_64-linux]","package emacs-elisp-reader [aarch64-darwin]","package emacs-elisp-reader [aarch64-linux]","package emacs-elisp-reader [i686-linux]","package emacs-elisp-reader [x86_64-linux]","check formatter [aarch64-darwin]","check formatter [aarch64-linux]","check formatter [i686-linux]","check formatter [x86_64-linux]","devShell default [aarch64-darwin]","devShell default [aarch64-linux]","devShell default [i686-linux]","devShell default [x86_64-linux]"],"strict":false},"restrictions":null}}],"labels":[{"color":"","description":"Created automatically by some service or process","name":"automated"},{"color":"#d73a4a","description":"Something isn’t working","name":"bug"},{"color":"#333333","description":"Updates or other changes to dependencies","name":"dependencies"},{"color":"#0075ca","description":"Improvements or additions to documentation","name":"documentation"},{"color":"#a2eeef","description":"New feature or request","name":"enhancement"},{"color":"#7057ff","description":"Good for newcomers","name":"good first issue"},{"color":"#000000","description":"Issues you want contributors to help with.","name":"hacktoberfest"},{"color":"#ff7518","description":"Indicates acceptance for Hacktoberfest criteria, even if not merged yet.","name":"hacktoberfest-accepted"},{"color":"#008672","description":"Extra attention is needed","name":"help wanted"},{"color":"#333333","description":"Unaccepted contributions that haven’t been closed for some reason.","name":"invalid"},{"color":"#d876e3","description":"Further information is requested","name":"question"},{"color":"#ffc0cb","description":"Topic created in bad faith. Services like Hacktoberfest use this to identify bad actors.","name":"spam"},{"color":"#d4af37","description":"Work prioritized by a sponsor","name":"sponsored"}],"repository":{"allow_merge_commit":true,"allow_rebase_merge":false,"allow_squash_merge":false,"default_branch":"main","delete_branch_on_merge":true,"description":"A custom Lisp reader written in Elisp","enable_automated_security_fixes":true,"enable_vulnerability_alerts":true,"has_downloads":false,"has_issues":true,"has_projects":true,"has_wiki":true,"merge_commit_message":"PR_BODY","merge_commit_title":"PR_TITLE","name":"elisp-reader","private":false,"topics":"hacktoberfest"}} \ No newline at end of file +{"actions":{"permissions":{"workflow":{"can_approve_pull_request_reviews":true}}},"branches":[{"name":"main","protection":{"allow_force_pushes":false,"enforce_admins":true,"required_linear_history":false,"required_pull_request_reviews":null,"required_status_checks":{"contexts":["check elisp-doctor [aarch64-darwin]","check elisp-lint [aarch64-darwin]","homeConfig aarch64-darwin-example","package default [aarch64-darwin]","package emacs-elisp-reader [aarch64-darwin]","check formatter [aarch64-darwin]","check project-manager-files [aarch64-darwin]","check vale [aarch64-darwin]","devShell default [aarch64-darwin]","check elisp-doctor [aarch64-linux]","check elisp-lint [aarch64-linux]","homeConfig aarch64-linux-example","package default [aarch64-linux]","package emacs-elisp-reader [aarch64-linux]","check formatter [aarch64-linux]","check project-manager-files [aarch64-linux]","check vale [aarch64-linux]","devShell default [aarch64-linux]","check elisp-doctor [x86_64-linux]","check elisp-lint [x86_64-linux]","homeConfig x86_64-linux-example","package default [x86_64-linux]","package emacs-elisp-reader [x86_64-linux]","check formatter [x86_64-linux]","check project-manager-files [x86_64-linux]","check vale [x86_64-linux]","devShell default [x86_64-linux]","check elisp-doctor [i686-linux]","check elisp-lint [i686-linux]","homeConfig i686-linux-example","package default [i686-linux]","package emacs-elisp-reader [i686-linux]","check formatter [i686-linux]","check project-manager-files [i686-linux]","check vale [i686-linux]","devShell default [i686-linux]"],"strict":false},"restrictions":null}}],"labels":[{"color":"","description":"Created automatically by some service or process","name":"automated"},{"color":"#d73a4a","description":"Something isn’t working","name":"bug"},{"color":"#333333","description":"Updates or other changes to dependencies","name":"dependencies"},{"color":"#0075ca","description":"Improvements or additions to documentation","name":"documentation"},{"color":"#a2eeef","description":"New feature or request","name":"enhancement"},{"color":"#7057ff","description":"Good for newcomers","name":"good first issue"},{"color":"#000000","description":"Issues you want contributors to help with.","name":"hacktoberfest"},{"color":"#ff7518","description":"Indicates acceptance for Hacktoberfest criteria, even if not merged yet.","name":"hacktoberfest-accepted"},{"color":"#008672","description":"Extra attention is needed","name":"help wanted"},{"color":"#333333","description":"Unaccepted contributions that haven’t been closed for some reason.","name":"invalid"},{"color":"#d876e3","description":"Further information is requested","name":"question"},{"color":"#ffc0cb","description":"Topic created in bad faith. Services like Hacktoberfest use this to identify bad actors.","name":"spam"},{"color":"#d4af37","description":"Work prioritized by a sponsor","name":"sponsored"}],"repository":{"allow_merge_commit":true,"allow_rebase_merge":false,"allow_squash_merge":false,"default_branch":"main","delete_branch_on_merge":true,"description":"A custom Lisp reader written in Elisp","enable_automated_security_fixes":true,"enable_vulnerability_alerts":true,"has_downloads":false,"has_issues":true,"has_projects":true,"has_wiki":true,"merge_commit_message":"PR_BODY","merge_commit_title":"PR_TITLE","name":"elisp-reader","private":false,"topics":"hacktoberfest"}} \ No newline at end of file diff --git a/.gitignore b/.gitignore index a5a0a2c..a167e02 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,11 @@ *.elc /.eldev /.cache/vale/* +!/.cache/vale/config/ +/.cache/vale/config/* +!/.cache/vale/config/vocabularies/ +/.cache/vale/config/vocabularies/* +!/.cache/vale/config/vocabularies/elisp-reader/ !/.cache/vale/Vocab/ /.cache/vale/Vocab/* !/.cache/vale/Vocab/elisp-reader/ diff --git a/elisp-reader.el b/elisp-reader.el index 87063e5..3edd308 100644 --- a/elisp-reader.el +++ b/elisp-reader.el @@ -483,26 +483,26 @@ Returns nil if ELT isn’t in LST." "Replace occurrences of CELL in ORIG with ORIG." (cl-labels ((subst-in (thing) - (cond - ((eq thing cell) - orig) - ((consp thing) - (subst-in-list thing) - thing) - ((stringp thing) - thing) - ((arrayp thing) - (subst-in-array thing) - thing) - (t - thing))) + (cond + ((eq thing cell) + orig) + ((consp thing) + (subst-in-list thing) + thing) + ((stringp thing) + thing) + ((arrayp thing) + (subst-in-array thing) + thing) + (t + thing))) (subst-in-list (lst) - (rplaca lst (subst-in (car lst))) - (rplacd lst (subst-in (cdr lst)))) + (rplaca lst (subst-in (car lst))) + (rplacd lst (subst-in (cdr lst)))) (subst-in-array (array) - (cl-loop for el across array - for i upfrom 0 - do (aset array i (subst-in el))))) + (cl-loop for el across array + for i upfrom 0 + do (aset array i (subst-in el))))) (subst-in orig))) (defconst er-*all-digits* '( ?0 ?1 ?2 ?3 ?4 ?5 ?6 ?7 ?8 ?9 diff --git a/flake.lock b/flake.lock index 285a17e..0cbdfdf 100644 --- a/flake.lock +++ b/flake.lock @@ -2,7 +2,7 @@ "nodes": { "bash-strict-mode": { "inputs": { - "flake-utils": "flake-utils_2", + "flake-utils": "flake-utils", "flaky": [ "flaky" ], @@ -13,11 +13,11 @@ "shellcheck-nix-attributes": "shellcheck-nix-attributes" }, "locked": { - "lastModified": 1704008028, - "narHash": "sha256-GZH+2RwRSK6Ten66Ij1NaVQCNKdzItHKWuoVnKUJmGk=", + "lastModified": 1716172543, + "narHash": "sha256-Elk8ehgfszNASACwvNE5lY11rfukRnEjJHYhG6TwkT0=", "owner": "sellout", "repo": "bash-strict-mode", - "rev": "f0d0c30a2a7eaf4e9c3f4dad4c674c5e9bd38bda", + "rev": "759ea338835512493fbca483309375b9a4f29e13", "type": "github" }, "original": { @@ -26,22 +26,6 @@ "type": "github" } }, - "flake-compat": { - "flake": false, - "locked": { - "lastModified": 1673956053, - "narHash": "sha256-4gtG9iQuiKITOjNQQeQIpoIB6b16fm+504Ch3sNKLd8=", - "owner": "edolstra", - "repo": "flake-compat", - "rev": "35bb57c0c8d8b62bbfd284272c928ceb64ddbde9", - "type": "github" - }, - "original": { - "owner": "edolstra", - "repo": "flake-compat", - "type": "github" - } - }, "flake-schemas": { "locked": { "lastModified": 1701189173, @@ -63,11 +47,11 @@ "systems": "systems" }, "locked": { - "lastModified": 1701680307, - "narHash": "sha256-kAuep2h5ajznlPMD9rnQyffWG8EM/C73lejGofXvdM8=", + "lastModified": 1710146030, + "narHash": "sha256-SZ5L6eA7HJ/nmkzGG7/ISclqe6oZdOZTNoesiInkXPQ=", "owner": "numtide", "repo": "flake-utils", - "rev": "4022d587cbbfd70fe950c1e2083a02621806a725", + "rev": "b1d9ab70662946ef0850d488da1c9019f3a9752a", "type": "github" }, "original": { @@ -81,11 +65,11 @@ "systems": "systems_2" }, "locked": { - "lastModified": 1701680307, - "narHash": "sha256-kAuep2h5ajznlPMD9rnQyffWG8EM/C73lejGofXvdM8=", + "lastModified": 1710146030, + "narHash": "sha256-SZ5L6eA7HJ/nmkzGG7/ISclqe6oZdOZTNoesiInkXPQ=", "owner": "numtide", "repo": "flake-utils", - "rev": "4022d587cbbfd70fe950c1e2083a02621806a725", + "rev": "b1d9ab70662946ef0850d488da1c9019f3a9752a", "type": "github" }, "original": { @@ -97,21 +81,17 @@ "flaky": { "inputs": { "bash-strict-mode": "bash-strict-mode", - "flake-utils": [ - "flake-utils" - ], + "flake-utils": "flake-utils_2", "home-manager": "home-manager", - "nixpkgs": [ - "nixpkgs" - ], + "nixpkgs": "nixpkgs", "project-manager": "project-manager" }, "locked": { - "lastModified": 1704242273, - "narHash": "sha256-rec9StIg9udQpQuodEZlRPSgXKpImBqg5wmdCnzeq1E=", + "lastModified": 1722311199, + "narHash": "sha256-h1kqUV/a5OtIdbq0frNXuKjl7nof+va0wjA+LYyIfLU=", "owner": "sellout", "repo": "flaky", - "rev": "b48abdadd47782b310c9e6efcfcf9d6d99f54442", + "rev": "5ed508e943bccebce2f175d69e1ee9d754d488a2", "type": "github" }, "original": { @@ -128,79 +108,32 @@ ] }, "locked": { - "lastModified": 1703367386, - "narHash": "sha256-FMbm48UGrBfOWGt8+opuS+uLBLQlRfhiYXhHNcYMS5k=", + "lastModified": 1720042825, + "narHash": "sha256-A0vrUB6x82/jvf17qPCpxaM+ulJnD8YZwH9Ci0BsAzE=", "owner": "nix-community", "repo": "home-manager", - "rev": "d5824a76bc6bb93d1dce9ebbbcb09a9b6abcc224", + "rev": "e1391fb22e18a36f57e6999c7a9f966dc80ac073", "type": "github" }, "original": { "owner": "nix-community", - "ref": "release-23.11", + "ref": "release-24.05", "repo": "home-manager", "type": "github" } }, - "lowdown-src": { - "flake": false, - "locked": { - "lastModified": 1633514407, - "narHash": "sha256-Dw32tiMjdK9t3ETl5fzGrutQTzh2rufgZV4A/BbxuD4=", - "owner": "kristapsdz", - "repo": "lowdown", - "rev": "d2c2b44ff6c27b936ec27358a2653caaef8f73b8", - "type": "github" - }, - "original": { - "owner": "kristapsdz", - "repo": "lowdown", - "type": "github" - } - }, - "nix-schema": { - "inputs": { - "flake-compat": "flake-compat", - "flake-schemas": [ - "flaky", - "project-manager", - "flake-schemas" - ], - "lowdown-src": "lowdown-src", - "nixpkgs": [ - "flaky", - "project-manager", - "nixpkgs-23_11" - ], - "nixpkgs-regression": "nixpkgs-regression" - }, - "locked": { - "lastModified": 1697822067, - "narHash": "sha256-7HCcrF6GqIAreKvzt74do1/Urvp+b901Hckf5+WgR9M=", - "owner": "DeterminateSystems", - "repo": "nix", - "rev": "84867fa212fe08feeb27b668c4c78bc9eaf74e17", - "type": "github" - }, - "original": { - "owner": "DeterminateSystems", - "ref": "flake-schemas", - "repo": "nix", - "type": "github" - } - }, "nixpkgs": { "locked": { - "lastModified": 1704420045, - "narHash": "sha256-C36QmoJd5tdQ5R9MC1jM7fBkZW9zBUqbUCsgwS6j4QU=", + "lastModified": 1722272837, + "narHash": "sha256-iHO942tXSkiZ0ZhWkfqCvqo9/67+S6WYfphXSJogEmM=", "owner": "NixOS", "repo": "nixpkgs", - "rev": "c1be43e8e837b8dbee2b3665a007e761680f0c3d", + "rev": "89526a7d969e38fe8c30253170d44d0f131882de", "type": "github" }, "original": { "owner": "NixOS", - "ref": "release-23.11", + "ref": "release-24.05", "repo": "nixpkgs", "type": "github" } @@ -223,11 +156,11 @@ }, "nixpkgs-23_05": { "locked": { - "lastModified": 1703950681, - "narHash": "sha256-veU5bE4eLOmi7aOzhE7LfZXcSOONRMay0BKv01WHojo=", + "lastModified": 1705957679, + "narHash": "sha256-Q8LJaVZGJ9wo33wBafvZSzapYsjOaNjP/pOnSiKVGHY=", "owner": "NixOS", "repo": "nixpkgs", - "rev": "0aad9113182747452dbfc68b93c86e168811fa6c", + "rev": "9a333eaa80901efe01df07eade2c16d183761fa3", "type": "github" }, "original": { @@ -239,11 +172,11 @@ }, "nixpkgs-23_11": { "locked": { - "lastModified": 1703970664, - "narHash": "sha256-S5Y0wm15CMgcOSsChEz8++o4IEXduu+A/e/nztiNXsk=", + "lastModified": 1707146535, + "narHash": "sha256-kEOc+8lvFyGNUh0MzTw0dZ0lizdaYr/Mi7BHDJy0pBI=", "owner": "NixOS", "repo": "nixpkgs", - "rev": "41dda835e2bce1270e837d9b5eaa5f78404aa45e", + "rev": "fc819befe88a0b7737900164cdf8dff3298eb87a", "type": "github" }, "original": { @@ -253,29 +186,29 @@ "type": "github" } }, - "nixpkgs-regression": { + "nixpkgs-24_05": { "locked": { - "lastModified": 1643052045, - "narHash": "sha256-uGJ0VXIhWKGXxkeNnq4TvV3CIOkUJ3PAoLZ3HMzNVMw=", + "lastModified": 1719760069, + "narHash": "sha256-mj4SBEyKTMYggzK3TmTOSfG48kBVimwXO1j7eXCeRsg=", "owner": "NixOS", "repo": "nixpkgs", - "rev": "215d4d0fd80ca5163643b03a33fde804a29cc1e2", + "rev": "36375f0637b14c2dcfc8a233835d05f689ff0c02", "type": "github" }, "original": { "owner": "NixOS", + "ref": "release-24.05", "repo": "nixpkgs", - "rev": "215d4d0fd80ca5163643b03a33fde804a29cc1e2", "type": "github" } }, "nixpkgs-unstable": { "locked": { - "lastModified": 1703499205, - "narHash": "sha256-lF9rK5mSUfIZJgZxC3ge40tp1gmyyOXZ+lRY3P8bfbg=", + "lastModified": 1706925685, + "narHash": "sha256-hVInjWMmgH4yZgA4ZtbgJM1qEAel72SYhP5nOWX4UIM=", "owner": "NixOS", "repo": "nixpkgs", - "rev": "e1fa12d4f6c6fe19ccb59cac54b5b3f25e160870", + "rev": "79a13f1437e149dc7be2d1290c74d378dad60814", "type": "github" }, "original": { @@ -285,6 +218,22 @@ "type": "github" } }, + "nixpkgs_2": { + "locked": { + "lastModified": 1719755592, + "narHash": "sha256-aRElgc4fmNtzn2HKlse4ESGzO7lrTE+8vk/vbVLfu+w=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "8054da3570d226d9c3f343eb28787fb7564841d5", + "type": "github" + }, + "original": { + "owner": "NixOS", + "ref": "release-23.11", + "repo": "nixpkgs", + "type": "github" + } + }, "project-manager": { "inputs": { "bash-strict-mode": [ @@ -299,19 +248,20 @@ "flaky": [ "flaky" ], - "nix-schema": "nix-schema", + "nixpkgs": "nixpkgs_2", "nixpkgs-22_11": "nixpkgs-22_11", "nixpkgs-23_05": "nixpkgs-23_05", "nixpkgs-23_11": "nixpkgs-23_11", + "nixpkgs-24_05": "nixpkgs-24_05", "nixpkgs-unstable": "nixpkgs-unstable", "treefmt-nix": "treefmt-nix" }, "locked": { - "lastModified": 1704008255, - "narHash": "sha256-xpofWpf/2uND3j6VaIWwvcSHINsuLNuD6Az0MR18+aw=", + "lastModified": 1720325242, + "narHash": "sha256-v7wUeUKQANGcmJduHrJKRK7YWBo14Xi6qvQHr79hxqs=", "owner": "sellout", "repo": "project-manager", - "rev": "539a7b9799692fa4481373aedae530ddbc78822b", + "rev": "1d0bc5e49b953e46d219bd13da41fd138e94b2d2", "type": "github" }, "original": { @@ -322,9 +272,15 @@ }, "root": { "inputs": { - "flake-utils": "flake-utils", + "flake-utils": [ + "flaky", + "flake-utils" + ], "flaky": "flaky", - "nixpkgs": "nixpkgs" + "nixpkgs": [ + "flaky", + "nixpkgs" + ] } }, "shellcheck-nix-attributes": { @@ -378,15 +334,15 @@ "nixpkgs": [ "flaky", "project-manager", - "nixpkgs-23_11" + "nixpkgs" ] }, "locked": { - "lastModified": 1702979157, - "narHash": "sha256-RnFBbLbpqtn4AoJGXKevQMCGhra4h6G2MPcuTSZZQ+g=", + "lastModified": 1706462057, + "narHash": "sha256-7dG1D4iqqt0bEbBqUWk6lZiSqqwwAO0Hd1L5opVyhNM=", "owner": "numtide", "repo": "treefmt-nix", - "rev": "2961375283668d867e64129c22af532de8e77734", + "rev": "c6153c2a3ff4c38d231e3ae99af29b87f1df5901", "type": "github" }, "original": { diff --git a/flake.nix b/flake.nix index d34c435..17f0b23 100644 --- a/flake.nix +++ b/flake.nix @@ -10,7 +10,7 @@ ]; ## Isolate the build. registries = false; - sandbox = false; + sandbox = "relaxed"; }; outputs = { @@ -39,8 +39,7 @@ }; overlays = { - default = - flaky.lib.elisp.overlays.default self.overlays.emacs; + default = flaky.lib.elisp.overlays.default self.overlays.emacs; emacs = final: prev: efinal: eprev: { "${pname}" = self.packages.${final.system}.${ename}; @@ -50,20 +49,15 @@ homeConfigurations = builtins.listToAttrs (builtins.map - (flaky.lib.homeConfigurations.example - pname - self - [ - ({pkgs, ...}: { - programs.emacs = { - enable = true; - extraConfig = '' - (require '${pname}) - ''; - extraPackages = epkgs: [epkgs.${pname}]; - }; - }) - ]) + (flaky.lib.homeConfigurations.example self [ + ({pkgs, ...}: { + programs.emacs = { + enable = true; + extraConfig = "(require '${pname})"; + extraPackages = epkgs: [epkgs.${pname}]; + }; + }) + ]) supportedSystems); } // flake-utils.lib.eachSystem supportedSystems (system: let @@ -80,12 +74,13 @@ flaky.lib.elisp.package pkgs src pname (epkgs: [epkgs.buttercup]); }; - devShells.default = - flaky.lib.devShells.default system self [] ""; - projectConfigurations = flaky.lib.projectConfigurations.default {inherit pkgs self;}; + devShells = + self.projectConfigurations.${system}.devShells + // {default = flaky.lib.devShells.default system self [] "";}; + checks = self.projectConfigurations.${system}.checks // { @@ -97,16 +92,10 @@ }); inputs = { - flake-utils.url = "github:numtide/flake-utils"; - - flaky = { - inputs = { - flake-utils.follows = "flake-utils"; - nixpkgs.follows = "nixpkgs"; - }; - url = "github:sellout/flaky"; - }; + ## Flaky should generally be the source of truth for its inputs. + flaky.url = "github:sellout/flaky"; - nixpkgs.url = "github:NixOS/nixpkgs/release-23.11"; + flake-utils.follows = "flaky/flake-utils"; + nixpkgs.follows = "flaky/nixpkgs"; }; } diff --git a/garnix.yaml b/garnix.yaml index a78abd0..03e81c5 100644 --- a/garnix.yaml +++ b/garnix.yaml @@ -1,2 +1,2 @@ # This file was generated by Project Manager. -{"builds":{"exclude":["*.x86_64-darwin","*.x86_64-darwin.*","homeConfigurations.x86_64-darwin-elisp-reader-example","checks.*.project-manager-files","checks.*.vale","devShells.*.lax-checks"],"include":["*.*","*.*.*"]}} \ No newline at end of file +{"builds":{"exclude":["*.x86_64-darwin","*.x86_64-darwin.*","homeConfigurations.x86_64-darwin-example","devShells.*.lax-checks"],"include":["*.*","*.*.*"]}} \ No newline at end of file From e080b9178bc58e7c7cbd6079040b63b34e91b046 Mon Sep 17 00:00:00 2001 From: Greg Pfeil Date: Fri, 2 Aug 2024 10:58:04 -0600 Subject: [PATCH 07/11] Update Flaky input Eliminates a warning. --- flake.lock | 130 +++++++++++++++++------------------------------------ 1 file changed, 40 insertions(+), 90 deletions(-) diff --git a/flake.lock b/flake.lock index 0cbdfdf..4e68596 100644 --- a/flake.lock +++ b/flake.lock @@ -2,22 +2,29 @@ "nodes": { "bash-strict-mode": { "inputs": { - "flake-utils": "flake-utils", + "flake-utils": [ + "flaky", + "bash-strict-mode", + "flaky", + "flake-utils" + ], "flaky": [ "flaky" ], "nixpkgs": [ + "flaky", + "bash-strict-mode", "flaky", "nixpkgs" ], "shellcheck-nix-attributes": "shellcheck-nix-attributes" }, "locked": { - "lastModified": 1716172543, - "narHash": "sha256-Elk8ehgfszNASACwvNE5lY11rfukRnEjJHYhG6TwkT0=", + "lastModified": 1722346313, + "narHash": "sha256-qxIzt/0BCP9LlVE1Lze/2qlM5eZ8X5hQk4E6ghiBF5w=", "owner": "sellout", "repo": "bash-strict-mode", - "rev": "759ea338835512493fbca483309375b9a4f29e13", + "rev": "098ffd0f072b3b7b3e84d9c524d18d6c62f64a47", "type": "github" }, "original": { @@ -60,38 +67,20 @@ "type": "github" } }, - "flake-utils_2": { - "inputs": { - "systems": "systems_2" - }, - "locked": { - "lastModified": 1710146030, - "narHash": "sha256-SZ5L6eA7HJ/nmkzGG7/ISclqe6oZdOZTNoesiInkXPQ=", - "owner": "numtide", - "repo": "flake-utils", - "rev": "b1d9ab70662946ef0850d488da1c9019f3a9752a", - "type": "github" - }, - "original": { - "owner": "numtide", - "repo": "flake-utils", - "type": "github" - } - }, "flaky": { "inputs": { "bash-strict-mode": "bash-strict-mode", - "flake-utils": "flake-utils_2", + "flake-utils": "flake-utils", "home-manager": "home-manager", "nixpkgs": "nixpkgs", "project-manager": "project-manager" }, "locked": { - "lastModified": 1722311199, - "narHash": "sha256-h1kqUV/a5OtIdbq0frNXuKjl7nof+va0wjA+LYyIfLU=", + "lastModified": 1725344932, + "narHash": "sha256-+EBOz433escMeFWOyEB9PIpp30wSv/IgLN0exjK1l3E=", "owner": "sellout", "repo": "flaky", - "rev": "5ed508e943bccebce2f175d69e1ee9d754d488a2", + "rev": "48d839a08583a531d8e62420f3a37facb84563a3", "type": "github" }, "original": { @@ -124,11 +113,11 @@ }, "nixpkgs": { "locked": { - "lastModified": 1722272837, - "narHash": "sha256-iHO942tXSkiZ0ZhWkfqCvqo9/67+S6WYfphXSJogEmM=", + "lastModified": 1724013388, + "narHash": "sha256-vAq+I0IWsIDq5RUc01t25iL46LLxdsmlTJ96A30bMEY=", "owner": "NixOS", "repo": "nixpkgs", - "rev": "89526a7d969e38fe8c30253170d44d0f131882de", + "rev": "3f38e71a8e23a27569acbbfee0e83b76c86fa569", "type": "github" }, "original": { @@ -172,11 +161,11 @@ }, "nixpkgs-23_11": { "locked": { - "lastModified": 1707146535, - "narHash": "sha256-kEOc+8lvFyGNUh0MzTw0dZ0lizdaYr/Mi7BHDJy0pBI=", + "lastModified": 1720535198, + "narHash": "sha256-zwVvxrdIzralnSbcpghA92tWu2DV2lwv89xZc8MTrbg=", "owner": "NixOS", "repo": "nixpkgs", - "rev": "fc819befe88a0b7737900164cdf8dff3298eb87a", + "rev": "205fd4226592cc83fd4c0885a3e4c9c400efabb5", "type": "github" }, "original": { @@ -186,29 +175,13 @@ "type": "github" } }, - "nixpkgs-24_05": { - "locked": { - "lastModified": 1719760069, - "narHash": "sha256-mj4SBEyKTMYggzK3TmTOSfG48kBVimwXO1j7eXCeRsg=", - "owner": "NixOS", - "repo": "nixpkgs", - "rev": "36375f0637b14c2dcfc8a233835d05f689ff0c02", - "type": "github" - }, - "original": { - "owner": "NixOS", - "ref": "release-24.05", - "repo": "nixpkgs", - "type": "github" - } - }, "nixpkgs-unstable": { "locked": { - "lastModified": 1706925685, - "narHash": "sha256-hVInjWMmgH4yZgA4ZtbgJM1qEAel72SYhP5nOWX4UIM=", + "lastModified": 1722141560, + "narHash": "sha256-Ul3rIdesWaiW56PS/Ak3UlJdkwBrD4UcagCmXZR9Z7Y=", "owner": "NixOS", "repo": "nixpkgs", - "rev": "79a13f1437e149dc7be2d1290c74d378dad60814", + "rev": "038fb464fcfa79b4f08131b07f2d8c9a6bcc4160", "type": "github" }, "original": { @@ -218,50 +191,42 @@ "type": "github" } }, - "nixpkgs_2": { - "locked": { - "lastModified": 1719755592, - "narHash": "sha256-aRElgc4fmNtzn2HKlse4ESGzO7lrTE+8vk/vbVLfu+w=", - "owner": "NixOS", - "repo": "nixpkgs", - "rev": "8054da3570d226d9c3f343eb28787fb7564841d5", - "type": "github" - }, - "original": { - "owner": "NixOS", - "ref": "release-23.11", - "repo": "nixpkgs", - "type": "github" - } - }, "project-manager": { "inputs": { "bash-strict-mode": [ + "flaky", + "project-manager", "flaky", "bash-strict-mode" ], "flake-schemas": "flake-schemas", "flake-utils": [ + "flaky", + "project-manager", "flaky", "flake-utils" ], "flaky": [ "flaky" ], - "nixpkgs": "nixpkgs_2", + "nixpkgs": [ + "flaky", + "project-manager", + "flaky", + "nixpkgs" + ], "nixpkgs-22_11": "nixpkgs-22_11", "nixpkgs-23_05": "nixpkgs-23_05", "nixpkgs-23_11": "nixpkgs-23_11", - "nixpkgs-24_05": "nixpkgs-24_05", "nixpkgs-unstable": "nixpkgs-unstable", "treefmt-nix": "treefmt-nix" }, "locked": { - "lastModified": 1720325242, - "narHash": "sha256-v7wUeUKQANGcmJduHrJKRK7YWBo14Xi6qvQHr79hxqs=", + "lastModified": 1723360458, + "narHash": "sha256-l+junhIWTsYvVVFp/0YYfFPmTxODWJ2IoHesIvly4FQ=", "owner": "sellout", "repo": "project-manager", - "rev": "1d0bc5e49b953e46d219bd13da41fd138e94b2d2", + "rev": "342359f930e23ff26a6ccdace93089f4a7fff00c", "type": "github" }, "original": { @@ -314,21 +279,6 @@ "type": "github" } }, - "systems_2": { - "locked": { - "lastModified": 1681028828, - "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", - "owner": "nix-systems", - "repo": "default", - "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", - "type": "github" - }, - "original": { - "owner": "nix-systems", - "repo": "default", - "type": "github" - } - }, "treefmt-nix": { "inputs": { "nixpkgs": [ @@ -338,11 +288,11 @@ ] }, "locked": { - "lastModified": 1706462057, - "narHash": "sha256-7dG1D4iqqt0bEbBqUWk6lZiSqqwwAO0Hd1L5opVyhNM=", + "lastModified": 1722330636, + "narHash": "sha256-uru7JzOa33YlSRwf9sfXpJG+UAV+bnBEYMjrzKrQZFw=", "owner": "numtide", "repo": "treefmt-nix", - "rev": "c6153c2a3ff4c38d231e3ae99af29b87f1df5901", + "rev": "768acdb06968e53aa1ee8de207fd955335c754b7", "type": "github" }, "original": { From 61ae627fbc1ada19701baf273fd2b0f77b8cbdca Mon Sep 17 00:00:00 2001 From: Greg Pfeil Date: Fri, 2 Aug 2024 10:59:02 -0600 Subject: [PATCH 08/11] Add `er-*orig-read-from-string*` To parallel `er-*orig-read*` and use in tests. --- elisp-reader.el | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/elisp-reader.el b/elisp-reader.el index 3edd308..643c4d9 100644 --- a/elisp-reader.el +++ b/elisp-reader.el @@ -138,6 +138,10 @@ "Remember the original `read' function. We'll have to use it in some situations that can't be handled from Lisp code.") +(defvar er-*orig-read-from-string* (symbol-function #'read-from-string) + "Remember the original `read' function. +We'll have to use it in some situations that can't be handled from Lisp code.") + (defvar er-*macro-chars* (make-hash-table :test 'eq) "Custom read functions. A hash that maps character to a function of two arguments, stream (as a From c4fa87e342b9534ac58b9be5cca18bbe0b797c1d Mon Sep 17 00:00:00 2001 From: Greg Pfeil Date: Fri, 2 Aug 2024 10:59:35 -0600 Subject: [PATCH 09/11] Add a test suite --- elisp-reader-tests.el | 63 +++++++++++++++++++++++++++++++++++++++++++ flake.nix | 5 +++- 2 files changed, 67 insertions(+), 1 deletion(-) create mode 100644 elisp-reader-tests.el diff --git a/elisp-reader-tests.el b/elisp-reader-tests.el new file mode 100644 index 0000000..9f87d86 --- /dev/null +++ b/elisp-reader-tests.el @@ -0,0 +1,63 @@ +;;; elisp-reader-tests.el --- Tests elisp-reader -*- lexical-binding: t -*- + +;;; Commentary + +;;; Code: + +(require 'buttercup) +(require 'cl-lib) +(require 'elisp-reader) + +(defun bc--if-result (result consequent alternative) + "Call the appropriate function depending on the success of RESULT. +If RESULT is a cons, it passes the message to CONSEQUENT or ALTERNATIVE. +Otherwise it passes nil." + (declare (indent defun)) + (if (consp result) + (funcall (if (car result) consequent alternative) (cdr result)) + (funcall (if result consequent alternative) nil))) + + +(buttercup-define-matcher :read-results-to-be (string function &rest args) + "Reads the provided STRING with both our reader and Emacs’ reader, comparing +the results with the provided FUNCTION." + (cl-destructuring-bind ((str-expr . str) (fn-expr . fn)) + (mapcar #'buttercup--expr-and-value (list string function)) + (cl-destructuring-bind ((our-result . our-pos) (orig-result . orig-pos)) + (list (er-read-from-string str) (funcall er-*orig-read-from-string* str)) + (let ((result (apply fn (append args (list our-result orig-result))))) + (bc--if-result + (cons result + (if result + "results should have differed" + (format "Expected %S to read %S, but ours resulted in %S, while the original was %S" + str-expr + fn-expr + our-result + orig-result))) + (lambda (msg) + (let ((pos-result (eql our-pos orig-pos))) + (cons pos-result + (if pos-result + (format "Either %S or the reads should have ended at different positions (but both ended at %S)." + (or msg "results should have not matched") + our-pos) + (format "Results matched, but the reads ended at different positions: ours at %S and the original at %S." + our-pos + orig-pos))))) + (lambda (msg) (when msg (cons nil msg)))))))) + +(describe "elisp-reader" + (describe "reading" + (it "reads strings" (expect "\"xyz\"" :read-results-to-be #'equal)) + (it "reads characters" (expect "?a" :read-results-to-be #'eql)) + (it "reads integers" (expect "123" :read-results-to-be #'eql)) + (it "reads symbols" (expect "foo" :read-results-to-be #'eq)) + (it "reads lists" (expect "(a b c)" :read-results-to-be #'equal)) + (it "skips comments" (expect ";; test comment\nq" :read-results-to-be #'eql)) + (it "reads quotes" (expect "'(a b c)" :read-results-to-be #'equal)) + (it "reads vectors" (expect "[x y z]" :read-results-to-be #'equal)) + (it "reads quasi-quotes" (expect "`(,(car '(x y z)))" :read-results-to-be #'equal)))) + +(provide 'elisp-reader-tests) +;;; elisp-reader-tests.el ends here diff --git a/flake.nix b/flake.nix index 17f0b23..88edf02 100644 --- a/flake.nix +++ b/flake.nix @@ -63,7 +63,10 @@ // flake-utils.lib.eachSystem supportedSystems (system: let pkgs = import nixpkgs { inherit system; - overlays = [flaky.overlays.elisp-dependencies]; + overlays = [ + flaky.overlays.dependencies + flaky.overlays.elisp-dependencies + ]; }; src = pkgs.lib.cleanSource ./.; From 90c55a863d0bf9b988ec96573b005732c67a78db Mon Sep 17 00:00:00 2001 From: Greg Pfeil Date: Sat, 9 Nov 2024 11:01:08 -0700 Subject: [PATCH 10/11] Sync Flaky template --- .cache/vale/Vocab/elisp-reader/accept.txt | 1 + .../vocabularies/elisp-reader/accept.txt | 1 + .config/project/default.nix | 55 +------- .github/settings.yml | 2 +- .github/workflows/flakehub-publish.yml | 2 +- flake.lock | 117 ++++++++++++------ flake.nix | 26 ++-- garnix.yaml | 2 +- 8 files changed, 98 insertions(+), 108 deletions(-) diff --git a/.cache/vale/Vocab/elisp-reader/accept.txt b/.cache/vale/Vocab/elisp-reader/accept.txt index b0bbe0d..64a9e10 100644 --- a/.cache/vale/Vocab/elisp-reader/accept.txt +++ b/.cache/vale/Vocab/elisp-reader/accept.txt @@ -1,4 +1,5 @@ direnv +formatter garnix [Nn]ix Pfeil diff --git a/.cache/vale/config/vocabularies/elisp-reader/accept.txt b/.cache/vale/config/vocabularies/elisp-reader/accept.txt index b0bbe0d..64a9e10 100644 --- a/.cache/vale/config/vocabularies/elisp-reader/accept.txt +++ b/.cache/vale/config/vocabularies/elisp-reader/accept.txt @@ -1,4 +1,5 @@ direnv +formatter garnix [Nn]ix Pfeil diff --git a/.config/project/default.nix b/.config/project/default.nix index 195fedc..2f35bc0 100644 --- a/.config/project/default.nix +++ b/.config/project/default.nix @@ -16,66 +16,19 @@ ## development programs = { direnv.enable = true; - # This should default by whether there is a .git file/dir (and whether it’s - # a file (worktree) or dir determines other things – like where hooks - # are installed. - git = { - enable = true; - ignores = [ - # Compiled - "*.elc" - # Packaging - "/.eldev" - ]; - }; + git.enable = true; }; ## formatting editorconfig.enable = true; - ## See the file for why this needs to force a different version. project.file.".dir-locals.el".source = lib.mkForce ../emacs/.dir-locals.el; programs = { - treefmt = { - enable = true; - ## In elisp repos, we prefer Org over Markdown, so we don’t need this - ## formatter. - programs.prettier.enable = lib.mkForce false; - }; - vale = { - enable = true; - excludes = [ - "*.el" - "./.github/settings.yml" - "./Eldev" - ]; - vocab.${config.project.name}.accept = [ - "Eldev" - ]; - }; + treefmt.enable = true; + vale.enable = true; }; ## CI - services.garnix = { - enable = true; - ## TODO: Remove once garnix-io/garnix#285 is fixed. - builds.exclude = ["homeConfigurations.x86_64-darwin-example"]; - }; - ## FIXME: Shouldn’t need `mkForce` here (or to duplicate the base contexts). - ## Need to improve module merging. - services.github.settings.branches.main.protection.required_status_checks.contexts = - lib.mkForce - (flaky.lib.forGarnixSystems supportedSystems (sys: [ - "check elisp-doctor [${sys}]" - "check elisp-lint [${sys}]" - "homeConfig ${sys}-example" - "package default [${sys}]" - "package emacs-${config.project.name} [${sys}]" - ## FIXME: These are duplicated from the base config - "check formatter [${sys}]" - "check project-manager-files [${sys}]" - "check vale [${sys}]" - "devShell default [${sys}]" - ])); + services.garnix.enable = true; ## publishing services.flakehub.enable = true; diff --git a/.github/settings.yml b/.github/settings.yml index cd8c566..d60d4bc 100644 --- a/.github/settings.yml +++ b/.github/settings.yml @@ -1,2 +1,2 @@ # This file was generated by Project Manager. -{"actions":{"permissions":{"workflow":{"can_approve_pull_request_reviews":true}}},"branches":[{"name":"main","protection":{"allow_force_pushes":false,"enforce_admins":true,"required_linear_history":false,"required_pull_request_reviews":null,"required_status_checks":{"contexts":["check elisp-doctor [aarch64-darwin]","check elisp-lint [aarch64-darwin]","homeConfig aarch64-darwin-example","package default [aarch64-darwin]","package emacs-elisp-reader [aarch64-darwin]","check formatter [aarch64-darwin]","check project-manager-files [aarch64-darwin]","check vale [aarch64-darwin]","devShell default [aarch64-darwin]","check elisp-doctor [aarch64-linux]","check elisp-lint [aarch64-linux]","homeConfig aarch64-linux-example","package default [aarch64-linux]","package emacs-elisp-reader [aarch64-linux]","check formatter [aarch64-linux]","check project-manager-files [aarch64-linux]","check vale [aarch64-linux]","devShell default [aarch64-linux]","check elisp-doctor [x86_64-linux]","check elisp-lint [x86_64-linux]","homeConfig x86_64-linux-example","package default [x86_64-linux]","package emacs-elisp-reader [x86_64-linux]","check formatter [x86_64-linux]","check project-manager-files [x86_64-linux]","check vale [x86_64-linux]","devShell default [x86_64-linux]","check elisp-doctor [i686-linux]","check elisp-lint [i686-linux]","homeConfig i686-linux-example","package default [i686-linux]","package emacs-elisp-reader [i686-linux]","check formatter [i686-linux]","check project-manager-files [i686-linux]","check vale [i686-linux]","devShell default [i686-linux]"],"strict":false},"restrictions":null}}],"labels":[{"color":"","description":"Created automatically by some service or process","name":"automated"},{"color":"#d73a4a","description":"Something isn’t working","name":"bug"},{"color":"#333333","description":"Updates or other changes to dependencies","name":"dependencies"},{"color":"#0075ca","description":"Improvements or additions to documentation","name":"documentation"},{"color":"#a2eeef","description":"New feature or request","name":"enhancement"},{"color":"#7057ff","description":"Good for newcomers","name":"good first issue"},{"color":"#000000","description":"Issues you want contributors to help with.","name":"hacktoberfest"},{"color":"#ff7518","description":"Indicates acceptance for Hacktoberfest criteria, even if not merged yet.","name":"hacktoberfest-accepted"},{"color":"#008672","description":"Extra attention is needed","name":"help wanted"},{"color":"#333333","description":"Unaccepted contributions that haven’t been closed for some reason.","name":"invalid"},{"color":"#d876e3","description":"Further information is requested","name":"question"},{"color":"#ffc0cb","description":"Topic created in bad faith. Services like Hacktoberfest use this to identify bad actors.","name":"spam"},{"color":"#d4af37","description":"Work prioritized by a sponsor","name":"sponsored"}],"repository":{"allow_merge_commit":true,"allow_rebase_merge":false,"allow_squash_merge":false,"default_branch":"main","delete_branch_on_merge":true,"description":"A custom Lisp reader written in Elisp","enable_automated_security_fixes":true,"enable_vulnerability_alerts":true,"has_downloads":false,"has_issues":true,"has_projects":true,"has_wiki":true,"merge_commit_message":"PR_BODY","merge_commit_title":"PR_TITLE","name":"elisp-reader","private":false,"topics":"hacktoberfest"}} \ No newline at end of file +{"actions":{"permissions":{"workflow":{"can_approve_pull_request_reviews":true}}},"branches":[{"name":"main","protection":{"allow_force_pushes":false,"enforce_admins":true,"required_linear_history":false,"required_pull_request_reviews":null,"required_status_checks":{"contexts":["All Garnix checks"],"strict":false},"restrictions":null}}],"labels":[{"color":"","description":"Created automatically by some service or process","name":"automated"},{"color":"#d73a4a","description":"Something isn’t working","name":"bug"},{"color":"#333333","description":"Updates or other changes to dependencies","name":"dependencies"},{"color":"#0075ca","description":"Improvements or additions to documentation","name":"documentation"},{"color":"#a2eeef","description":"New feature or request","name":"enhancement"},{"color":"#7057ff","description":"Good for newcomers","name":"good first issue"},{"color":"#000000","description":"Issues you want contributors to help with.","name":"hacktoberfest"},{"color":"#ff7518","description":"Indicates acceptance for Hacktoberfest criteria, even if not merged yet.","name":"hacktoberfest-accepted"},{"color":"#008672","description":"Extra attention is needed","name":"help wanted"},{"color":"#333333","description":"Unaccepted contributions that haven’t been closed for some reason.","name":"invalid"},{"color":"#d876e3","description":"Further information is requested","name":"question"},{"color":"#ffc0cb","description":"Topic created in bad faith. Services like Hacktoberfest use this to identify bad actors.","name":"spam"},{"color":"#d4af37","description":"Work prioritized by a sponsor","name":"sponsored"}],"repository":{"allow_merge_commit":true,"allow_rebase_merge":false,"allow_squash_merge":false,"default_branch":"main","delete_branch_on_merge":true,"description":"A custom Lisp reader written in Elisp","enable_automated_security_fixes":true,"enable_vulnerability_alerts":true,"has_downloads":false,"has_issues":true,"has_projects":true,"has_wiki":true,"merge_commit_message":"PR_BODY","merge_commit_title":"PR_TITLE","name":"elisp-reader","private":false,"topics":"hacktoberfest"}} \ No newline at end of file diff --git a/.github/workflows/flakehub-publish.yml b/.github/workflows/flakehub-publish.yml index 49cf3f7..4d36baa 100644 --- a/.github/workflows/flakehub-publish.yml +++ b/.github/workflows/flakehub-publish.yml @@ -11,7 +11,7 @@ on: required: true jobs: flakehub-publish: - runs-on: "ubuntu-latest" + runs-on: "ubuntu-24.04" permissions: id-token: "write" contents: "read" diff --git a/flake.lock b/flake.lock index 4e68596..fc98dbc 100644 --- a/flake.lock +++ b/flake.lock @@ -17,18 +17,25 @@ "flaky", "nixpkgs" ], - "shellcheck-nix-attributes": "shellcheck-nix-attributes" + "shellcheck-nix-attributes": "shellcheck-nix-attributes", + "systems": [ + "flaky", + "bash-strict-mode", + "flaky", + "systems" + ] }, "locked": { - "lastModified": 1722346313, - "narHash": "sha256-qxIzt/0BCP9LlVE1Lze/2qlM5eZ8X5hQk4E6ghiBF5w=", + "lastModified": 1730995892, + "narHash": "sha256-hw5E8zDZJsL2hiRy1zzHEU38wP9aiXJAvMZmB8hVP+w=", "owner": "sellout", "repo": "bash-strict-mode", - "rev": "098ffd0f072b3b7b3e84d9c524d18d6c62f64a47", + "rev": "581d0dcb33b428a87185033f251bba5ad879f4fe", "type": "github" }, "original": { "owner": "sellout", + "ref": "adopt-pkgsLib", "repo": "bash-strict-mode", "type": "github" } @@ -51,14 +58,17 @@ }, "flake-utils": { "inputs": { - "systems": "systems" + "systems": [ + "flaky", + "systems" + ] }, "locked": { - "lastModified": 1710146030, - "narHash": "sha256-SZ5L6eA7HJ/nmkzGG7/ISclqe6oZdOZTNoesiInkXPQ=", + "lastModified": 1726560853, + "narHash": "sha256-X6rJYSESBVr3hBoH0WbKE5KvhPU5bloyZ2L4K60/fPQ=", "owner": "numtide", "repo": "flake-utils", - "rev": "b1d9ab70662946ef0850d488da1c9019f3a9752a", + "rev": "c1dfcf08411b08f6b8615f7d8971a2bfa81d5e8a", "type": "github" }, "original": { @@ -71,16 +81,23 @@ "inputs": { "bash-strict-mode": "bash-strict-mode", "flake-utils": "flake-utils", + "garnix-systems": "garnix-systems", "home-manager": "home-manager", "nixpkgs": "nixpkgs", - "project-manager": "project-manager" + "nixpkgs-unstable": [ + "flaky", + "project-manager", + "nixpkgs-unstable" + ], + "project-manager": "project-manager", + "systems": "systems" }, "locked": { - "lastModified": 1725344932, - "narHash": "sha256-+EBOz433escMeFWOyEB9PIpp30wSv/IgLN0exjK1l3E=", + "lastModified": 1731043955, + "narHash": "sha256-2T1YPXVfJQ0ZAsIirC5oqLxrGZfNztPZOUHrwADEZO4=", "owner": "sellout", "repo": "flaky", - "rev": "48d839a08583a531d8e62420f3a37facb84563a3", + "rev": "aa3a4afca3ed7a588b96b4b45dc31e2c78fbe48c", "type": "github" }, "original": { @@ -89,6 +106,21 @@ "type": "github" } }, + "garnix-systems": { + "locked": { + "lastModified": 1723225755, + "narHash": "sha256-y17fVgb4LJheN4VDsHCmZRHrOJwKj8oUPvXk2FqUOnI=", + "owner": "garnix-io", + "repo": "nix-systems", + "rev": "c2466c5c1d3591933b4389868902e2f47a47fadb", + "type": "github" + }, + "original": { + "owner": "garnix-io", + "repo": "nix-systems", + "type": "github" + } + }, "home-manager": { "inputs": { "nixpkgs": [ @@ -97,11 +129,11 @@ ] }, "locked": { - "lastModified": 1720042825, - "narHash": "sha256-A0vrUB6x82/jvf17qPCpxaM+ulJnD8YZwH9Ci0BsAzE=", + "lastModified": 1726989464, + "narHash": "sha256-Vl+WVTJwutXkimwGprnEtXc/s/s8sMuXzqXaspIGlwM=", "owner": "nix-community", "repo": "home-manager", - "rev": "e1391fb22e18a36f57e6999c7a9f966dc80ac073", + "rev": "2f23fa308a7c067e52dfcc30a0758f47043ec176", "type": "github" }, "original": { @@ -113,11 +145,11 @@ }, "nixpkgs": { "locked": { - "lastModified": 1724013388, - "narHash": "sha256-vAq+I0IWsIDq5RUc01t25iL46LLxdsmlTJ96A30bMEY=", + "lastModified": 1730940508, + "narHash": "sha256-sXS72AYXN/V1Ehp82/46Rqjw5Q6ayCy28ku3980+LSM=", "owner": "NixOS", "repo": "nixpkgs", - "rev": "3f38e71a8e23a27569acbbfee0e83b76c86fa569", + "rev": "f39f1d2a8fe191e442ce641a6dc1320f6aa17d04", "type": "github" }, "original": { @@ -177,11 +209,11 @@ }, "nixpkgs-unstable": { "locked": { - "lastModified": 1722141560, - "narHash": "sha256-Ul3rIdesWaiW56PS/Ak3UlJdkwBrD4UcagCmXZR9Z7Y=", + "lastModified": 1729265718, + "narHash": "sha256-4HQI+6LsO3kpWTYuVGIzhJs1cetFcwT7quWCk/6rqeo=", "owner": "NixOS", "repo": "nixpkgs", - "rev": "038fb464fcfa79b4f08131b07f2d8c9a6bcc4160", + "rev": "ccc0c2126893dd20963580b6478d1a10a4512185", "type": "github" }, "original": { @@ -193,12 +225,6 @@ }, "project-manager": { "inputs": { - "bash-strict-mode": [ - "flaky", - "project-manager", - "flaky", - "bash-strict-mode" - ], "flake-schemas": "flake-schemas", "flake-utils": [ "flaky", @@ -219,18 +245,25 @@ "nixpkgs-23_05": "nixpkgs-23_05", "nixpkgs-23_11": "nixpkgs-23_11", "nixpkgs-unstable": "nixpkgs-unstable", + "systems": [ + "flaky", + "project-manager", + "flaky", + "systems" + ], "treefmt-nix": "treefmt-nix" }, "locked": { - "lastModified": 1723360458, - "narHash": "sha256-l+junhIWTsYvVVFp/0YYfFPmTxODWJ2IoHesIvly4FQ=", + "lastModified": 1731033565, + "narHash": "sha256-5ffNXqJbkIv1xXvurctY5fRuH/5yswNdol2mqyj1F9U=", "owner": "sellout", "repo": "project-manager", - "rev": "342359f930e23ff26a6ccdace93089f4a7fff00c", + "rev": "6018e54be1f63044bb63b8d8b9bc1790b9d0ae8a", "type": "github" }, "original": { "owner": "sellout", + "ref": "modular-lib", "repo": "project-manager", "type": "github" } @@ -245,6 +278,10 @@ "nixpkgs": [ "flaky", "nixpkgs" + ], + "systems": [ + "flaky", + "systems" ] } }, @@ -266,16 +303,16 @@ }, "systems": { "locked": { - "lastModified": 1681028828, - "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", - "owner": "nix-systems", - "repo": "default", - "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", + "lastModified": 1726558681, + "narHash": "sha256-vta8mxLa5XxpHfb9HCiavFqBrX2xJDvZiKHZOy4kvlA=", + "owner": "sellout", + "repo": "nix-systems", + "rev": "aa9520a9a0f92098d3576c3b4eafcb32c13d6800", "type": "github" }, "original": { - "owner": "nix-systems", - "repo": "default", + "owner": "sellout", + "repo": "nix-systems", "type": "github" } }, @@ -288,11 +325,11 @@ ] }, "locked": { - "lastModified": 1722330636, - "narHash": "sha256-uru7JzOa33YlSRwf9sfXpJG+UAV+bnBEYMjrzKrQZFw=", + "lastModified": 1729242555, + "narHash": "sha256-6jWSWxv2crIXmYSEb3LEVsFkCkyVHNllk61X4uhqfCs=", "owner": "numtide", "repo": "treefmt-nix", - "rev": "768acdb06968e53aa1ee8de207fd955335c754b7", + "rev": "d986489c1c757f6921a48c1439f19bfb9b8ecab5", "type": "github" }, "original": { diff --git a/flake.nix b/flake.nix index 88edf02..b4f8d48 100644 --- a/flake.nix +++ b/flake.nix @@ -9,8 +9,8 @@ "cache.garnix.io:CTFPyKSLcx5RMJKfLo5EEPUObbA78b0YQ2DTCJXqr9g=" ]; ## Isolate the build. - registries = false; sandbox = "relaxed"; + use-registries = false; }; outputs = { @@ -18,11 +18,12 @@ flaky, nixpkgs, self, + systems, }: let pname = "elisp-reader"; ename = "emacs-${pname}"; - supportedSystems = flaky.lib.defaultSystems; + supportedSystems = import systems; in { schemas = { @@ -61,24 +62,20 @@ supportedSystems); } // flake-utils.lib.eachSystem supportedSystems (system: let - pkgs = import nixpkgs { - inherit system; - overlays = [ - flaky.overlays.dependencies - flaky.overlays.elisp-dependencies - ]; - }; + pkgs = nixpkgs.legacyPackages.${system}.appendOverlays [ + flaky.overlays.default + flaky.overlays.elisp-dependencies + ]; src = pkgs.lib.cleanSource ./.; in { packages = { default = self.packages.${system}.${ename}; - "${ename}" = - flaky.lib.elisp.package pkgs src pname (epkgs: [epkgs.buttercup]); + "${ename}" = pkgs.elisp.package pname src (epkgs: [epkgs.buttercup]); }; projectConfigurations = - flaky.lib.projectConfigurations.default {inherit pkgs self;}; + flaky.lib.projectConfigurations.emacs-lisp {inherit pkgs self;}; devShells = self.projectConfigurations.${system}.devShells @@ -87,8 +84,8 @@ checks = self.projectConfigurations.${system}.checks // { - elisp-doctor = flaky.lib.elisp.checks.doctor pkgs src; - elisp-lint = flaky.lib.elisp.checks.lint pkgs src (_: []); + elisp-doctor = pkgs.elisp.checks.doctor src; + elisp-lint = pkgs.elisp.checks.lint src (_: []); }; formatter = self.projectConfigurations.${system}.formatter; @@ -100,5 +97,6 @@ flake-utils.follows = "flaky/flake-utils"; nixpkgs.follows = "flaky/nixpkgs"; + systems.follows = "flaky/systems"; }; } diff --git a/garnix.yaml b/garnix.yaml index 03e81c5..1c60140 100644 --- a/garnix.yaml +++ b/garnix.yaml @@ -1,2 +1,2 @@ # This file was generated by Project Manager. -{"builds":{"exclude":["*.x86_64-darwin","*.x86_64-darwin.*","homeConfigurations.x86_64-darwin-example","devShells.*.lax-checks"],"include":["*.*","*.*.*"]}} \ No newline at end of file +{"builds":[{"exclude":["devShells.*.lax-checks","*.x86_64-darwin","*.x86_64-darwin.*","*.x86_64-darwin-example"],"include":["*.*","*.*.*"]}],"servers":[]} \ No newline at end of file From 025b07eb2c14bd40bcc3489bceba4547ff40914e Mon Sep 17 00:00:00 2001 From: Greg Pfeil Date: Tue, 21 Jan 2025 23:40:10 -0700 Subject: [PATCH 11/11] Update to latest Flaky This bumps to Nixpkgs 24.11, among other things. --- .github/renovate.json | 2 +- Eldev | 1 + flake.lock | 76 ++++++++++++++++++++++++------------------- 3 files changed, 45 insertions(+), 34 deletions(-) diff --git a/.github/renovate.json b/.github/renovate.json index 6c7953d..ea32cb0 100644 --- a/.github/renovate.json +++ b/.github/renovate.json @@ -1 +1 @@ -{"$schema":"https://docs.renovatebot.com/renovate-schema.json","extends":["config:base"],"lockFileMaintenance":{"automerge":true,"enabled":true},"nix":{"enabled":true},"packageRules":[{"automerge":true,"matchCurrentVersion":"!/^0/","matchUpdateTypes":["minor","patch"]}]} \ No newline at end of file +{"$schema":"https://docs.renovatebot.com/renovate-schema.json","extends":["config:recommended"],"lockFileMaintenance":{"automerge":true,"enabled":true},"nix":{"enabled":true},"packageRules":[{"automerge":true,"matchCurrentVersion":"!/^0/","matchUpdateTypes":["minor","patch"]}]} \ No newline at end of file diff --git a/Eldev b/Eldev index 154bdab..d61e766 100644 --- a/Eldev +++ b/Eldev @@ -3,6 +3,7 @@ (require 'eldev) (setq + eldev-files-to-package `(:or ,eldev-files-to-package "*.elc") ;; run all linters by default eldev-lint-default t ;; and disable the ‘elisp-lint’ validators that are already covered by diff --git a/flake.lock b/flake.lock index fc98dbc..a7061d9 100644 --- a/flake.lock +++ b/flake.lock @@ -26,16 +26,15 @@ ] }, "locked": { - "lastModified": 1730995892, - "narHash": "sha256-hw5E8zDZJsL2hiRy1zzHEU38wP9aiXJAvMZmB8hVP+w=", + "lastModified": 1731187131, + "narHash": "sha256-4iL7tNI2k3LFyMB54rihDDg9zi+aPCFqzvG5sdvzDaY=", "owner": "sellout", "repo": "bash-strict-mode", - "rev": "581d0dcb33b428a87185033f251bba5ad879f4fe", + "rev": "f31ccb698ef3378e86fe275db2cad42a505ca72c", "type": "github" }, "original": { "owner": "sellout", - "ref": "adopt-pkgsLib", "repo": "bash-strict-mode", "type": "github" } @@ -64,11 +63,11 @@ ] }, "locked": { - "lastModified": 1726560853, - "narHash": "sha256-X6rJYSESBVr3hBoH0WbKE5KvhPU5bloyZ2L4K60/fPQ=", + "lastModified": 1731533236, + "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=", "owner": "numtide", "repo": "flake-utils", - "rev": "c1dfcf08411b08f6b8615f7d8971a2bfa81d5e8a", + "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b", "type": "github" }, "original": { @@ -84,20 +83,15 @@ "garnix-systems": "garnix-systems", "home-manager": "home-manager", "nixpkgs": "nixpkgs", - "nixpkgs-unstable": [ - "flaky", - "project-manager", - "nixpkgs-unstable" - ], "project-manager": "project-manager", "systems": "systems" }, "locked": { - "lastModified": 1731043955, - "narHash": "sha256-2T1YPXVfJQ0ZAsIirC5oqLxrGZfNztPZOUHrwADEZO4=", + "lastModified": 1737651114, + "narHash": "sha256-rKWfd1Gj4BCP1Ozbmip7FITQSj1c+/8mjyLiQxGK5GI=", "owner": "sellout", "repo": "flaky", - "rev": "aa3a4afca3ed7a588b96b4b45dc31e2c78fbe48c", + "rev": "eb278f242ff2f896dcc66fd1e33ceca371aafc73", "type": "github" }, "original": { @@ -129,32 +123,32 @@ ] }, "locked": { - "lastModified": 1726989464, - "narHash": "sha256-Vl+WVTJwutXkimwGprnEtXc/s/s8sMuXzqXaspIGlwM=", + "lastModified": 1736373539, + "narHash": "sha256-dinzAqCjenWDxuy+MqUQq0I4zUSfaCvN9rzuCmgMZJY=", "owner": "nix-community", "repo": "home-manager", - "rev": "2f23fa308a7c067e52dfcc30a0758f47043ec176", + "rev": "bd65bc3cde04c16755955630b344bc9e35272c56", "type": "github" }, "original": { "owner": "nix-community", - "ref": "release-24.05", + "ref": "release-24.11", "repo": "home-manager", "type": "github" } }, "nixpkgs": { "locked": { - "lastModified": 1730940508, - "narHash": "sha256-sXS72AYXN/V1Ehp82/46Rqjw5Q6ayCy28ku3980+LSM=", + "lastModified": 1737077867, + "narHash": "sha256-+VpCgelbCgJvxos+4sAVaKfwYRKrkflsWcYVOhG0mXg=", "owner": "NixOS", "repo": "nixpkgs", - "rev": "f39f1d2a8fe191e442ce641a6dc1320f6aa17d04", + "rev": "0ab8bdef1a34b67d2ecc8f86763cbb3cb5297699", "type": "github" }, "original": { "owner": "NixOS", - "ref": "release-24.05", + "ref": "release-24.11", "repo": "nixpkgs", "type": "github" } @@ -207,13 +201,29 @@ "type": "github" } }, + "nixpkgs-24_05": { + "locked": { + "lastModified": 1735651292, + "narHash": "sha256-YLbzcBtYo1/FEzFsB3AnM16qFc6fWPMIoOuSoDwvg9g=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "0da3c44a9460a26d2025ec3ed2ec60a895eb1114", + "type": "github" + }, + "original": { + "owner": "NixOS", + "ref": "release-24.05", + "repo": "nixpkgs", + "type": "github" + } + }, "nixpkgs-unstable": { "locked": { - "lastModified": 1729265718, - "narHash": "sha256-4HQI+6LsO3kpWTYuVGIzhJs1cetFcwT7quWCk/6rqeo=", + "lastModified": 1736657626, + "narHash": "sha256-FWlPMUzp0lkQBdhKlPqtQdqmp+/C+1MBiEytaYfrCTY=", "owner": "NixOS", "repo": "nixpkgs", - "rev": "ccc0c2126893dd20963580b6478d1a10a4512185", + "rev": "2f9e2f85cb14a46410a1399aa9ea7ecf433e422e", "type": "github" }, "original": { @@ -244,6 +254,7 @@ "nixpkgs-22_11": "nixpkgs-22_11", "nixpkgs-23_05": "nixpkgs-23_05", "nixpkgs-23_11": "nixpkgs-23_11", + "nixpkgs-24_05": "nixpkgs-24_05", "nixpkgs-unstable": "nixpkgs-unstable", "systems": [ "flaky", @@ -254,16 +265,15 @@ "treefmt-nix": "treefmt-nix" }, "locked": { - "lastModified": 1731033565, - "narHash": "sha256-5ffNXqJbkIv1xXvurctY5fRuH/5yswNdol2mqyj1F9U=", + "lastModified": 1737424962, + "narHash": "sha256-rFU5yGjNdjyMDKaHmOi5eVhHStKXQn+sD5tMqyt6NbI=", "owner": "sellout", "repo": "project-manager", - "rev": "6018e54be1f63044bb63b8d8b9bc1790b9d0ae8a", + "rev": "6663da781f16496cbd7e1bfe9e921abdaf95b161", "type": "github" }, "original": { "owner": "sellout", - "ref": "modular-lib", "repo": "project-manager", "type": "github" } @@ -325,11 +335,11 @@ ] }, "locked": { - "lastModified": 1729242555, - "narHash": "sha256-6jWSWxv2crIXmYSEb3LEVsFkCkyVHNllk61X4uhqfCs=", + "lastModified": 1736154270, + "narHash": "sha256-p2r8xhQZ3TYIEKBoiEhllKWQqWNJNoT9v64Vmg4q8Zw=", "owner": "numtide", "repo": "treefmt-nix", - "rev": "d986489c1c757f6921a48c1439f19bfb9b8ecab5", + "rev": "13c913f5deb3a5c08bb810efd89dc8cb24dd968b", "type": "github" }, "original": {