Auto generated project files from Nix code, with gitignore handling and many generators. https://soonix.projects.tf
Find a file
technofab 3baef660cf
chore(lib): add "auto generated" comment to nix generator outputs
fix copy not being able to overwrite generated files due to them being
read only (r--r--r--) by removing them first
2025-09-02 09:20:58 +02:00
docs docs: add initial docs base 2025-08-27 11:22:26 +02:00
lib chore(lib): add "auto generated" comment to nix generator outputs 2025-09-02 09:20:58 +02:00
nix/repo chore: add treefmt 2025-08-28 09:06:24 +02:00
tests chore: initial commit 2025-08-25 19:14:08 +02:00
.envrc chore: initial commit 2025-08-25 19:14:08 +02:00
.gitignore fix(gitignore): correctly grep for file with / prefix 2025-08-27 12:01:23 +02:00
flake.lock chore: initial commit 2025-08-25 19:14:08 +02:00
flake.nix docs: add initial docs base 2025-08-27 11:22:26 +02:00
LICENSE.md docs: add initial docs base 2025-08-27 11:22:26 +02:00
README.md chore: add treefmt 2025-08-28 09:06:24 +02:00

Soonix

Soonix helps you declaratively manage configuration files, build scripts, etc. using the Nix module system. It minimizes configuration clutter and provides shell hooks for automatic file management.

Heavily based on and inspired by Nixago, thus the name (ago <-> soon, if that wasn't obvious).

Features

  • Declarative Configuration: Uses Nix modules for type-safe, declarative file management
  • Multiple Engines: Support for JSON/YAML/TOML, templates, scripts, and more
  • Shell Hooks: Automatic file management with status tracking
  • Flexible File Handling: Choose between symlinks and copies based on your needs
  • GitIgnore Integration: Automatic management of .gitignore entries

Quick Start

{
  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
    soonix.url = "gitlab:TECHNOFAB/soonix?dir=lib";
  };

  outputs = { nixpkgs, soonix, ... }: let
    system = "x86_64-linux";
    pkgs = nixpkgs.legacyPackages.${system};

    shellHook = (soonix.lib { inherit pkgs; }).mkShellHook {
      hooks = {
        eslintrc = {
          output = ".eslintrc.json";
          generator = "nix";
          data = { extends = ["eslint:recommended"]; };
          opts = { format = "json"; };
        };
      };
    };
  in {
    devShells.${system}.default = pkgs.mkShell {
      packages = [ pkgs.jq ];
      inherit shellHook;
    };
  };
}

If you use rensa-nix/devshell, you can also use the devshellModule for easy integration, see the docs for more.

Available Engines

  • nix: Convert Nix data to JSON, YAML, TOML, INI, XML formats
  • string: Output raw string content with optional executable permissions
  • derivation: Use existing Nix derivations as file content
  • gotmpl: Advanced Go template rendering via gomplate
  • jinja: Python Jinja2 template rendering

Docs

Docs