gr-base/shelf/README.org

41 lines
1.1 KiB
Org Mode
Raw Normal View History

2025-08-02 08:49:39 +07:00
* 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
- does not use JSR dependencies
They have heavily timestamped metadata and therefore do not support
reproducible builds.
- can use NPM dependencies
2025-08-03 14:30:56 +07:00
*** scroll.nix
- ~name~
- ~build~
+ ~cacheCommand~
The cache command triggers Deno cache build, putting cache in ~$DENO_DIR~.
+ ~hashFiles~
These files are hashed to determine if the cache will be updated.
In that case a new entry needs to be added in knownHashes.
+ ~knownHashes~
2025-08-02 08:49:39 +07:00
2025-08-03 14:30:56 +07:00
An object that maps ~hashFiles~ hashes to this scroll's
incremental cache derivation's hash.
The starting value is just ~{}~, see build logs to determine
what needs to be added.
2025-08-02 08:49:39 +07:00
All scrolls currently are to use the same Deno version defined by the flake.
2025-08-03 14:30:56 +07:00
Scrolls are automatically discovered by scanning subdirectories of ~./deno~
for those containing a ~scroll.nix~ file.
Directories without ~scroll.nix~ will generate warnings during build.