document deno scrolls situation

This commit is contained in:
EatThePooh 2025-08-02 08:49:39 +07:00
parent a4bc8c0230
commit 928c1067b3
2 changed files with 39 additions and 0 deletions

26
shelf/README.org Normal file
View file

@ -0,0 +1,26 @@
* Scroll conventions
** Deno
Each Deno scroll:
- is an immediate subdirectory of ~./deno~
- contains a Deno lockfile
Unless you're trying to shoot yourself or downstream dep maintainers in the foot.
- contains a ~scroll.nix~ file
- defines ~cache-command~ field in ~scroll.nix~
~cache-command~ triggers Deno cache build, putting cache in $DENO_DIR.
- does not use JSR dependencies
They have heavily timestamped metadata and therefore do not support
reproducible builds.
- can use NPM dependencies
~.lock~, ~.json~ and ~.jsonc~ files are recursively hashed
to determine if the cache is updated.
In that case a new entry needs to be added in knownHashes.
All scrolls currently are to use the same Deno version defined by the flake.
See ~./deno-workflow.nix~ for details.

View file

@ -1,3 +1,16 @@
{
name = "hjq";
description = "Drop-in jq replacement for HJSON that tries to preserve comments";
inputs = {
stdin = "HJSON";
jq_filter = "string";
};
outputs = {
stdout = "HJSON";
};
cache-command = "deno cache --reload main.ts";
}