Document not found (404)
+This URL is invalid, sorry. Please use the navigation bar or search to continue.
+ +This URL is invalid, sorry. Please use the navigation bar or search to continue.
+ +Builtin Modules are modules defined with this same package.
+They are already included when we use this package.
+files.alias, create bash script aliasfiles.cmds, install packages from nix repositoryfiles.docs, convert our modules file into markdown using nmdfiles.git, configure git with file creationfiles.on-call, connfigure file to created only when devshell-files command is called, not on shell startfiles.gitignore, copy .gitignore from templatesfiles.hcl, create HCL files with nix syntaxfiles.json, create JSON files with nix syntaxfiles.mdbook, convert your markdown files to HTML using mdbookfiles.nim, similar to files.alias, but compiles Nim codefiles.nus, similar to files.alias, but runs in Nushellfiles.nush, similar to files.nus, but for subcommandsfiles.services, process supervisor for development services using s6files.rc , WIP, process supervisor for development services using s6-rcfiles.spdx, copy LICENSE from templatesfiles.text, create free text files with nix syntaxfiles.toml, create TOML files with nix syntaxfiles.watch, create an alias and service to run command when file changes using inotify-toolsfiles.yaml, create YAML files with nix syntaxOur documentation is generated by files.text, files.docs and files.mdbook
To document our modules is simple, we just need to use config.files.docs as follow
# examples/docs.nix
+
+{lib, pkgs, ...}:
+{
+ files.docs."/gh-pages/src/modules/alias.md".modules = [ ../modules/alias.nix ];
+ files.docs."/gh-pages/src/modules/cmds.md".modules = [ ../modules/cmds.nix ];
+ files.docs."/gh-pages/src/modules/files.md".modules = [ ../modules/files.nix ];
+ files.docs."/gh-pages/src/modules/git.md".modules = [ ../modules/git.nix ];
+ files.docs."/gh-pages/src/modules/on-call.md".modules = [ ../modules/startup.nix ];
+ files.docs."/gh-pages/src/modules/gitignore.md".modules = [ ../modules/gitignore.nix ];
+ files.docs."/gh-pages/src/modules/hcl.md".modules = [ ../modules/hcl.nix ];
+ files.docs."/gh-pages/src/modules/json.md".modules = [ ../modules/json.nix ];
+ files.docs."/gh-pages/src/modules/mdbook.md".modules = [ ../modules/mdbook.nix ];
+ files.docs."/gh-pages/src/modules/nim.md".modules = [ ../modules/nim.nix ];
+ files.docs."/gh-pages/src/modules/nushell.md".modules = [ ../modules/nushell.nix ];
+ files.docs."/gh-pages/src/modules/nush.md".modules = [ ../modules/nush.nix ../modules/nuon.nix ];
+ files.docs."/gh-pages/src/modules/rc.md".modules = [ ../modules/services/rc-devshell.nix ];
+ files.docs."/gh-pages/src/modules/services.md".modules = [ ../modules/services.nix ];
+ files.docs."/gh-pages/src/modules/spdx.md".modules = [ ../modules/spdx.nix ];
+ files.docs."/gh-pages/src/modules/text.md".modules = [ ../modules/text.nix ];
+ files.docs."/gh-pages/src/modules/toml.md".modules = [ ../modules/toml.nix ];
+ files.docs."/gh-pages/src/modules/watch.md".modules = [ ../modules/watch ];
+ files.docs."/gh-pages/src/modules/yaml.md".modules = [ ../modules/yaml.nix ];
+}
+
+# examples/book.nix
+
+{lib, ...}:
+let
+ project = "devshell-files";
+ author = "cruel-intentions";
+ org-url = "https://github.com/${author}";
+ edit-path = "${org-url}/${project}/edit/master/examples/{path}";
+in
+{
+ files.mdbook.authors = ["Cruel Intentions <${org-url}>"];
+ files.mdbook.enable = true;
+ files.mdbook.gh-author = author;
+ files.mdbook.gh-project = project;
+ files.mdbook.language = "en";
+ files.mdbook.multilingual = false;
+ files.mdbook.summary = builtins.readFile ./summary.md;
+ files.mdbook.title = "Nix DevShell Files Maker";
+ files.mdbook.output.html.edit-url-template = edit-path;
+ files.mdbook.output.html.fold.enable = true;
+ files.mdbook.output.html.git-repository-url = "${org-url}/${project}/tree/master";
+ files.mdbook.output.html.no-section-label = true;
+ files.mdbook.output.html.site-url = "/${project}/";
+ files.gitignore.pattern.gh-pages = true;
+ files.text."/gh-pages/src/introduction.md" = builtins.readFile ./readme/about.md;
+ files.text."/gh-pages/src/installation.md" = builtins.readFile ./readme/installation.md;
+ files.text."/gh-pages/src/examples.md" = builtins.import ./readme/examples.nix;
+ files.text."/gh-pages/src/modules.md" = "## Writing new modules";
+ files.text."/gh-pages/src/nix-lang.md" = builtins.readFile ./readme/modules/nix-lang.md;
+ files.text."/gh-pages/src/json-nix.md" = builtins.import ./readme/modules/json-vs-nix.nix lib;
+ files.text."/gh-pages/src/module-spec.md" = builtins.readFile ./readme/modules/modules.md;
+ files.text."/gh-pages/src/share.md" = builtins.readFile ./readme/modules/share.md;
+ files.text."/gh-pages/src/document.md" = builtins.import ./readme/modules/document.nix;
+ files.text."/gh-pages/src/builtins.md" = builtins.readFile ./readme/modules/builtins.md;
+ files.text."/gh-pages/src/todo.md" = builtins.readFile ./readme/todo.md;
+ files.text."/gh-pages/src/issues.md" = builtins.readFile ./readme/issues.md;
+ files.text."/gh-pages/src/seeAlso.md" = builtins.readFile ./readme/seeAlso.md;
+ files.alias.publish-as-gh-pages-from-local = ''
+ # same as publish-as-gh-pages but works local
+ cd $PRJ_ROOT
+ ORIGIN=`git remote get-url origin`
+ cd gh-pages
+ mdbook build
+ cd book
+ git init .
+ git add .
+ git checkout -b gh-pages
+ git commit -m "docs(gh-pages): update gh-pages" .
+ git remote add origin $ORIGIN
+ git push -u origin gh-pages --force
+ '';
+}
+
+And publish this mdbook to github pages with book-as-gh-pages alias.
Creating JSON, TEXT, TOML or YAML files
+# examples/hello.nix
+#
+# this is one nix file
+{
+ files.json."/generated/hello.json".hello = "world";
+ files.toml."/generated/hello.toml".hello = "world";
+ files.yaml."/generated/hello.yaml".hello = "world";
+ files.hcl."/generated/hello.hcl".hello = "world";
+ files.text."/generated/hello.txt" = "world";
+}
+
+Your file can be complemented with another module
+# examples/world.nix
+# almost same as previous example
+# but show some language feature
+let
+ name = "hello"; # a variable
+in
+{
+ files = {
+ json."/generated/${name}.json".baz = ["foo" "bar" name];
+ toml."/generated/${name}.toml".baz = ["foo" "bar" name];
+ yaml = {
+ "/generated/${name}.yaml" = {
+ baz = [
+ "foo"
+ "bar"
+ name
+ ];
+ };
+ };
+ };
+}
+
+Content generated by those examples are in generated
+# ie ./generated/hello.yaml
+baz:
+ - foo
+ - bar
+ - hello
+hello: world
+
+This project is configured by module project.nix
+# ./project.nix
+{
+ # import other modules
+ imports = [
+ ./examples/hello.nix
+ ./examples/world.nix
+ ./examples/readme.nix
+ ./examples/gitignore.nix
+ ./examples/license.nix
+ ./examples/docs.nix
+ ./examples/book.nix
+ ./examples/services.nix
+ ./examples/nim.nix
+ ./examples/nushell.nix
+ ./examples/watch.nix
+ ];
+
+ # install development or deployment tools
+ packages = [
+ "convco"
+ # now we can use 'convco' command https://convco.github.io
+
+ # but could be:
+ # "awscli"
+ # "azure-cli"
+ # "cargo"
+ # "conda"
+ # "go"
+ # "nim"
+ # "nodejs"
+ # "nodejs-18_x"
+ # "nushell"
+ # "pipenv"
+ # "python39"
+ # "ruby"
+ # "rustc"
+ # "terraform"
+ # "yarn"
+ # look at https://search.nixos.org for more packages
+ ];
+
+ # create alias
+ files.alias.feat = ''convco commit --feat $@'';
+ files.alias.fix = ''convco commit --fix $@'';
+ files.alias.docs = ''convco commit --docs $@'';
+ files.alias.alou = ''
+ #!/usr/bin/env python
+ print("Alo!") # is hello in portuguese
+ '';
+
+ # now we can use feat, fix, docs and alou commands
+
+ # create .envrc for direnv
+ files.direnv.enable = true;
+
+ # disabe file creation when entering in the shell
+ # call devshell-files instead
+ # files.on-call = true;
+}
+
+This README.md is also a module defined as above
+# There is a lot things we could use to write static file
+# Basic intro to nix language https://github.com/tazjin/nix-1p
+# Some nix functions https://teu5us.github.io/nix-lib.html
+{lib, ...}:
+{
+ files.text."/README.md" = builtins.concatStringsSep "\n" [
+ "# Devshell Files Maker"
+ (builtins.readFile ./readme/toc.md)
+ (builtins.readFile ./readme/about.md)
+ (builtins.readFile ./readme/installation.md)
+ (builtins.import ./readme/examples.nix)
+ ((builtins.import ./readme/modules.nix) lib)
+ (builtins.readFile ./readme/todo.md)
+ (builtins.readFile ./readme/issues.md)
+ (builtins.readFile ./readme/seeAlso.md)
+ ];
+}
+
+Our .gitignore is defined like this
+# ./examples/gitignore.nix
+{
+ # create my .gitignore copying ignore patterns from
+ # github.com/github/gitignore
+ files.gitignore.enable = true;
+ files.gitignore.template."Global/Archives" = true;
+ files.gitignore.template."Global/Backup" = true;
+ files.gitignore.template."Global/Diff" = true;
+ files.gitignore.pattern."**/.data" = true;
+ files.gitignore.pattern."**/.direnv" = true;
+ files.gitignore.pattern."**/.envrc" = true;
+ files.gitignore.pattern."**/.gitignore" = true;
+ files.gitignore.pattern."**/flake.lock" = true;
+}
+
+And our LICENSE file is
+# ./examples/license.nix
+{
+ # LICENSE file creation
+ # using templates from https://github.com/spdx/license-list-data
+ files.license.enable = true;
+ files.license.spdx.name = "MIT";
+ files.license.spdx.vars.year = "2023";
+ files.license.spdx.vars."copyright holders" = "Cruel Intentions";
+}
+
+Helps static file/configuration creation with Nix and devshell.
+There is a bunch of ways static file/configuration are hard, this will help you generate, validate and distribute JSON, YAML, TOML or TXT.
+Your content will be defined in Nix Language, it means you can use variables, functions, imports, read files, etc.
+The modular system helps layering configurations, hiding complexity and making it easier for OPS teams.
+Your content modules could optionally be well defined and type checked in build proccess with this same tool.
+Or you could use Nix as package manager and install any tool to validate your configuration (ie integrating it with existing JSON Schema).
+Nix integrates well with git and http, it could be also used to read JSON, YAML, TOML, zip and gz files.
+In fact Nix isn't a configuration tool but a package manger, we are only using it as configuration tool because the language is simple and flexible.
+You can recreate files of a repository directly to your local machine by running nix develop <flake-uri> --build, example:
# copy all my dogfood to your current folder
+nix develop github:cruel-intentions/devshell-files --build
+With help of Nix and devshell you could install any development or deployment tool of its 80 000 packages.
+ +Installing Nix
+curl -sSf -L https://install.determinate.systems/nix | sh -s -- install
+Configuring new projects:
+nix flake new -t github:cruel-intentions/devshell-files my-project
+cd my-project
+git init
+git add *.nix flake.lock
+Configuring existing projects:
+nix flake new -t github:cruel-intentions/devshell-files ./
+git add *.nix
+git add flake.lock
+nix develop --build
+or entering in shell with all commands and alias
+nix develop -c $SHELL
+# to list commands and alias
+# now run: menu
+Helps static file/configuration creation with Nix and devshell.
+There is a bunch of ways static file/configuration are hard, this will help you generate, validate and distribute JSON, YAML, TOML or TXT.
+Your content will be defined in Nix Language, it means you can use variables, functions, imports, read files, etc.
+The modular system helps layering configurations, hiding complexity and making it easier for OPS teams.
+Your content modules could optionally be well defined and type checked in build proccess with this same tool.
+Or you could use Nix as package manager and install any tool to validate your configuration (ie integrating it with existing JSON Schema).
+Nix integrates well with git and http, it could be also used to read JSON, YAML, TOML, zip and gz files.
+In fact Nix isn't a configuration tool but a package manger, we are only using it as configuration tool because the language is simple and flexible.
+You can recreate files of a repository directly to your local machine by running nix develop <flake-uri> --build, example:
# copy all my dogfood to your current folder
+nix develop github:cruel-intentions/devshell-files --build
+With help of Nix and devshell you could install any development or deployment tool of its 80 000 packages.
+ +This project uses git as version control, if your are using other version control system it may not work.
+ +| name | JSON | NIX |
|---|---|---|
| null | null | null |
| bool | true | true |
| int | 123 | 123 |
| float | 12.3 | 12.3 |
| string | "string" | "string" |
| array | ["some","array"] | ["some" "array"] |
| object | {"some":"value"} | { some = "value"; } |
| multiline-string | ''... multiline string ... '' | |
| variables | let my-var = 1; other-var = 2; in my-var + other-var | |
| function | my-arg: "Hello ${my-arg}!" | |
| variable-function | let my-function = my-arg: "Hello ${my-arg}!"; in ... | |
| calling-a-function | ... in my-function "World" |
Modules can be defined in two formats:
+{ # <|
+ imports = []; # |
+ config = {}; # | module result
+ options = {}; # |
+} # <|
+Functions has following arguments:
+config with all evaluated configs values, pkgs with all nixpkgs available.lib library of useful functions.... to ignore them){ config, pkgs, lib, ... }: # <| function args
+{ # <|
+ imports = []; # |
+ config = {}; # | module result
+ options = {}; # |
+} # <|
+All those attributes are optional
+Hint, split modules in two files:
+It has two advantages, let share options definitions across projects more easily.
+And it hides complexity, hiding complexity is what abstraction is all about, +we didn't share options definitions across projects to type less, but because we could reuse an abstraction that helps hiding complexity.
+Points to other modules files to be imported in this module
+{
+ imports = [
+ ./gh-actions-options.nix
+ ./some-other-module.nix
+ ];
+}
+Are values to our options
+{
+ config.gh-actions.setup = "npm i";
+}
+Use builtin functions to import nix/json/toml/text files.
+{ lib, ...}:
+{
+ config.files.text."/hi.txt" = (builtins.import ./hello.nix ).msg; # { msg = "Hello World!"; }
+ config.files.text."/hI.txt" = (lib.importJSON ./hello.json).msg; # { "msg": "Hello World!" }
+ config.files.text."/h1.txt" = (lib.importTOML ./hello.toml).msg; # msg = Hello World!
+ config.files.text."/Hi.txt" = builtins.readFile ./hello.txt; # Hello World!
+}
+If file has no options., config. can be ommited.
And this file produce the same result
+{ lib, ...}:
+{
+ files.text."/hi.txt" = (builtins.import ./hello.nix ).msg; # { msg = "Hello World!"; }
+ files.text."/hI.txt" = (lib.importJSON ./hello.json).msg; # { "msg": "Hello World!" }
+ files.text."/h1.txt" = (lib.importTOML ./hello.toml).msg; # msg = Hello World!
+ files.text."/Hi.txt" = builtins.readFile ./hello.txt; # Hello World!
+ gh-actions.setup = "npm i";
+}
+Options are schema definition for config.
+Example, to create a github action file, it could be done like this:
+{
+ files.yaml."/.github/workflows/ci-cd.yaml" = {
+ on = "push";
+ jobs.ci-cd.runs-on = "ubuntu-latest";
+ jobs.ci-cd.steps = [
+ { uses = "actions/checkout@v2.4.0"; }
+ { run = "npm i"; }
+ { run = "npm run build"; }
+ { run = "npm run test"; }
+ { run = "aws s3 sync ./build s3://some-s3-bucket"; }
+ ];
+ };
+}
+No complexity has been hidden, and requires copy and past it in every project.
+Since most CI/CD are just: 'Pre Build', 'Build', 'Test', 'Deploy'
+What project user really needs to define is:
+# any module file (maybe project.nix)
+{
+ # our build steps
+ gh-actions.setup = "npm i";
+ gh-actions.build = "npm run build";
+ gh-actions.test = "npm run test";
+ gh-actions.deploy = "aws s3 sync ./build s3://some-s3-bucket";
+}
+Adding this to project.nix, throw an error undefined config.gh-actions, and command fails.
To create it, add options definition of that.
# gh-actions-options.nix
+{ lib, ...}:
+{
+ # defines a property 'gh-actions.setup'
+ options.gh-actions.setup = lib.mkOption {
+ default = "echo setup";
+ description = "Command to run before build";
+ example = "npm i";
+ type = lib.types.str;
+ };
+ # defines a property 'gh-actions.build'
+ options.gh-actions.build = lib.mkOption {
+ default = "echo build";
+ description = "Command to run as build step";
+ example = "npm run build";
+ type = lib.types.str;
+ };
+ # defines a property 'gh-actions.test'
+ options.gh-actions.test = lib.mkOption {
+ default = "echo test";
+ description = "Command to run as test step";
+ example = "npm test";
+ type = lib.types.str;
+ };
+ # defines a property 'gh-actions.deploy'
+ options.gh-actions.deploy = lib.mkOption {
+ default = "echo deploy";
+ description = "Command to run as deploy step";
+ example = "aws s3 sync ./build s3://my-bucket";
+ type = lib.types.lines;
+ };
+}
+Or using lib.types.fluent
# gh-actions-options.nix
+{ lib, ...}:
+lib.types.fluent {
+ # defines a property 'gh-actions.setup'
+ options.gh-actions.options.setup.default = "echo setup"; #default is string
+ options.gh-actions.options.setup.mdDoc = "Command to run before build";
+ options.gh-actions.options.setup.example = "npm i";
+ # defines a property 'gh-actions.build'
+ options.gh-actions.options.build.default = "echo build";
+ options.gh-actions.options.build.mdDoc = "Command to run as build step";
+ options.gh-actions.options.build.example = "npm run build";
+ # defines a property 'gh-actions.test'
+ options.gh-actions.options.test.default = "echo test";
+ options.gh-actions.options.test.mdDoc = "Command to run as test step";
+ options.gh-actions.options.test.example = "npm test";
+ # defines a property 'gh-actions.deploy'
+ options.gh-actions.options.deploy.default = "echo deploy";
+ options.gh-actions.options.deploy.mdDoc = "Command to run as deploy step";
+ options.gh-actions.options.deploy.example = "aws s3 sync ./build s3://my-bucket";
+ options.gh-actions.options.deploy.type = lib.types.lines;
+}
+Now, previous config can be used, but it does nothing, it doesn't create yaml.
+It knowns what options can be accepted as config, but not what to do with it.
Usually the next part is in same file of options, it isn't a requirement, and spliting it here make it simplier to explain.
# gh-actions.nix
+{ config, lib, ... }:
+{
+ imports = [ ./gh-actions-options.nix ];
+ # use other module that simplify file creation to create config file
+ files.yaml."/.github/workflows/ci-cd.yaml".jobs.ci-cd.steps = [
+ { uses = "actions/checkout@v2.4.0"; }
+
+ { run = config.gh-actions.setup; } #
+ { run = config.gh-actions.build; } # Read step scripts from
+ { run = config.gh-actions.test; } # config.gh-actions
+ { run = config.gh-actions.deploy"; } #
+ ];
+ files.yaml."/.github/workflows/ci-cd.yaml".on = "push";
+ files.yaml."/.github/workflows/ci-cd.yaml".jobs.ci-cd.runs-on = "ubuntu-latest";
+}
+Now it can be imported and set 'setup', 'build', 'test' and 'deploy' configs
+# any other module file, maybe project.nix
+{
+ imports = [ ./gh-actions.nix ];
+ gh-actions.setup = "echo 'paranaue'";
+ gh-actions.build = "echo 'paranaue parana'";
+ gh-actions.build = "echo 'paranaue'";
+ gh-actions.deploy = ''
+ echo "paranaue
+ parana"
+ '';
+}
+If something that is not a string is set, an error will raise, cheking it against the options schema.
+There are other types that can be used (some of them):
+And lib has some modules helpers functions like:
+attribute set of Concatenated string
+{
+ files.alias = {
+ hello = "echo hello";
+ world = ''
+ #!/usr/bin/env python
+ print("world")
+ '';
+ };
+}
+{
+ files.alias = { };
+}
+https://search.nixos.org for more tools
+attribute set of boolean
+{
+ files.cmds = {
+ awscli = true;
+ azure-cli = true;
+ cargo = true;
+ conda = true;
+ convco = true;
+ go_1_17 = true;
+ nodejs-16_x = true;
+ pipenv = true;
+ python39 = true;
+ ruby_3_0 = true;
+ rustc = true;
+ terraform = true;
+ yarn = true;
+ };
+}
+{
+ files.cmds = { };
+}
+attribute set of (submodule)
+{
+ file = { };
+}
+null or boolean
+{
+ file.<name>.executable = null;
+}
+null or boolean
+{
+ file.<name>.git-add = null;
+}
+null or boolean
+{
+ file.<name>.on-enter = true;
+}
+path
+string
+{
+ file.<name>.target = <name>;
+}
+null or strings concatenated with "\n"
+{
+ file.<name>.text = null;
+}
+boolean
+{
+ files.git.auto-add = true;
+}
+{
+ files.git.auto-add = false;
+}
+boolean
+{
+ files.gitignore.enable = true;
+}
+{
+ files.gitignore.enable = false;
+}
+attribute set of boolean
+{
+ files.gitignore.pattern = {
+ "ignore-this-file.txt" = true;
+ };
+}
+{
+ files.gitignore.pattern = { };
+}
+attribute set of boolean
+{
+ files.gitignore.template = {
+ Android = true;
+ "community/AWS/SAM" = true;
+ };
+}
+{
+ files.gitignore.template = { };
+}
+attribute set of (JSON value)
+{
+ files.hcl = {
+ "/hellaos.hcl" = {
+ greeting = "hello World";
+ };
+ "/hellows.hcl" = {
+ greetings = [
+ [
+ "Hello World"
+ ]
+ [
+ "Ola Mundo"
+ [
+ "Holla Que Tal"
+ ]
+ ]
+ ];
+ };
+ };
+}
+{
+ files.hcl = { };
+}
+attribute set of (JSON value)
+{
+ files.json = {
+ "/hellaos.json" = {
+ greeting = "hello World";
+ };
+ "/hellows.json" = {
+ greetings = [
+ [
+ "Hello World"
+ ]
+ [
+ "Ola Mundo"
+ [
+ "Holla Que Tal"
+ ]
+ ]
+ ];
+ };
+ };
+}
+{
+ files.json = { };
+}
+by default it creates gh-pages/mdbook.toml and gh-pages/src/SUMMARY.md
+It also create publish-as-gh-pages helper
+#examples/book.nix
+
+{lib, ...}:
+let
+ project = "devshell-files";
+ author = "cruel-intentions";
+ org-url = "https://github.com/${author}";
+ edit-path = "${org-url}/${project}/edit/master/examples/{path}";
+in
+{
+ files.mdbook.authors = ["Cruel Intentions <${org-url}>"];
+ files.mdbook.enable = true;
+ files.mdbook.gh-author = author;
+ files.mdbook.gh-project = project;
+ files.mdbook.language = "en";
+ files.mdbook.multilingual = false;
+ files.mdbook.summary = builtins.readFile ./summary.md;
+ files.mdbook.title = "Nix DevShell Files Maker";
+ files.mdbook.output.html.edit-url-template = edit-path;
+ files.mdbook.output.html.fold.enable = true;
+ files.mdbook.output.html.git-repository-url = "${org-url}/${project}/tree/master";
+ files.mdbook.output.html.no-section-label = true;
+ files.mdbook.output.html.site-url = "/${project}/";
+ files.gitignore.pattern.gh-pages = true;
+ files.text."/gh-pages/src/introduction.md" = builtins.readFile ./readme/about.md;
+ files.text."/gh-pages/src/installation.md" = builtins.readFile ./readme/installation.md;
+ files.text."/gh-pages/src/examples.md" = builtins.import ./readme/examples.nix;
+ files.text."/gh-pages/src/modules.md" = "## Writing new modules";
+ files.text."/gh-pages/src/nix-lang.md" = builtins.readFile ./readme/modules/nix-lang.md;
+ files.text."/gh-pages/src/json-nix.md" = builtins.import ./readme/modules/json-vs-nix.nix lib;
+ files.text."/gh-pages/src/module-spec.md" = builtins.readFile ./readme/modules/modules.md;
+ files.text."/gh-pages/src/share.md" = builtins.readFile ./readme/modules/share.md;
+ files.text."/gh-pages/src/document.md" = builtins.import ./readme/modules/document.nix;
+ files.text."/gh-pages/src/builtins.md" = builtins.readFile ./readme/modules/builtins.md;
+ files.text."/gh-pages/src/todo.md" = builtins.readFile ./readme/todo.md;
+ files.text."/gh-pages/src/issues.md" = builtins.readFile ./readme/issues.md;
+ files.text."/gh-pages/src/seeAlso.md" = builtins.readFile ./readme/seeAlso.md;
+ files.alias.publish-as-gh-pages-from-local = ''
+ # same as publish-as-gh-pages but works local
+ cd $PRJ_ROOT
+ ORIGIN=`git remote get-url origin`
+ cd gh-pages
+ mdbook build
+ cd book
+ git init .
+ git add .
+ git checkout -b gh-pages
+ git commit -m "docs(gh-pages): update gh-pages" .
+ git remote add origin $ORIGIN
+ git push -u origin gh-pages --force
+ '';
+}
+
+submodule
+{
+ files.mdbook = { };
+}
+boolean
+{
+ files.mdbook.enable = true;
+}
+{
+ files.mdbook.enable = false;
+}
+null or (non-empty (list of string))
+{
+ files.mdbook.authors = [
+ "Cruel Intentions"
+ ];
+}
+{
+ files.mdbook.authors = null;
+}
+JSON value
+{
+ files.mdbook.build = {
+ build-dir = "book";
+ };
+}
+{
+ files.mdbook.build = { };
+}
+null or string
+{
+ files.mdbook.description = "Modules Docummentation";
+}
+{
+ files.mdbook.description = null;
+}
+null or string
+{
+ files.mdbook.gh-author = "cruel-intentions";
+}
+{
+ files.mdbook.gh-author = null;
+}
+null or string
+{
+ files.mdbook.gh-project = "devshell-files";
+}
+{
+ files.mdbook.gh-project = null;
+}
+null or non-empty string
+{
+ files.mdbook.language = "en";
+}
+{
+ files.mdbook.language = null;
+}
+boolean
+{
+ files.mdbook.multilingual = true;
+}
+{
+ files.mdbook.multilingual = false;
+}
+JSON value
+{
+ files.mdbook.output = {
+ html = {
+ fold = {
+ enable = true;
+ };
+ };
+ };
+}
+{
+ files.mdbook.output = { };
+}
+JSON value
+{
+ files.mdbook.preprocessor = {
+ mathjax = {
+ renderers = [
+ "html"
+ ];
+ };
+ };
+}
+{
+ files.mdbook.preprocessor = { };
+}
+non-empty string
+{
+ files.mdbook.root-dir = "/gh-pages";
+}
+{
+ files.mdbook.root-dir = "/gh-pages";
+}
+JSON value
+{
+ files.mdbook.rust = {
+ edition = "2018";
+ };
+}
+{
+ files.mdbook.rust = { };
+}
+strings concatenated with "\n"
+{
+ files.mdbook.summary = ''
+ # SUMMARY
+ - [Intro](./intro.md)
+ '';
+}
+{
+ files.mdbook.summary = ''
+ # SUMMARY
+ '';
+}
+null or string
+{
+ files.mdbook.title = "Devshell Files Modules";
+}
+{
+ files.mdbook.title = null;
+}
+boolean
+{
+ files.mdbook.use-default-preprocessor = false;
+}
+{
+ files.mdbook.use-default-preprocessor = true;
+}
+It includes some helpers and libraries for laziness, so it better +fit prototyping and simples commands/script.
+Vars:
+let PRJ_DATA_DIR = env "PRJ_DATA_DIR"Procs:
+1.arg"PRJ_DATA_DIR".env"foo/0/^1/0..1/0..^1/bar".jPath
+myPath / "blerg" / 0 / ^1 / 0 .. 1 / 0 .. ^1/bazmyPath.get myObjmyObj[myPath]myPath.set myObj, myValmyObj[myPath] = myValImports:
+Flags:
+-w:off -d:ssl --threads:on --mm:orc --hints:off --parallelBuild:4 --tlsEmulation:onTodo:
+Examples:
+# examples/nim.nix
+{pkgs, ...}:{
+ # compile nim files and them to shell
+ files.nim.helloNim = ''echo ARGS'';
+ # keep an /tmp file with last result for n seconds
+ files.nim.memoise = builtins.readFile ./nim/memoise.nim;
+ # clustersSTS is a good candidate to be used with services
+ files.nim.clustersSTS = builtins.readFile ./nim/clustersSTS.nim;
+ # our poor man jq alternative
+ files.nim.jsonildo = builtins.readFile ./nim/jsonildo.nim;
+ files.nim.helloNimAgain.deps = [ pkgs.termbox pkgs.nimPackages.nimbox ];
+ files.nim.helloNimAgain.src = ''
+ import nimbox
+ proc main() =
+ var nb = newNimbox()
+ defer: nb.shutdown()
+
+ nb.print(0, 0, "Hello, world!")
+ nb.present()
+ sleep(1000)
+
+ when isMainModule:
+ main()
+ '';
+}
+
+```</para>
+
+#### type
+
+attribute set of ((submodule) or Concatenated string)
+
+#### example
+
+```nix
+{
+ files.nim = {
+ dokr = ''
+ // create an docker compose alias
+ // cd $PRJ_ROOT/subdir; docker "compose" $@
+ exec "docker", "compose" + ARGS, PRJ_ROOT / "subdir"
+ '';
+ hello = ''
+ #compile-at-mkshell
+
+ # by default nim commands were compiled at first run to reduce
+ # shell activation time, add comment #compile-at-mkshell to
+ # compile at shell activation
+ echo "hello"
+ '';
+ manage = ''
+ // create an pipenv alias
+ // pipenv run python ./manage.py
+ exec "pipenv", args("run python ./manage.py") + ARGS
+ '';
+ };
+}
+{
+ files.nim = { };
+}
+boolean
+{
+ files.nuon.enable = true;
+}
+{
+ files.nuon.enable = false;
+}
+attribute set of attribute set of (Concatenated string or list of Concatenated string)
+{
+ files.nush = {
+ hello = {
+ en = [
+ "arg"
+ "{hello: $arg}"
+ ];
+ pt = [
+ "arg"
+ "{ola: $arg}"
+ ];
+ };
+ world = {
+ hello = ''
+ # it could use previous commands
+ hello en "World"
+ hello pt "Mundo"
+ '';
+ };
+ };
+}
+{
+ files.nush = { };
+}
+attribute set of (Concatenated string or list of Concatenated string)
+{
+ files.nus = {
+ hello = [
+ "name"
+ "{hello: $name}"
+ ];
+ world = ''
+ # it could use previous commands
+ hello world
+ '';
+ };
+}
+{
+ files.nus = { };
+}
+All services are disabled by default.
+It will fail at activation time if:
+attribute set of (submodule)
+{
+ files.rc = {
+ hello = {
+ enable = true;
+ longrun = {
+ run = "mySquirelD";
+ };
+ };
+ hola = {
+ bundle = {
+ contents = [
+ "hello"
+ "world"
+ ];
+ };
+ enable = true;
+ };
+ world = {
+ enable = true;
+ oneshot = {
+ setup = "echo Hello World > $PRJ_DATA_DIR/hello.txt";
+ };
+ };
+ };
+}
+{
+ files.rc = { };
+}
+boolean
+{
+ files.rc.<name>.enable = true;
+}
+{
+ files.rc.<name>.enable = false;
+}
+bundle is a service aggregator
For example we can bundle every system (db, http, config) by microservice.
+Like:
+null or (submodule)
+{
+ files.rc.<name>.bundle = {
+ contents = [
+ "myFancyServiceName"
+ ];
+ essential = true;
+ };
+}
+{
+ files.rc.<name>.bundle = null;
+}
+non-empty (list of non-empty string)
+{
+ files.rc.<name>.bundle.deps = [
+ "myDep"
+ "myOtherDep"
+ ];
+}
+It means some commands may work to stop these services
+boolean
+{
+ files.rc.<name>.bundle.essential = true;
+}
+{
+ files.rc.<name>.bundle.essential = false;
+}
+longrun are commands that run as deamon (in a infinity loop).
Applications:
+null or (submodule)
+{
+ files.rc.<name>.longrun = {
+ agreement = {
+ description = "Check to confirm";
+ label = "Are you sure?";
+ };
+ };
+}
+{
+ files.rc.<name>.longrun = null;
+}
+Dependency hierarchy are calculated at activation time.
+See S6 documentation +for more info
+list of non-empty string
+{
+ files.rc.<name>.longrun.consumer-for = [
+ "myService"
+ ];
+}
+{
+ files.rc.<name>.longrun.consumer-for = [ ];
+}
+null or path
+{
+ files.rc.<name>.longrun.data = "./.data";
+}
+{
+ files.rc.<name>.longrun.data = null;
+}
+ready to this
+service work.
Dependency hierarchy are calculated at activation time.
+See S6 documentation +for more info
+list of non-empty string
+{
+ files.rc.<name>.longrun.deps = [
+ "myDependency"
+ ];
+}
+{
+ files.rc.<name>.longrun.deps = [ ];
+}
+null or path
+{
+ files.rc.<name>.longrun.env = "./.direnv";
+}
+{
+ files.rc.<name>.longrun.env = null;
+}
+It means some commands may work to stop this service
+boolean
+{
+ files.rc.<name>.longrun.essential = true;
+}
+{
+ files.rc.<name>.longrun.essential = false;
+}
+unsigned integer, meaning >=0
+{
+ files.rc.<name>.longrun.kill-after = 2005;
+}
+{
+ files.rc.<name>.longrun.kill-after = 0;
+}
+unsigned integer, meaning >=0
+{
+ files.rc.<name>.longrun.kill-finish-after = 2005;
+}
+{
+ files.rc.<name>.longrun.kill-finish-after = 0;
+}
+running
If value any value other then 0, 1 or 2, this +service uses file-descriptor lock
+null or unsigned integer, meaning >=0
+{
+ files.rc.<name>.longrun.lock-descriptor = 5;
+}
+{
+ files.rc.<name>.longrun.lock-descriptor = 0;
+}
+unsigned integer, meaning >=0
+{
+ files.rc.<name>.longrun.max-restarts = 2005;
+}
+{
+ files.rc.<name>.longrun.max-restarts = 100;
+}
+Dependency hierarchy are calculated at activation time.
+See S6 documentation +for more info
+null or non-empty string
+{
+ files.rc.<name>.longrun.pipeline-name = "logMyService";
+}
+{
+ files.rc.<name>.longrun.pipeline-name = null;
+}
+Dependency hierarchy are calculated at activation time.
+See S6 documentation +for more info
+null or non-empty string
+{
+ files.rc.<name>.longrun.producer-for = "willReadMyLog";
+}
+{
+ files.rc.<name>.longrun.producer-for = null;
+}
+It make your service start script be called with s6-notifyoncheck.
+See also ready-descriptor.
+null or (submodule)
+{
+ files.rc.<name>.longrun.readiness = {
+ command = "curl https://localhost";
+ };
+}
+{
+ files.rc.<name>.longrun.readiness = null;
+}
+unsigned integer, meaning >=0
+{
+ files.rc.<name>.longrun.readiness.attempts = 30;
+}
+{
+ files.rc.<name>.longrun.readiness.attempts = 7;
+}
+If not defined {name}-ready is assumed to be command to run
+null or non-empty string
+{
+ files.rc.<name>.longrun.readiness.command = "curl -sSf http://localhost:8080";
+}
+{
+ files.rc.<name>.longrun.readiness.command = null;
+}
+boolean
+{
+ files.rc.<name>.longrun.readiness.fork-fork = true;
+}
+{
+ files.rc.<name>.longrun.readiness.fork-fork = false;
+}
+unsigned integer, meaning >=0
+{
+ files.rc.<name>.longrun.readiness.initial-delay = 10;
+}
+{
+ files.rc.<name>.longrun.readiness.initial-delay = 50;
+}
+unsigned integer, meaning >=0
+{
+ files.rc.<name>.longrun.readiness.interval = 1000;
+}
+{
+ files.rc.<name>.longrun.readiness.interval = 100;
+}
+unsigned integer, meaning >=0
+{
+ files.rc.<name>.longrun.readiness.timeout = 3000;
+}
+{
+ files.rc.<name>.longrun.readiness.timeout = 2000;
+}
+ready
+notification method
If value any value other then 0, 1 or 2, this +service uses file-descriptor notification method
+If attr readiness is defined, use pooling as notification method
null or unsigned integer, meaning >=0
+{
+ files.rc.<name>.longrun.ready-descriptor = 3;
+}
+{
+ files.rc.<name>.longrun.ready-descriptor = null;
+}
+unsigned integer, meaning >=0
+{
+ files.rc.<name>.longrun.signal = 3;
+}
+{
+ files.rc.<name>.longrun.signal = 15;
+}
+If not defined {name}-start is assumed to be command to run
+
+Example for non execline scripts:
+
+```nix
+files.rc.alo.oneshot.start =
+# creates a python script to run when srv start
+# and save it at nix store
+let start = pkgs.writeScript "mySrvStartScript"
+''
+ #!/usr/bin/env -S python
+ print("Alô!") # is hello in portuguese
+'';
+# use the nix store address
+in "${start}";
+```</para>
+null or non-empty string
+{
+ files.rc.<name>.longrun.start = "mysqld";
+}
+{
+ files.rc.<name>.longrun.start = null;
+}
+If not defined {name}-stop is assumed to be command to run
+Example for non execline scripts:
+files.rc.alo.oneshot.stop =
+# creates a python script to run when srv stop
+# and save it at nix store
+let stop = pkgs.writeScript "mySrvStopScript"
+''
+ #!/usr/bin/env -S bash
+ echo "Tchau!" # is bye in portuguese
+'';
+# use the nix store address
+in "${stop}";
+```</para>
+
+#### type
+
+null or non-empty string
+
+#### example
+
+```nix
+{
+ files.rc.<name>.longrun.stop = "abSUrDO kill -9 1 1";
+}
+{
+ files.rc.<name>.longrun.stop = null;
+}
+ready in X milliseconds or it will
+considered a failure transition.
If null or 0 system will wait indefinitely
+unsigned integer, meaning >=0
+{
+ files.rc.<name>.longrun.timeout = 10000;
+}
+{
+ files.rc.<name>.longrun.timeout = 0;
+}
+stoped in X milliseconds or it will
+considered a failure transition.
If null or 0 system will wait indefinitely
+unsigned integer, meaning >=0
+{
+ files.rc.<name>.longrun.timeout-down = 10000;
+}
+{
+ files.rc.<name>.longrun.timeout-down = 0;
+}
+oneshot is a change in the system state
Applications examples:
+null or (submodule)
+{
+ files.rc.<name>.oneshot = {
+ dependencies = [
+ "holyMoses"
+ ];
+ setup = {
+ example = "echo Hello World > $PRJ_DATA_DIR/hello.txt";
+ };
+ timeout = 2000;
+ };
+}
+{
+ files.rc.<name>.oneshot = null;
+}
+ready to this
+service work.
Dependency hierarchy are calculated at activation time.
+list of non-empty string
+{
+ files.rc.<name>.oneshot.deps = [
+ "myDependency"
+ ];
+}
+{
+ files.rc.<name>.oneshot.deps = [ ];
+}
+It means some commands may work to stop these services
+boolean
+{
+ files.rc.<name>.oneshot.essential = true;
+}
+{
+ files.rc.<name>.oneshot.essential = false;
+}
+If not defined {name}-start is assumed to be command to run
+Example for non execline scripts:
+files.rc.alo.oneshot.start =
+# creates a python script to run when srv start
+# and save it at nix store
+let start = pkgs.writeScript "mySrvStartScript"
+''
+ #!/usr/bin/env -S python
+ print("Alô!") # is hello in portuguese
+'';
+# use the nix store address
+in "${start}";
+```</para>
+
+#### type
+
+null or non-empty string
+
+#### example
+
+```nix
+{
+ files.rc.<name>.oneshot.start = "echo Hello World > $PRJ_DATA_DIR/hello.txt";
+}
+{
+ files.rc.<name>.oneshot.start = null;
+}
+If not defined {name}-stop is assumed to be command to run
+Example for non execline scripts:
+files.rc.alo.oneshot.stop =
+# creates a python script to run when srv stop
+# and save it at nix store
+let stop = pkgs.writeScript "mySrvStopScript"
+''
+ #!/usr/bin/env -S bash
+ echo "Tchau!" # is bye in portuguese
+'';
+# use the nix store address
+in "${stop}";
+```</para>
+
+#### type
+
+null or non-empty string
+
+#### example
+
+```nix
+{
+ files.rc.<name>.oneshot.stop = "rm $PRJ_DATA_DIR/hello.txt";
+}
+{
+ files.rc.<name>.oneshot.stop = null;
+}
+ready in X milliseconds or it will
+considered be in failure status.
If null or 0 system will wait indefinitely
+unsigned integer, meaning >=0
+{
+ files.rc.<name>.oneshot.timeout = 10000;
+}
+{
+ files.rc.<name>.oneshot.timeout = 0;
+}
+milliseconds or it will
+considered be in failure status.
If null or 0 system will wait indefinitely
+unsigned integer, meaning >=0
+{
+ files.rc.<name>.oneshot.timeout-down = 10000;
+}
+{
+ files.rc.<name>.oneshot.timeout-down = 0;
+}
+{name} must be a executable command that runs forever.
+Optionally could exist a {name}-finish command to stop it properly.
+Optionally could exist a {name}-log command to log it properly.
+Default log informations goes to $PRJ_SVCS_LOG/{name}/current .
+initSvcs is a special name to auto start the process supervisor
+s6, it control all other services.
If we don't set initSvcs service, we can start it running initSvcs.
stopSvcsd is a special name to auto stop the process supervisor
+If S6 wont stop by itself, we could run stopSvcs when it's done.
It defines two env vars:
+See S6 documentation.
+We can use config.files.alias to help create your services scripts.
+examples:
+Use some program as service
+Configure httplz (http static server) as service
+{
+ # # Make services start when you enter in shell
+ # files.services.initSvcs = true;
+
+ # static http service
+ files.cmds.httplz = true; # Install httplz
+ files.services.httpd = true; # Use cmd 'httpd' as service
+ files.alias.httpd = ''
+ # This is an alias of httplz
+ cd $PRJ_ROOT/gh-pages
+ mdbook build
+
+ # IMPORTANT NOTE:
+ # if we don't use `exec` it may not stop with stopSvcs
+ exec httplz --port 8022 $PRJ_ROOT/gh-pages/book/
+ '';
+
+ # greeting service
+ files.cmds.notify-desktop = true; # Install notify-desktop
+ files.services.greet = true; # Use cmd 'greet' as service
+ files.alias.greet = ''
+ # Greet people
+ notify-desktop -i network-server "Welcome";
+
+ # our stdout goes to .data/log/greet
+ echo Dornröschen
+
+ # if service ends, it will restarted
+ # we sleep emulating some actual service
+ exec sleep infinity
+ '';
+ files.alias.greet-finish = ''
+ notify-desktop -i network-server "See you later"
+ echo wake up little Suzie
+ '';
+
+ # This is a service to speedup direnv
+ files.direnv.auto-build.enable = true;
+
+ # special service to auto start
+ files.services.initSvcs = true;
+
+ # special service to auto stopSvcs
+ files.services.stopSvcsd = true;
+
+
+ # # RC (unstable) is another interface it uses s6-rc
+ # # http://skarnet.org/software/s6-rc/why.html
+ #
+ # files.rc.hello.enable = true;
+ # files.rc.hello.oneshot.start = ''wait 1000000 "hello world"'';
+ # files.rc.hello.oneshot.stop = ''echo "bye bye world"'';
+ # files.rc.hello.oneshot.timeout = 1200;
+ #
+ # files.rc.olla.enable = true;
+ # files.rc.olla.longrun.start = ''echo "hello world"'';
+ # files.rc.olla.longrun.stop = ''echo "bye bye world"'';
+ # files.rc.olla.longrun.deps = ["hello"];
+ #
+ # files.rc.hellos.enable = true;
+ # files.rc.hellos.bundle.deps = ["hello" "olla"];
+}
+
+Create your own service with bash
+{
+ # Make all services start when you enter in shell
+ files.services.initSvcs = true;
+
+ # Use hello configured below as service
+ files.services.hello = true;
+
+ # Creates an hello command in terminal
+ files.alias.hello = ''
+ while :
+ do
+ echo "Hello World!"
+ sleep 60
+ done
+ '';
+}
+Know bugs:
+If we don't use exec in our alias, some necromancer could
+form an army of undead process, and start a war against our
+system, since they both may require the most scarse resource
+of our lands.
attribute set of boolean
+{
+ files.services = {
+ hello = true;
+ };
+}
+{
+ files.services = { };
+}
+boolean
+{
+ files.license.enable = true;
+}
+{
+ files.license.enable = false;
+}
+submodule
+{
+ files.license.spdx = {
+ name = "MIT";
+ vars = {
+ "copyright holders" = "Cruel Intentions";
+ year = "2021";
+ };
+ };
+}
+{
+ files.license.spdx = { };
+}
+string
+{
+ files.license.spdx.name = "MIT";
+}
+attribute set of string
+{
+ files.license.spdx.vars = {
+ OWNER = "cruel-intentions";
+ "URL for Development Group/Institution" = "https://github.com/cruel-intentions";
+ year = "2021";
+ "yyyy, yyyy" = "2021, 2099";
+ };
+}
+{
+ files.license.spdx.vars = { };
+}
+attribute set of strings concatenated with "\n"
+{
+ files.text = {
+ "/hello.txt" = ''
+ ((((( ********* ****
+ ((((((( ********* *******
+ ((((((((( .********* *********
+ ((((((((( ********* *********
+ ((((((((( *****************
+ ((((((((( **************
+ (((((((((((((((((((((((((((((((( *********** (
+ (((((((((((((((((((((((((((((((((((( ********* (((((
+ (((((((((((((((((((((((((((((((((((((( ********* (((((((
+ ********* ********* /((((((((
+ ********* ********* (((((((((
+ ********* ******* ((((((((/
+ ********* **** (((((((((
+ ***********************. ,* (((((((((((((((((((((.
+ *********************** ((((((((((((((((((((((((
+ *********************.(( ((((((((((((((((((((((((
+ ********* (((((( (((((((((
+ ********* (((((((( (((((((((
+ ********* ((((((((( (((((((((
+ ********* (((((((((
+ .***** /((((((((**************************************
+ *** *((((((((( **********************************
+ (((((((((((( *******************************,
+ ((((((((((((((( ,********
+ (((((((((((((((((( *********
+ ((((((((( ((((((((( *********
+ ((((((((( ((((((((( *********
+ (((((( ((((((((( ******
+ '';
+ };
+}
+{
+ files.text = { };
+}
+attribute set of (JSON value)
+{
+ files.toml = {
+ "/hellaos.toml" = {
+ greeting = "hello World";
+ };
+ "/hellows.toml" = {
+ greetings = [
+ [
+ "Hello World"
+ ]
+ [
+ "Ola Mundo"
+ [
+ "Holla Que Tal"
+ ]
+ ]
+ ];
+ };
+ };
+}
+{
+ files.toml = { };
+}
+submodule
+lazy attribute set of (submodule)
+{
+ files.watch = {
+ FOO = {
+ cmd = "echo $file $dir $time $events";
+ event = {
+ modify = true;
+ };
+ exclude = ".+\\.png$";
+ files = "$PRJ_ROOT/src";
+ include = ".+\\.js$";
+ recursive = true;
+ };
+ };
+}
+{
+ files.watch = { };
+}
+boolean
+{
+ files.watch.<name>.enable = true;
+}
+string
+submodule
+{
+ files.watch.<name>.event = { };
+}
+boolean
+{
+ files.watch.<name>.event.access = false;
+}
+boolean
+{
+ files.watch.<name>.event.attrib = false;
+}
+boolean
+{
+ files.watch.<name>.event.close = false;
+}
+boolean
+{
+ files.watch.<name>.event.close_nonwrite = false;
+}
+boolean
+{
+ files.watch.<name>.event.close_write = false;
+}
+boolean
+{
+ files.watch.<name>.event.create = false;
+}
+boolean
+{
+ files.watch.<name>.event.delete = false;
+}
+boolean
+{
+ files.watch.<name>.event.modify = true;
+}
+boolean
+{
+ files.watch.<name>.event.move = false;
+}
+boolean
+{
+ files.watch.<name>.event.move_from = false;
+}
+boolean
+{
+ files.watch.<name>.event.move_to = false;
+}
+boolean
+{
+ files.watch.<name>.event.open = false;
+}
+boolean
+{
+ files.watch.<name>.event.unmount = false;
+}
+string
+{
+ files.watch.<name>.exclude = "(.*/\\.|.+~$)";
+}
+string
+{
+ files.watch.<name>.excludei = "";
+}
+strings concatenated with "\n"
+{
+ files.watch.<name>.files = "$PRJ_ROOT";
+}
+boolean
+{
+ files.watch.<name>.follow = false;
+}
+string
+{
+ files.watch.<name>.include = "";
+}
+string
+{
+ files.watch.<name>.includei = "";
+}
+boolean
+{
+ files.watch.<name>.recursive = true;
+}
+string
+{
+ files.watch.<name>.timefmt = "%FT%T.000%zZ";
+}
+attribute set of (JSON value)
+{
+ files.yaml = {
+ "/hellaos.yaml" = {
+ greeting = "hello World";
+ };
+ "/hellows.yaml" = {
+ greetings = [
+ [
+ "Hello World"
+ ]
+ [
+ "Ola Mundo"
+ [
+ "Holla Que Tal"
+ ]
+ ]
+ ];
+ };
+ };
+}
+{
+ files.yaml = { };
+}
+Jump this part if aready know Nix Lang, if don't there is a small concise content of Nix Lang.
+If one page is too much to you, the basic is:
+: defines a new function, arg: "Hello ${arg}"= instaed of :, { attr-key = "value"; }; instead of , and they aren't optional, ie. [ "some" "value" ]Helps static file/configuration creation with Nix and devshell.
+There is a bunch of ways static file/configuration are hard, this will help you generate, validate and distribute JSON, YAML, TOML or TXT.
+Your content will be defined in Nix Language, it means you can use variables, functions, imports, read files, etc.
+The modular system helps layering configurations, hiding complexity and making it easier for OPS teams.
+Your content modules could optionally be well defined and type checked in build proccess with this same tool.
+Or you could use Nix as package manager and install any tool to validate your configuration (ie integrating it with existing JSON Schema).
+Nix integrates well with git and http, it could be also used to read JSON, YAML, TOML, zip and gz files.
+In fact Nix isn't a configuration tool but a package manger, we are only using it as configuration tool because the language is simple and flexible.
+You can recreate files of a repository directly to your local machine by running nix develop <flake-uri> --build, example:
# copy all my dogfood to your current folder
+nix develop github:cruel-intentions/devshell-files --build
+With help of Nix and devshell you could install any development or deployment tool of its 80 000 packages.
+Installing Nix
+curl -sSf -L https://install.determinate.systems/nix | sh -s -- install
+Configuring new projects:
+nix flake new -t github:cruel-intentions/devshell-files my-project
+cd my-project
+git init
+git add *.nix flake.lock
+Configuring existing projects:
+nix flake new -t github:cruel-intentions/devshell-files ./
+git add *.nix
+git add flake.lock
+nix develop --build
+or entering in shell with all commands and alias
+nix develop -c $SHELL
+# to list commands and alias
+# now run: menu
+Creating JSON, TEXT, TOML or YAML files
+# examples/hello.nix
+#
+# this is one nix file
+{
+ files.json."/generated/hello.json".hello = "world";
+ files.toml."/generated/hello.toml".hello = "world";
+ files.yaml."/generated/hello.yaml".hello = "world";
+ files.hcl."/generated/hello.hcl".hello = "world";
+ files.text."/generated/hello.txt" = "world";
+}
+
+Your file can be complemented with another module
+# examples/world.nix
+# almost same as previous example
+# but show some language feature
+let
+ name = "hello"; # a variable
+in
+{
+ files = {
+ json."/generated/${name}.json".baz = ["foo" "bar" name];
+ toml."/generated/${name}.toml".baz = ["foo" "bar" name];
+ yaml = {
+ "/generated/${name}.yaml" = {
+ baz = [
+ "foo"
+ "bar"
+ name
+ ];
+ };
+ };
+ };
+}
+
+Content generated by those examples are in generated
+# ie ./generated/hello.yaml
+baz:
+ - foo
+ - bar
+ - hello
+hello: world
+
+This project is configured by module project.nix
+# ./project.nix
+{
+ # import other modules
+ imports = [
+ ./examples/hello.nix
+ ./examples/world.nix
+ ./examples/readme.nix
+ ./examples/gitignore.nix
+ ./examples/license.nix
+ ./examples/docs.nix
+ ./examples/book.nix
+ ./examples/services.nix
+ ./examples/nim.nix
+ ./examples/nushell.nix
+ ./examples/watch.nix
+ ];
+
+ # install development or deployment tools
+ packages = [
+ "convco"
+ # now we can use 'convco' command https://convco.github.io
+
+ # but could be:
+ # "awscli"
+ # "azure-cli"
+ # "cargo"
+ # "conda"
+ # "go"
+ # "nim"
+ # "nodejs"
+ # "nodejs-18_x"
+ # "nushell"
+ # "pipenv"
+ # "python39"
+ # "ruby"
+ # "rustc"
+ # "terraform"
+ # "yarn"
+ # look at https://search.nixos.org for more packages
+ ];
+
+ # create alias
+ files.alias.feat = ''convco commit --feat $@'';
+ files.alias.fix = ''convco commit --fix $@'';
+ files.alias.docs = ''convco commit --docs $@'';
+ files.alias.alou = ''
+ #!/usr/bin/env python
+ print("Alo!") # is hello in portuguese
+ '';
+
+ # now we can use feat, fix, docs and alou commands
+
+ # create .envrc for direnv
+ files.direnv.enable = true;
+
+ # disabe file creation when entering in the shell
+ # call devshell-files instead
+ # files.on-call = true;
+}
+
+This README.md is also a module defined as above
+# There is a lot things we could use to write static file
+# Basic intro to nix language https://github.com/tazjin/nix-1p
+# Some nix functions https://teu5us.github.io/nix-lib.html
+{lib, ...}:
+{
+ files.text."/README.md" = builtins.concatStringsSep "\n" [
+ "# Devshell Files Maker"
+ (builtins.readFile ./readme/toc.md)
+ (builtins.readFile ./readme/about.md)
+ (builtins.readFile ./readme/installation.md)
+ (builtins.import ./readme/examples.nix)
+ ((builtins.import ./readme/modules.nix) lib)
+ (builtins.readFile ./readme/todo.md)
+ (builtins.readFile ./readme/issues.md)
+ (builtins.readFile ./readme/seeAlso.md)
+ ];
+}
+
+Our .gitignore is defined like this
+# ./examples/gitignore.nix
+{
+ # create my .gitignore copying ignore patterns from
+ # github.com/github/gitignore
+ files.gitignore.enable = true;
+ files.gitignore.template."Global/Archives" = true;
+ files.gitignore.template."Global/Backup" = true;
+ files.gitignore.template."Global/Diff" = true;
+ files.gitignore.pattern."**/.data" = true;
+ files.gitignore.pattern."**/.direnv" = true;
+ files.gitignore.pattern."**/.envrc" = true;
+ files.gitignore.pattern."**/.gitignore" = true;
+ files.gitignore.pattern."**/flake.lock" = true;
+}
+
+And our LICENSE file is
+# ./examples/license.nix
+{
+ # LICENSE file creation
+ # using templates from https://github.com/spdx/license-list-data
+ files.license.enable = true;
+ files.license.spdx.name = "MIT";
+ files.license.spdx.vars.year = "2023";
+ files.license.spdx.vars."copyright holders" = "Cruel Intentions";
+}
+
+Jump this part if aready know Nix Lang, if don't there is a small concise content of Nix Lang.
+If one page is too much to you, the basic is:
+: defines a new function, arg: "Hello ${arg}"= instaed of :, { attr-key = "value"; }; instead of , and they aren't optional, ie. [ "some" "value" ]| name | JSON | NIX |
|---|---|---|
| null | null | null |
| bool | true | true |
| int | 123 | 123 |
| float | 12.3 | 12.3 |
| string | "string" | "string" |
| array | ["some","array"] | ["some" "array"] |
| object | {"some":"value"} | { some = "value"; } |
| multiline-string | ''... multiline string ... '' | |
| variables | let my-var = 1; other-var = 2; in my-var + other-var | |
| function | my-arg: "Hello ${my-arg}!" | |
| variable-function | let my-function = my-arg: "Hello ${my-arg}!"; in ... | |
| calling-a-function | ... in my-function "World" |
Modules can be defined in two formats:
+{ # <|
+ imports = []; # |
+ config = {}; # | module result
+ options = {}; # |
+} # <|
+Functions has following arguments:
+config with all evaluated configs values, pkgs with all nixpkgs available.lib library of useful functions.... to ignore them){ config, pkgs, lib, ... }: # <| function args
+{ # <|
+ imports = []; # |
+ config = {}; # | module result
+ options = {}; # |
+} # <|
+All those attributes are optional
+Hint, split modules in two files:
+It has two advantages, let share options definitions across projects more easily.
+And it hides complexity, hiding complexity is what abstraction is all about, +we didn't share options definitions across projects to type less, but because we could reuse an abstraction that helps hiding complexity.
+Points to other modules files to be imported in this module
+{
+ imports = [
+ ./gh-actions-options.nix
+ ./some-other-module.nix
+ ];
+}
+Are values to our options
+{
+ config.gh-actions.setup = "npm i";
+}
+Use builtin functions to import nix/json/toml/text files.
+{ lib, ...}:
+{
+ config.files.text."/hi.txt" = (builtins.import ./hello.nix ).msg; # { msg = "Hello World!"; }
+ config.files.text."/hI.txt" = (lib.importJSON ./hello.json).msg; # { "msg": "Hello World!" }
+ config.files.text."/h1.txt" = (lib.importTOML ./hello.toml).msg; # msg = Hello World!
+ config.files.text."/Hi.txt" = builtins.readFile ./hello.txt; # Hello World!
+}
+If file has no options., config. can be ommited.
And this file produce the same result
+{ lib, ...}:
+{
+ files.text."/hi.txt" = (builtins.import ./hello.nix ).msg; # { msg = "Hello World!"; }
+ files.text."/hI.txt" = (lib.importJSON ./hello.json).msg; # { "msg": "Hello World!" }
+ files.text."/h1.txt" = (lib.importTOML ./hello.toml).msg; # msg = Hello World!
+ files.text."/Hi.txt" = builtins.readFile ./hello.txt; # Hello World!
+ gh-actions.setup = "npm i";
+}
+Options are schema definition for config.
+Example, to create a github action file, it could be done like this:
+{
+ files.yaml."/.github/workflows/ci-cd.yaml" = {
+ on = "push";
+ jobs.ci-cd.runs-on = "ubuntu-latest";
+ jobs.ci-cd.steps = [
+ { uses = "actions/checkout@v2.4.0"; }
+ { run = "npm i"; }
+ { run = "npm run build"; }
+ { run = "npm run test"; }
+ { run = "aws s3 sync ./build s3://some-s3-bucket"; }
+ ];
+ };
+}
+No complexity has been hidden, and requires copy and past it in every project.
+Since most CI/CD are just: 'Pre Build', 'Build', 'Test', 'Deploy'
+What project user really needs to define is:
+# any module file (maybe project.nix)
+{
+ # our build steps
+ gh-actions.setup = "npm i";
+ gh-actions.build = "npm run build";
+ gh-actions.test = "npm run test";
+ gh-actions.deploy = "aws s3 sync ./build s3://some-s3-bucket";
+}
+Adding this to project.nix, throw an error undefined config.gh-actions, and command fails.
To create it, add options definition of that.
# gh-actions-options.nix
+{ lib, ...}:
+{
+ # defines a property 'gh-actions.setup'
+ options.gh-actions.setup = lib.mkOption {
+ default = "echo setup";
+ description = "Command to run before build";
+ example = "npm i";
+ type = lib.types.str;
+ };
+ # defines a property 'gh-actions.build'
+ options.gh-actions.build = lib.mkOption {
+ default = "echo build";
+ description = "Command to run as build step";
+ example = "npm run build";
+ type = lib.types.str;
+ };
+ # defines a property 'gh-actions.test'
+ options.gh-actions.test = lib.mkOption {
+ default = "echo test";
+ description = "Command to run as test step";
+ example = "npm test";
+ type = lib.types.str;
+ };
+ # defines a property 'gh-actions.deploy'
+ options.gh-actions.deploy = lib.mkOption {
+ default = "echo deploy";
+ description = "Command to run as deploy step";
+ example = "aws s3 sync ./build s3://my-bucket";
+ type = lib.types.lines;
+ };
+}
+Or using lib.types.fluent
# gh-actions-options.nix
+{ lib, ...}:
+lib.types.fluent {
+ # defines a property 'gh-actions.setup'
+ options.gh-actions.options.setup.default = "echo setup"; #default is string
+ options.gh-actions.options.setup.mdDoc = "Command to run before build";
+ options.gh-actions.options.setup.example = "npm i";
+ # defines a property 'gh-actions.build'
+ options.gh-actions.options.build.default = "echo build";
+ options.gh-actions.options.build.mdDoc = "Command to run as build step";
+ options.gh-actions.options.build.example = "npm run build";
+ # defines a property 'gh-actions.test'
+ options.gh-actions.options.test.default = "echo test";
+ options.gh-actions.options.test.mdDoc = "Command to run as test step";
+ options.gh-actions.options.test.example = "npm test";
+ # defines a property 'gh-actions.deploy'
+ options.gh-actions.options.deploy.default = "echo deploy";
+ options.gh-actions.options.deploy.mdDoc = "Command to run as deploy step";
+ options.gh-actions.options.deploy.example = "aws s3 sync ./build s3://my-bucket";
+ options.gh-actions.options.deploy.type = lib.types.lines;
+}
+Now, previous config can be used, but it does nothing, it doesn't create yaml.
+It knowns what options can be accepted as config, but not what to do with it.
Usually the next part is in same file of options, it isn't a requirement, and spliting it here make it simplier to explain.
# gh-actions.nix
+{ config, lib, ... }:
+{
+ imports = [ ./gh-actions-options.nix ];
+ # use other module that simplify file creation to create config file
+ files.yaml."/.github/workflows/ci-cd.yaml".jobs.ci-cd.steps = [
+ { uses = "actions/checkout@v2.4.0"; }
+
+ { run = config.gh-actions.setup; } #
+ { run = config.gh-actions.build; } # Read step scripts from
+ { run = config.gh-actions.test; } # config.gh-actions
+ { run = config.gh-actions.deploy"; } #
+ ];
+ files.yaml."/.github/workflows/ci-cd.yaml".on = "push";
+ files.yaml."/.github/workflows/ci-cd.yaml".jobs.ci-cd.runs-on = "ubuntu-latest";
+}
+Now it can be imported and set 'setup', 'build', 'test' and 'deploy' configs
+# any other module file, maybe project.nix
+{
+ imports = [ ./gh-actions.nix ];
+ gh-actions.setup = "echo 'paranaue'";
+ gh-actions.build = "echo 'paranaue parana'";
+ gh-actions.build = "echo 'paranaue'";
+ gh-actions.deploy = ''
+ echo "paranaue
+ parana"
+ '';
+}
+If something that is not a string is set, an error will raise, cheking it against the options schema.
+There are other types that can be used (some of them):
+And lib has some modules helpers functions like:
+Now to not just copy and past it everywhere, we could create a git repository, ie. gh-actions
+Then we could let nix manage it for us adding it to flake.nix file like
+{
+ description = "Dev Environment";
+
+ inputs.dsf.url = "github:cruel-intentions/devshell-files";
+ inputs.gha.url = "github:cruel-intentions/gh-actions";
+ # for private repository use git url
+ # inputs.gha.url = "git+ssh://git@github.com/cruel-intentions/gh-actions.git";
+
+ outputs = inputs: inputs.dsf.lib.mkShell [
+ "${inputs.gha}/gh-actions.nix"
+ ./project.nix
+ ];
+}
+Or manage version adding it directly to project.nix (or any other module file)
+{
+ imports =
+ let gh-actions = builtins.fetchGit {
+ url = "git+ssh://git@github.com/cruel-intentions/gh-actions.git";
+ ref = "master";
+ rev = "46eead778911b5786d299ecf1a95c9ed4c130844";
+ };
+ in [
+ "${gh-actions}/gh-actions.nix"
+ ];
+}
+To document our modules is simple, we just need to use config.files.docs as follow
# examples/docs.nix
+
+{lib, pkgs, ...}:
+{
+ files.docs."/gh-pages/src/modules/alias.md".modules = [ ../modules/alias.nix ];
+ files.docs."/gh-pages/src/modules/cmds.md".modules = [ ../modules/cmds.nix ];
+ files.docs."/gh-pages/src/modules/files.md".modules = [ ../modules/files.nix ];
+ files.docs."/gh-pages/src/modules/git.md".modules = [ ../modules/git.nix ];
+ files.docs."/gh-pages/src/modules/on-call.md".modules = [ ../modules/startup.nix ];
+ files.docs."/gh-pages/src/modules/gitignore.md".modules = [ ../modules/gitignore.nix ];
+ files.docs."/gh-pages/src/modules/hcl.md".modules = [ ../modules/hcl.nix ];
+ files.docs."/gh-pages/src/modules/json.md".modules = [ ../modules/json.nix ];
+ files.docs."/gh-pages/src/modules/mdbook.md".modules = [ ../modules/mdbook.nix ];
+ files.docs."/gh-pages/src/modules/nim.md".modules = [ ../modules/nim.nix ];
+ files.docs."/gh-pages/src/modules/nushell.md".modules = [ ../modules/nushell.nix ];
+ files.docs."/gh-pages/src/modules/nush.md".modules = [ ../modules/nush.nix ../modules/nuon.nix ];
+ files.docs."/gh-pages/src/modules/rc.md".modules = [ ../modules/services/rc-devshell.nix ];
+ files.docs."/gh-pages/src/modules/services.md".modules = [ ../modules/services.nix ];
+ files.docs."/gh-pages/src/modules/spdx.md".modules = [ ../modules/spdx.nix ];
+ files.docs."/gh-pages/src/modules/text.md".modules = [ ../modules/text.nix ];
+ files.docs."/gh-pages/src/modules/toml.md".modules = [ ../modules/toml.nix ];
+ files.docs."/gh-pages/src/modules/watch.md".modules = [ ../modules/watch ];
+ files.docs."/gh-pages/src/modules/yaml.md".modules = [ ../modules/yaml.nix ];
+}
+
+# examples/book.nix
+
+{lib, ...}:
+let
+ project = "devshell-files";
+ author = "cruel-intentions";
+ org-url = "https://github.com/${author}";
+ edit-path = "${org-url}/${project}/edit/master/examples/{path}";
+in
+{
+ files.mdbook.authors = ["Cruel Intentions <${org-url}>"];
+ files.mdbook.enable = true;
+ files.mdbook.gh-author = author;
+ files.mdbook.gh-project = project;
+ files.mdbook.language = "en";
+ files.mdbook.multilingual = false;
+ files.mdbook.summary = builtins.readFile ./summary.md;
+ files.mdbook.title = "Nix DevShell Files Maker";
+ files.mdbook.output.html.edit-url-template = edit-path;
+ files.mdbook.output.html.fold.enable = true;
+ files.mdbook.output.html.git-repository-url = "${org-url}/${project}/tree/master";
+ files.mdbook.output.html.no-section-label = true;
+ files.mdbook.output.html.site-url = "/${project}/";
+ files.gitignore.pattern.gh-pages = true;
+ files.text."/gh-pages/src/introduction.md" = builtins.readFile ./readme/about.md;
+ files.text."/gh-pages/src/installation.md" = builtins.readFile ./readme/installation.md;
+ files.text."/gh-pages/src/examples.md" = builtins.import ./readme/examples.nix;
+ files.text."/gh-pages/src/modules.md" = "## Writing new modules";
+ files.text."/gh-pages/src/nix-lang.md" = builtins.readFile ./readme/modules/nix-lang.md;
+ files.text."/gh-pages/src/json-nix.md" = builtins.import ./readme/modules/json-vs-nix.nix lib;
+ files.text."/gh-pages/src/module-spec.md" = builtins.readFile ./readme/modules/modules.md;
+ files.text."/gh-pages/src/share.md" = builtins.readFile ./readme/modules/share.md;
+ files.text."/gh-pages/src/document.md" = builtins.import ./readme/modules/document.nix;
+ files.text."/gh-pages/src/builtins.md" = builtins.readFile ./readme/modules/builtins.md;
+ files.text."/gh-pages/src/todo.md" = builtins.readFile ./readme/todo.md;
+ files.text."/gh-pages/src/issues.md" = builtins.readFile ./readme/issues.md;
+ files.text."/gh-pages/src/seeAlso.md" = builtins.readFile ./readme/seeAlso.md;
+ files.alias.publish-as-gh-pages-from-local = ''
+ # same as publish-as-gh-pages but works local
+ cd $PRJ_ROOT
+ ORIGIN=`git remote get-url origin`
+ cd gh-pages
+ mdbook build
+ cd book
+ git init .
+ git add .
+ git checkout -b gh-pages
+ git commit -m "docs(gh-pages): update gh-pages" .
+ git remote add origin $ORIGIN
+ git push -u origin gh-pages --force
+ '';
+}
+
+And publish this mdbook to github pages with book-as-gh-pages alias.
Builtin Modules are modules defined with this same package.
+They are already included when we use this package.
+files.alias, create bash script aliasfiles.cmds, install packages from nix repositoryfiles.docs, convert our modules file into markdown using nmdfiles.git, configure git with file creationfiles.on-call, connfigure file to created only when devshell-files command is called, not on shell startfiles.gitignore, copy .gitignore from templatesfiles.hcl, create HCL files with nix syntaxfiles.json, create JSON files with nix syntaxfiles.mdbook, convert your markdown files to HTML using mdbookfiles.nim, similar to files.alias, but compiles Nim codefiles.nus, similar to files.alias, but runs in Nushellfiles.nush, similar to files.nus, but for subcommandsfiles.services, process supervisor for development services using s6files.rc , WIP, process supervisor for development services using s6-rcfiles.spdx, copy LICENSE from templatesfiles.text, create free text files with nix syntaxfiles.toml, create TOML files with nix syntaxfiles.watch, create an alias and service to run command when file changes using inotify-toolsfiles.yaml, create YAML files with nix syntaxOur documentation is generated by files.text, files.docs and files.mdbook
attribute set of Concatenated string
+{
+ files.alias = {
+ hello = "echo hello";
+ world = ''
+ #!/usr/bin/env python
+ print("world")
+ '';
+ };
+}
+{
+ files.alias = { };
+}
+https://search.nixos.org for more tools
+attribute set of boolean
+{
+ files.cmds = {
+ awscli = true;
+ azure-cli = true;
+ cargo = true;
+ conda = true;
+ convco = true;
+ go_1_17 = true;
+ nodejs-16_x = true;
+ pipenv = true;
+ python39 = true;
+ ruby_3_0 = true;
+ rustc = true;
+ terraform = true;
+ yarn = true;
+ };
+}
+{
+ files.cmds = { };
+}
+attribute set of (submodule)
+{
+ file = { };
+}
+null or boolean
+{
+ file.<name>.executable = null;
+}
+null or boolean
+{
+ file.<name>.git-add = null;
+}
+null or boolean
+{
+ file.<name>.on-enter = true;
+}
+path
+string
+{
+ file.<name>.target = <name>;
+}
+null or strings concatenated with "\n"
+{
+ file.<name>.text = null;
+}
+boolean
+{
+ files.git.auto-add = true;
+}
+{
+ files.git.auto-add = false;
+}
+boolean
+{
+ files.gitignore.enable = true;
+}
+{
+ files.gitignore.enable = false;
+}
+attribute set of boolean
+{
+ files.gitignore.pattern = {
+ "ignore-this-file.txt" = true;
+ };
+}
+{
+ files.gitignore.pattern = { };
+}
+attribute set of boolean
+{
+ files.gitignore.template = {
+ Android = true;
+ "community/AWS/SAM" = true;
+ };
+}
+{
+ files.gitignore.template = { };
+}
+attribute set of (JSON value)
+{
+ files.hcl = {
+ "/hellaos.hcl" = {
+ greeting = "hello World";
+ };
+ "/hellows.hcl" = {
+ greetings = [
+ [
+ "Hello World"
+ ]
+ [
+ "Ola Mundo"
+ [
+ "Holla Que Tal"
+ ]
+ ]
+ ];
+ };
+ };
+}
+{
+ files.hcl = { };
+}
+attribute set of (JSON value)
+{
+ files.json = {
+ "/hellaos.json" = {
+ greeting = "hello World";
+ };
+ "/hellows.json" = {
+ greetings = [
+ [
+ "Hello World"
+ ]
+ [
+ "Ola Mundo"
+ [
+ "Holla Que Tal"
+ ]
+ ]
+ ];
+ };
+ };
+}
+{
+ files.json = { };
+}
+by default it creates gh-pages/mdbook.toml and gh-pages/src/SUMMARY.md
+It also create publish-as-gh-pages helper
+#examples/book.nix
+
+{lib, ...}:
+let
+ project = "devshell-files";
+ author = "cruel-intentions";
+ org-url = "https://github.com/${author}";
+ edit-path = "${org-url}/${project}/edit/master/examples/{path}";
+in
+{
+ files.mdbook.authors = ["Cruel Intentions <${org-url}>"];
+ files.mdbook.enable = true;
+ files.mdbook.gh-author = author;
+ files.mdbook.gh-project = project;
+ files.mdbook.language = "en";
+ files.mdbook.multilingual = false;
+ files.mdbook.summary = builtins.readFile ./summary.md;
+ files.mdbook.title = "Nix DevShell Files Maker";
+ files.mdbook.output.html.edit-url-template = edit-path;
+ files.mdbook.output.html.fold.enable = true;
+ files.mdbook.output.html.git-repository-url = "${org-url}/${project}/tree/master";
+ files.mdbook.output.html.no-section-label = true;
+ files.mdbook.output.html.site-url = "/${project}/";
+ files.gitignore.pattern.gh-pages = true;
+ files.text."/gh-pages/src/introduction.md" = builtins.readFile ./readme/about.md;
+ files.text."/gh-pages/src/installation.md" = builtins.readFile ./readme/installation.md;
+ files.text."/gh-pages/src/examples.md" = builtins.import ./readme/examples.nix;
+ files.text."/gh-pages/src/modules.md" = "## Writing new modules";
+ files.text."/gh-pages/src/nix-lang.md" = builtins.readFile ./readme/modules/nix-lang.md;
+ files.text."/gh-pages/src/json-nix.md" = builtins.import ./readme/modules/json-vs-nix.nix lib;
+ files.text."/gh-pages/src/module-spec.md" = builtins.readFile ./readme/modules/modules.md;
+ files.text."/gh-pages/src/share.md" = builtins.readFile ./readme/modules/share.md;
+ files.text."/gh-pages/src/document.md" = builtins.import ./readme/modules/document.nix;
+ files.text."/gh-pages/src/builtins.md" = builtins.readFile ./readme/modules/builtins.md;
+ files.text."/gh-pages/src/todo.md" = builtins.readFile ./readme/todo.md;
+ files.text."/gh-pages/src/issues.md" = builtins.readFile ./readme/issues.md;
+ files.text."/gh-pages/src/seeAlso.md" = builtins.readFile ./readme/seeAlso.md;
+ files.alias.publish-as-gh-pages-from-local = ''
+ # same as publish-as-gh-pages but works local
+ cd $PRJ_ROOT
+ ORIGIN=`git remote get-url origin`
+ cd gh-pages
+ mdbook build
+ cd book
+ git init .
+ git add .
+ git checkout -b gh-pages
+ git commit -m "docs(gh-pages): update gh-pages" .
+ git remote add origin $ORIGIN
+ git push -u origin gh-pages --force
+ '';
+}
+
+submodule
+{
+ files.mdbook = { };
+}
+boolean
+{
+ files.mdbook.enable = true;
+}
+{
+ files.mdbook.enable = false;
+}
+null or (non-empty (list of string))
+{
+ files.mdbook.authors = [
+ "Cruel Intentions"
+ ];
+}
+{
+ files.mdbook.authors = null;
+}
+JSON value
+{
+ files.mdbook.build = {
+ build-dir = "book";
+ };
+}
+{
+ files.mdbook.build = { };
+}
+null or string
+{
+ files.mdbook.description = "Modules Docummentation";
+}
+{
+ files.mdbook.description = null;
+}
+null or string
+{
+ files.mdbook.gh-author = "cruel-intentions";
+}
+{
+ files.mdbook.gh-author = null;
+}
+null or string
+{
+ files.mdbook.gh-project = "devshell-files";
+}
+{
+ files.mdbook.gh-project = null;
+}
+null or non-empty string
+{
+ files.mdbook.language = "en";
+}
+{
+ files.mdbook.language = null;
+}
+boolean
+{
+ files.mdbook.multilingual = true;
+}
+{
+ files.mdbook.multilingual = false;
+}
+JSON value
+{
+ files.mdbook.output = {
+ html = {
+ fold = {
+ enable = true;
+ };
+ };
+ };
+}
+{
+ files.mdbook.output = { };
+}
+JSON value
+{
+ files.mdbook.preprocessor = {
+ mathjax = {
+ renderers = [
+ "html"
+ ];
+ };
+ };
+}
+{
+ files.mdbook.preprocessor = { };
+}
+non-empty string
+{
+ files.mdbook.root-dir = "/gh-pages";
+}
+{
+ files.mdbook.root-dir = "/gh-pages";
+}
+JSON value
+{
+ files.mdbook.rust = {
+ edition = "2018";
+ };
+}
+{
+ files.mdbook.rust = { };
+}
+strings concatenated with "\n"
+{
+ files.mdbook.summary = ''
+ # SUMMARY
+ - [Intro](./intro.md)
+ '';
+}
+{
+ files.mdbook.summary = ''
+ # SUMMARY
+ '';
+}
+null or string
+{
+ files.mdbook.title = "Devshell Files Modules";
+}
+{
+ files.mdbook.title = null;
+}
+boolean
+{
+ files.mdbook.use-default-preprocessor = false;
+}
+{
+ files.mdbook.use-default-preprocessor = true;
+}
+It includes some helpers and libraries for laziness, so it better +fit prototyping and simples commands/script.
+Vars:
+let PRJ_DATA_DIR = env "PRJ_DATA_DIR"Procs:
+1.arg"PRJ_DATA_DIR".env"foo/0/^1/0..1/0..^1/bar".jPath
+myPath / "blerg" / 0 / ^1 / 0 .. 1 / 0 .. ^1/bazmyPath.get myObjmyObj[myPath]myPath.set myObj, myValmyObj[myPath] = myValImports:
+Flags:
+-w:off -d:ssl --threads:on --mm:orc --hints:off --parallelBuild:4 --tlsEmulation:onTodo:
+Examples:
+# examples/nim.nix
+{pkgs, ...}:{
+ # compile nim files and them to shell
+ files.nim.helloNim = ''echo ARGS'';
+ # keep an /tmp file with last result for n seconds
+ files.nim.memoise = builtins.readFile ./nim/memoise.nim;
+ # clustersSTS is a good candidate to be used with services
+ files.nim.clustersSTS = builtins.readFile ./nim/clustersSTS.nim;
+ # our poor man jq alternative
+ files.nim.jsonildo = builtins.readFile ./nim/jsonildo.nim;
+ files.nim.helloNimAgain.deps = [ pkgs.termbox pkgs.nimPackages.nimbox ];
+ files.nim.helloNimAgain.src = ''
+ import nimbox
+ proc main() =
+ var nb = newNimbox()
+ defer: nb.shutdown()
+
+ nb.print(0, 0, "Hello, world!")
+ nb.present()
+ sleep(1000)
+
+ when isMainModule:
+ main()
+ '';
+}
+
+```</para>
+
+#### type
+
+attribute set of ((submodule) or Concatenated string)
+
+#### example
+
+```nix
+{
+ files.nim = {
+ dokr = ''
+ // create an docker compose alias
+ // cd $PRJ_ROOT/subdir; docker "compose" $@
+ exec "docker", "compose" + ARGS, PRJ_ROOT / "subdir"
+ '';
+ hello = ''
+ #compile-at-mkshell
+
+ # by default nim commands were compiled at first run to reduce
+ # shell activation time, add comment #compile-at-mkshell to
+ # compile at shell activation
+ echo "hello"
+ '';
+ manage = ''
+ // create an pipenv alias
+ // pipenv run python ./manage.py
+ exec "pipenv", args("run python ./manage.py") + ARGS
+ '';
+ };
+}
+{
+ files.nim = { };
+}
+attribute set of (Concatenated string or list of Concatenated string)
+{
+ files.nus = {
+ hello = [
+ "name"
+ "{hello: $name}"
+ ];
+ world = ''
+ # it could use previous commands
+ hello world
+ '';
+ };
+}
+{
+ files.nus = { };
+}
+boolean
+{
+ files.nuon.enable = true;
+}
+{
+ files.nuon.enable = false;
+}
+attribute set of attribute set of (Concatenated string or list of Concatenated string)
+{
+ files.nush = {
+ hello = {
+ en = [
+ "arg"
+ "{hello: $arg}"
+ ];
+ pt = [
+ "arg"
+ "{ola: $arg}"
+ ];
+ };
+ world = {
+ hello = ''
+ # it could use previous commands
+ hello en "World"
+ hello pt "Mundo"
+ '';
+ };
+ };
+}
+{
+ files.nush = { };
+}
+All services are disabled by default.
+It will fail at activation time if:
+attribute set of (submodule)
+{
+ files.rc = {
+ hello = {
+ enable = true;
+ longrun = {
+ run = "mySquirelD";
+ };
+ };
+ hola = {
+ bundle = {
+ contents = [
+ "hello"
+ "world"
+ ];
+ };
+ enable = true;
+ };
+ world = {
+ enable = true;
+ oneshot = {
+ setup = "echo Hello World > $PRJ_DATA_DIR/hello.txt";
+ };
+ };
+ };
+}
+{
+ files.rc = { };
+}
+boolean
+{
+ files.rc.<name>.enable = true;
+}
+{
+ files.rc.<name>.enable = false;
+}
+bundle is a service aggregator
For example we can bundle every system (db, http, config) by microservice.
+Like:
+null or (submodule)
+{
+ files.rc.<name>.bundle = {
+ contents = [
+ "myFancyServiceName"
+ ];
+ essential = true;
+ };
+}
+{
+ files.rc.<name>.bundle = null;
+}
+non-empty (list of non-empty string)
+{
+ files.rc.<name>.bundle.deps = [
+ "myDep"
+ "myOtherDep"
+ ];
+}
+It means some commands may work to stop these services
+boolean
+{
+ files.rc.<name>.bundle.essential = true;
+}
+{
+ files.rc.<name>.bundle.essential = false;
+}
+longrun are commands that run as deamon (in a infinity loop).
Applications:
+null or (submodule)
+{
+ files.rc.<name>.longrun = {
+ agreement = {
+ description = "Check to confirm";
+ label = "Are you sure?";
+ };
+ };
+}
+{
+ files.rc.<name>.longrun = null;
+}
+Dependency hierarchy are calculated at activation time.
+See S6 documentation +for more info
+list of non-empty string
+{
+ files.rc.<name>.longrun.consumer-for = [
+ "myService"
+ ];
+}
+{
+ files.rc.<name>.longrun.consumer-for = [ ];
+}
+null or path
+{
+ files.rc.<name>.longrun.data = "./.data";
+}
+{
+ files.rc.<name>.longrun.data = null;
+}
+ready to this
+service work.
Dependency hierarchy are calculated at activation time.
+See S6 documentation +for more info
+list of non-empty string
+{
+ files.rc.<name>.longrun.deps = [
+ "myDependency"
+ ];
+}
+{
+ files.rc.<name>.longrun.deps = [ ];
+}
+null or path
+{
+ files.rc.<name>.longrun.env = "./.direnv";
+}
+{
+ files.rc.<name>.longrun.env = null;
+}
+It means some commands may work to stop this service
+boolean
+{
+ files.rc.<name>.longrun.essential = true;
+}
+{
+ files.rc.<name>.longrun.essential = false;
+}
+unsigned integer, meaning >=0
+{
+ files.rc.<name>.longrun.kill-after = 2005;
+}
+{
+ files.rc.<name>.longrun.kill-after = 0;
+}
+unsigned integer, meaning >=0
+{
+ files.rc.<name>.longrun.kill-finish-after = 2005;
+}
+{
+ files.rc.<name>.longrun.kill-finish-after = 0;
+}
+running
If value any value other then 0, 1 or 2, this +service uses file-descriptor lock
+null or unsigned integer, meaning >=0
+{
+ files.rc.<name>.longrun.lock-descriptor = 5;
+}
+{
+ files.rc.<name>.longrun.lock-descriptor = 0;
+}
+unsigned integer, meaning >=0
+{
+ files.rc.<name>.longrun.max-restarts = 2005;
+}
+{
+ files.rc.<name>.longrun.max-restarts = 100;
+}
+Dependency hierarchy are calculated at activation time.
+See S6 documentation +for more info
+null or non-empty string
+{
+ files.rc.<name>.longrun.pipeline-name = "logMyService";
+}
+{
+ files.rc.<name>.longrun.pipeline-name = null;
+}
+Dependency hierarchy are calculated at activation time.
+See S6 documentation +for more info
+null or non-empty string
+{
+ files.rc.<name>.longrun.producer-for = "willReadMyLog";
+}
+{
+ files.rc.<name>.longrun.producer-for = null;
+}
+It make your service start script be called with s6-notifyoncheck.
+See also ready-descriptor.
+null or (submodule)
+{
+ files.rc.<name>.longrun.readiness = {
+ command = "curl https://localhost";
+ };
+}
+{
+ files.rc.<name>.longrun.readiness = null;
+}
+unsigned integer, meaning >=0
+{
+ files.rc.<name>.longrun.readiness.attempts = 30;
+}
+{
+ files.rc.<name>.longrun.readiness.attempts = 7;
+}
+If not defined {name}-ready is assumed to be command to run
+null or non-empty string
+{
+ files.rc.<name>.longrun.readiness.command = "curl -sSf http://localhost:8080";
+}
+{
+ files.rc.<name>.longrun.readiness.command = null;
+}
+boolean
+{
+ files.rc.<name>.longrun.readiness.fork-fork = true;
+}
+{
+ files.rc.<name>.longrun.readiness.fork-fork = false;
+}
+unsigned integer, meaning >=0
+{
+ files.rc.<name>.longrun.readiness.initial-delay = 10;
+}
+{
+ files.rc.<name>.longrun.readiness.initial-delay = 50;
+}
+unsigned integer, meaning >=0
+{
+ files.rc.<name>.longrun.readiness.interval = 1000;
+}
+{
+ files.rc.<name>.longrun.readiness.interval = 100;
+}
+unsigned integer, meaning >=0
+{
+ files.rc.<name>.longrun.readiness.timeout = 3000;
+}
+{
+ files.rc.<name>.longrun.readiness.timeout = 2000;
+}
+ready
+notification method
If value any value other then 0, 1 or 2, this +service uses file-descriptor notification method
+If attr readiness is defined, use pooling as notification method
null or unsigned integer, meaning >=0
+{
+ files.rc.<name>.longrun.ready-descriptor = 3;
+}
+{
+ files.rc.<name>.longrun.ready-descriptor = null;
+}
+unsigned integer, meaning >=0
+{
+ files.rc.<name>.longrun.signal = 3;
+}
+{
+ files.rc.<name>.longrun.signal = 15;
+}
+If not defined {name}-start is assumed to be command to run
+
+Example for non execline scripts:
+
+```nix
+files.rc.alo.oneshot.start =
+# creates a python script to run when srv start
+# and save it at nix store
+let start = pkgs.writeScript "mySrvStartScript"
+''
+ #!/usr/bin/env -S python
+ print("Alô!") # is hello in portuguese
+'';
+# use the nix store address
+in "${start}";
+```</para>
+null or non-empty string
+{
+ files.rc.<name>.longrun.start = "mysqld";
+}
+{
+ files.rc.<name>.longrun.start = null;
+}
+If not defined {name}-stop is assumed to be command to run
+Example for non execline scripts:
+files.rc.alo.oneshot.stop =
+# creates a python script to run when srv stop
+# and save it at nix store
+let stop = pkgs.writeScript "mySrvStopScript"
+''
+ #!/usr/bin/env -S bash
+ echo "Tchau!" # is bye in portuguese
+'';
+# use the nix store address
+in "${stop}";
+```</para>
+
+#### type
+
+null or non-empty string
+
+#### example
+
+```nix
+{
+ files.rc.<name>.longrun.stop = "abSUrDO kill -9 1 1";
+}
+{
+ files.rc.<name>.longrun.stop = null;
+}
+ready in X milliseconds or it will
+considered a failure transition.
If null or 0 system will wait indefinitely
+unsigned integer, meaning >=0
+{
+ files.rc.<name>.longrun.timeout = 10000;
+}
+{
+ files.rc.<name>.longrun.timeout = 0;
+}
+stoped in X milliseconds or it will
+considered a failure transition.
If null or 0 system will wait indefinitely
+unsigned integer, meaning >=0
+{
+ files.rc.<name>.longrun.timeout-down = 10000;
+}
+{
+ files.rc.<name>.longrun.timeout-down = 0;
+}
+oneshot is a change in the system state
Applications examples:
+null or (submodule)
+{
+ files.rc.<name>.oneshot = {
+ dependencies = [
+ "holyMoses"
+ ];
+ setup = {
+ example = "echo Hello World > $PRJ_DATA_DIR/hello.txt";
+ };
+ timeout = 2000;
+ };
+}
+{
+ files.rc.<name>.oneshot = null;
+}
+ready to this
+service work.
Dependency hierarchy are calculated at activation time.
+list of non-empty string
+{
+ files.rc.<name>.oneshot.deps = [
+ "myDependency"
+ ];
+}
+{
+ files.rc.<name>.oneshot.deps = [ ];
+}
+It means some commands may work to stop these services
+boolean
+{
+ files.rc.<name>.oneshot.essential = true;
+}
+{
+ files.rc.<name>.oneshot.essential = false;
+}
+If not defined {name}-start is assumed to be command to run
+Example for non execline scripts:
+files.rc.alo.oneshot.start =
+# creates a python script to run when srv start
+# and save it at nix store
+let start = pkgs.writeScript "mySrvStartScript"
+''
+ #!/usr/bin/env -S python
+ print("Alô!") # is hello in portuguese
+'';
+# use the nix store address
+in "${start}";
+```</para>
+
+#### type
+
+null or non-empty string
+
+#### example
+
+```nix
+{
+ files.rc.<name>.oneshot.start = "echo Hello World > $PRJ_DATA_DIR/hello.txt";
+}
+{
+ files.rc.<name>.oneshot.start = null;
+}
+If not defined {name}-stop is assumed to be command to run
+Example for non execline scripts:
+files.rc.alo.oneshot.stop =
+# creates a python script to run when srv stop
+# and save it at nix store
+let stop = pkgs.writeScript "mySrvStopScript"
+''
+ #!/usr/bin/env -S bash
+ echo "Tchau!" # is bye in portuguese
+'';
+# use the nix store address
+in "${stop}";
+```</para>
+
+#### type
+
+null or non-empty string
+
+#### example
+
+```nix
+{
+ files.rc.<name>.oneshot.stop = "rm $PRJ_DATA_DIR/hello.txt";
+}
+{
+ files.rc.<name>.oneshot.stop = null;
+}
+ready in X milliseconds or it will
+considered be in failure status.
If null or 0 system will wait indefinitely
+unsigned integer, meaning >=0
+{
+ files.rc.<name>.oneshot.timeout = 10000;
+}
+{
+ files.rc.<name>.oneshot.timeout = 0;
+}
+milliseconds or it will
+considered be in failure status.
If null or 0 system will wait indefinitely
+unsigned integer, meaning >=0
+{
+ files.rc.<name>.oneshot.timeout-down = 10000;
+}
+{
+ files.rc.<name>.oneshot.timeout-down = 0;
+}
+{name} must be a executable command that runs forever.
+Optionally could exist a {name}-finish command to stop it properly.
+Optionally could exist a {name}-log command to log it properly.
+Default log informations goes to $PRJ_SVCS_LOG/{name}/current .
+initSvcs is a special name to auto start the process supervisor
+s6, it control all other services.
If we don't set initSvcs service, we can start it running initSvcs.
stopSvcsd is a special name to auto stop the process supervisor
+If S6 wont stop by itself, we could run stopSvcs when it's done.
It defines two env vars:
+See S6 documentation.
+We can use config.files.alias to help create your services scripts.
+examples:
+Use some program as service
+Configure httplz (http static server) as service
+{
+ # # Make services start when you enter in shell
+ # files.services.initSvcs = true;
+
+ # static http service
+ files.cmds.httplz = true; # Install httplz
+ files.services.httpd = true; # Use cmd 'httpd' as service
+ files.alias.httpd = ''
+ # This is an alias of httplz
+ cd $PRJ_ROOT/gh-pages
+ mdbook build
+
+ # IMPORTANT NOTE:
+ # if we don't use `exec` it may not stop with stopSvcs
+ exec httplz --port 8022 $PRJ_ROOT/gh-pages/book/
+ '';
+
+ # greeting service
+ files.cmds.notify-desktop = true; # Install notify-desktop
+ files.services.greet = true; # Use cmd 'greet' as service
+ files.alias.greet = ''
+ # Greet people
+ notify-desktop -i network-server "Welcome";
+
+ # our stdout goes to .data/log/greet
+ echo Dornröschen
+
+ # if service ends, it will restarted
+ # we sleep emulating some actual service
+ exec sleep infinity
+ '';
+ files.alias.greet-finish = ''
+ notify-desktop -i network-server "See you later"
+ echo wake up little Suzie
+ '';
+
+ # This is a service to speedup direnv
+ files.direnv.auto-build.enable = true;
+
+ # special service to auto start
+ files.services.initSvcs = true;
+
+ # special service to auto stopSvcs
+ files.services.stopSvcsd = true;
+
+
+ # # RC (unstable) is another interface it uses s6-rc
+ # # http://skarnet.org/software/s6-rc/why.html
+ #
+ # files.rc.hello.enable = true;
+ # files.rc.hello.oneshot.start = ''wait 1000000 "hello world"'';
+ # files.rc.hello.oneshot.stop = ''echo "bye bye world"'';
+ # files.rc.hello.oneshot.timeout = 1200;
+ #
+ # files.rc.olla.enable = true;
+ # files.rc.olla.longrun.start = ''echo "hello world"'';
+ # files.rc.olla.longrun.stop = ''echo "bye bye world"'';
+ # files.rc.olla.longrun.deps = ["hello"];
+ #
+ # files.rc.hellos.enable = true;
+ # files.rc.hellos.bundle.deps = ["hello" "olla"];
+}
+
+Create your own service with bash
+{
+ # Make all services start when you enter in shell
+ files.services.initSvcs = true;
+
+ # Use hello configured below as service
+ files.services.hello = true;
+
+ # Creates an hello command in terminal
+ files.alias.hello = ''
+ while :
+ do
+ echo "Hello World!"
+ sleep 60
+ done
+ '';
+}
+Know bugs:
+If we don't use exec in our alias, some necromancer could
+form an army of undead process, and start a war against our
+system, since they both may require the most scarse resource
+of our lands.
attribute set of boolean
+{
+ files.services = {
+ hello = true;
+ };
+}
+{
+ files.services = { };
+}
+boolean
+{
+ files.license.enable = true;
+}
+{
+ files.license.enable = false;
+}
+submodule
+{
+ files.license.spdx = {
+ name = "MIT";
+ vars = {
+ "copyright holders" = "Cruel Intentions";
+ year = "2021";
+ };
+ };
+}
+{
+ files.license.spdx = { };
+}
+string
+{
+ files.license.spdx.name = "MIT";
+}
+attribute set of string
+{
+ files.license.spdx.vars = {
+ OWNER = "cruel-intentions";
+ "URL for Development Group/Institution" = "https://github.com/cruel-intentions";
+ year = "2021";
+ "yyyy, yyyy" = "2021, 2099";
+ };
+}
+{
+ files.license.spdx.vars = { };
+}
+attribute set of strings concatenated with "\n"
+{
+ files.text = {
+ "/hello.txt" = ''
+ ((((( ********* ****
+ ((((((( ********* *******
+ ((((((((( .********* *********
+ ((((((((( ********* *********
+ ((((((((( *****************
+ ((((((((( **************
+ (((((((((((((((((((((((((((((((( *********** (
+ (((((((((((((((((((((((((((((((((((( ********* (((((
+ (((((((((((((((((((((((((((((((((((((( ********* (((((((
+ ********* ********* /((((((((
+ ********* ********* (((((((((
+ ********* ******* ((((((((/
+ ********* **** (((((((((
+ ***********************. ,* (((((((((((((((((((((.
+ *********************** ((((((((((((((((((((((((
+ *********************.(( ((((((((((((((((((((((((
+ ********* (((((( (((((((((
+ ********* (((((((( (((((((((
+ ********* ((((((((( (((((((((
+ ********* (((((((((
+ .***** /((((((((**************************************
+ *** *((((((((( **********************************
+ (((((((((((( *******************************,
+ ((((((((((((((( ,********
+ (((((((((((((((((( *********
+ ((((((((( ((((((((( *********
+ ((((((((( ((((((((( *********
+ (((((( ((((((((( ******
+ '';
+ };
+}
+{
+ files.text = { };
+}
+attribute set of (JSON value)
+{
+ files.toml = {
+ "/hellaos.toml" = {
+ greeting = "hello World";
+ };
+ "/hellows.toml" = {
+ greetings = [
+ [
+ "Hello World"
+ ]
+ [
+ "Ola Mundo"
+ [
+ "Holla Que Tal"
+ ]
+ ]
+ ];
+ };
+ };
+}
+{
+ files.toml = { };
+}
+submodule
+lazy attribute set of (submodule)
+{
+ files.watch = {
+ FOO = {
+ cmd = "echo $file $dir $time $events";
+ event = {
+ modify = true;
+ };
+ exclude = ".+\\.png$";
+ files = "$PRJ_ROOT/src";
+ include = ".+\\.js$";
+ recursive = true;
+ };
+ };
+}
+{
+ files.watch = { };
+}
+boolean
+{
+ files.watch.<name>.enable = true;
+}
+string
+submodule
+{
+ files.watch.<name>.event = { };
+}
+boolean
+{
+ files.watch.<name>.event.access = false;
+}
+boolean
+{
+ files.watch.<name>.event.attrib = false;
+}
+boolean
+{
+ files.watch.<name>.event.close = false;
+}
+boolean
+{
+ files.watch.<name>.event.close_nonwrite = false;
+}
+boolean
+{
+ files.watch.<name>.event.close_write = false;
+}
+boolean
+{
+ files.watch.<name>.event.create = false;
+}
+boolean
+{
+ files.watch.<name>.event.delete = false;
+}
+boolean
+{
+ files.watch.<name>.event.modify = true;
+}
+boolean
+{
+ files.watch.<name>.event.move = false;
+}
+boolean
+{
+ files.watch.<name>.event.move_from = false;
+}
+boolean
+{
+ files.watch.<name>.event.move_to = false;
+}
+boolean
+{
+ files.watch.<name>.event.open = false;
+}
+boolean
+{
+ files.watch.<name>.event.unmount = false;
+}
+string
+{
+ files.watch.<name>.exclude = "(.*/\\.|.+~$)";
+}
+string
+{
+ files.watch.<name>.excludei = "";
+}
+strings concatenated with "\n"
+{
+ files.watch.<name>.files = "$PRJ_ROOT";
+}
+boolean
+{
+ files.watch.<name>.follow = false;
+}
+string
+{
+ files.watch.<name>.include = "";
+}
+string
+{
+ files.watch.<name>.includei = "";
+}
+boolean
+{
+ files.watch.<name>.recursive = true;
+}
+string
+{
+ files.watch.<name>.timefmt = "%FT%T.000%zZ";
+}
+attribute set of (JSON value)
+{
+ files.yaml = {
+ "/hellaos.yaml" = {
+ greeting = "hello World";
+ };
+ "/hellows.yaml" = {
+ greetings = [
+ [
+ "Hello World"
+ ]
+ [
+ "Ola Mundo"
+ [
+ "Holla Que Tal"
+ ]
+ ]
+ ];
+ };
+ };
+}
+{
+ files.yaml = { };
+}
+This project uses git as version control, if your are using other version control system it may not work.
+*nix general definition of Unix/Linux