From f6776c65bcb2a0ce1f56025fdac6069e9eca30ab Mon Sep 17 00:00:00 2001 From: Greg Pfeil Date: Thu, 30 Nov 2023 21:21:54 -0700 Subject: [PATCH] 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 | 16 +- .github/renovate.json | 1 + .github/settings.yml | 2 + .github/workflows/flakehub-publish.yml | 27 + .github/workflows/update-nix-lockfile.yml | 1 + .gitignore | 14 +- .vale.ini | 15 + LICENSE | 674 ++++++++++++++++++++++ README.md | 8 +- flake.lock | 309 ++++++++-- flake.nix | 275 ++------- garnix.yaml | 2 + nix/dependencies.nix | 12 - 21 files changed, 1189 insertions(+), 306 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 .github/workflows/update-nix-lockfile.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..81f96c3 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,2 +1,14 @@ -# 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 +/.github/workflows/update-nix-lockfile.yml linguist-generated diff --git a/.github/renovate.json b/.github/renovate.json new file mode 100644 index 0000000..e9a453f --- /dev/null +++ b/.github/renovate.json @@ -0,0 +1 @@ +{"$schema":"https://docs.renovatebot.com/renovate-schema.json","extends":["config:base"],"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..1f38382 --- /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 [x86_64-linux]","check elisp-lint [aarch64-darwin]","check elisp-lint [aarch64-linux]","check elisp-lint [x86_64-linux]","homeConfig aarch64-darwin-elisp-reader-example","homeConfig aarch64-linux-elisp-reader-example","homeConfig x86_64-linux-elisp-reader-example","package default [aarch64-darwin]","package default [aarch64-linux]","package default [x86_64-linux]","package emacs-elisp-reader [aarch64-darwin]","package emacs-elisp-reader [aarch64-linux]","package emacs-elisp-reader [x86_64-linux]","check formatter [aarch64-darwin]","check formatter [aarch64-linux]","check formatter [x86_64-linux]","devShell default [aarch64-darwin]","devShell default [aarch64-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/.github/workflows/update-nix-lockfile.yml b/.github/workflows/update-nix-lockfile.yml new file mode 100644 index 0000000..c08d236 --- /dev/null +++ b/.github/workflows/update-nix-lockfile.yml @@ -0,0 +1 @@ +{"jobs":{"lockfile":{"runs-on":"ubuntu-latest","steps":[{"name":"Checkout repository","uses":"actions/checkout@v3"},{"name":"Install Nix","uses":"DeterminateSystems/nix-installer-action@main"},{"name":"Update flake.lock","uses":"DeterminateSystems/update-flake-lock@main","with":{"pr-labels":"dependencies\nautomated\n","pr-reviewers":"sellout\n","pr-title":"Update flake.lock"}}]}},"name":"Create PR to update Nix flake inputs","on":{"schedule":[{"cron":"0 0 * * 0"}],"workflow_dispatch":null},"permissions":{"contents":"write","pull-requests":"write"}} \ No newline at end of file diff --git a/.gitignore b/.gitignore index 5a8cd58..4464314 100644 --- a/.gitignore +++ b/.gitignore @@ -1,13 +1,9 @@ -# Direnv -/.direnv - -# Nix build -/outputs /result /source - -# Compiled *.elc - -# Packaging /.eldev +/.cache/vale/* +!/.cache/vale/Vocab/ +/.cache/vale/Vocab/* +!/.cache/vale/Vocab/elisp-reader/ +/.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..0c6b70c 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": 1701412668, + "narHash": "sha256-M9fQLKRtHzx2BhNuuFXbgvVKTCwZuYsrHet5Ha6SHqc=", "owner": "sellout", "repo": "bash-strict-mode", - "rev": "da573e33174d7078e62eb2a9d9eb7d662e5b4913", + "rev": "c7e67ae5e40b7da0d6c168e046615ca4b0ac4025", "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": 1694529238, + "narHash": "sha256-zsNZZGTGnMOf9YpHKJqMSsa0dXbfmxeoJ7xHlrt+xmY=", "owner": "numtide", "repo": "flake-utils", - "rev": "5aed5285a952e0b949eb3ba02c12fa4fcfef535f", + "rev": "ff7b65b44d01cf9ba6a71320833626af21126384", "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": 1694529238, + "narHash": "sha256-zsNZZGTGnMOf9YpHKJqMSsa0dXbfmxeoJ7xHlrt+xmY=", "owner": "numtide", "repo": "flake-utils", - "rev": "a1720a10a6cfe8234c0e93907ffe81be440f4cef", + "rev": "ff7b65b44d01cf9ba6a71320833626af21126384", "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": 1701442056, + "narHash": "sha256-0z3FeS2Wa2E6kgg5GT/ZyVJfjfHtnmB3NsdR8ba4VUM=", + "owner": "sellout", + "repo": "flaky", + "rev": "0f5cf15cbce1a677e29f700a015b7722505dab87", "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": 1700814205, + "narHash": "sha256-lWqDPKHRbQfi+zNIivf031BUeyciVOtwCwTjyrhDB5g=", "owner": "nix-community", "repo": "home-manager", - "rev": "f9edbedaf015013eb35f8caacbe0c9666bbc16af", + "rev": "aeb2232d7a32530d3448318790534d196bf9427a", "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": 1701440455, + "narHash": "sha256-ycsud50RFmn5IlGM2HXEWrRrIE2DB41gNT5SsAIZP0w=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "a177b44f44fe2cf86a541c59fbeadac203dbdfe7", + "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": 1701184375, + "narHash": "sha256-E8PLzcEMf/1VtRcu+SeJZHtlNrXveBhGoN4AGYxScRE=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "e922e146779e250fae512da343cfb798c758509d", + "type": "github" + }, + "original": { + "owner": "NixOS", + "ref": "release-23.05", + "repo": "nixpkgs", + "type": "github" + } + }, + "nixpkgs-23_11": { + "locked": { + "lastModified": 1701188654, + "narHash": "sha256-vJXSlRscMvhGMjdB4EOeOl4YFfYPGgdVmkj6hGYuu8k=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "55d6d8ee1462266f3f337217ca944ac179ba0501", + "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": 1701040486, + "narHash": "sha256-vawYwoHA5CwvjfqaT3A5CT9V36Eq43gxdwpux32Qkjw=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "45827faa2132b8eade424f6bdd48d8828754341a", + "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": 1701333341, + "narHash": "sha256-+2gqTk7emjUF2wn3ahRUu3eYXRcr0fuN4FXLQKGfWaU=", + "owner": "sellout", + "repo": "project-manager", + "rev": "00973574e5ae63b1e0cf97e4061be62fee43015d", + "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": 1699786194, + "narHash": "sha256-3h3EH1FXQkIeAuzaWB+nK0XK54uSD46pp+dMD3gAcB4=", "owner": "numtide", - "repo": "flake-utils", - "rev": "5aed5285a952e0b949eb3ba02c12fa4fcfef535f", + "repo": "treefmt-nix", + "rev": "e82f32aa7f06bbbd56d7b12186d555223dc399d1", "type": "github" }, "original": { "owner": "numtide", - "repo": "flake-utils", + "repo": "treefmt-nix", "type": "github" } } diff --git a/flake.nix b/flake.nix index 58fb0f0..2375927 100644 --- a/flake.nix +++ b/flake.nix @@ -1,260 +1,109 @@ { - 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 + ename + 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}; - - "${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 - ''; - }); + default = self.packages.${system}.${ename}; + "${ename}" = flaky.lib.elisp.package pkgs src pname (_: []); }; 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 pkgs 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..0f68493 --- /dev/null +++ b/garnix.yaml @@ -0,0 +1,2 @@ +# This file was generated by Project Manager. +{"builds":{"exclude":["*.x86_64-darwin","*.x86_64-darwin.*","checks.*.project-manager-files","homeConfigurations.x86_64-darwin-elisp-reader-example","checks.*.vale"],"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/" - ''; - }); - }); -}