Skip to content

Latest commit

 

History

History
146 lines (110 loc) · 4.56 KB

README.md

File metadata and controls

146 lines (110 loc) · 4.56 KB

Elemental Nix

⚠️ Warning: Unstable API ⚠️

This Nix element provides a minimal, performant module system for Nix code which rigidly enforces code structure using familiar ergonomics.

As a standalone tool, this element provides immediate value to Nix users through its module system. It is designed to serve as a foundational piece of the Ekala ecosystem of tooling, which aims to leverage Nix's unique idempotent properties at scale, providing a crucial layer to reason about our Nix code more efficiently than currently possible.

The compose entrypoint is designed as an efficient API to be fed programmatically from higher level tooling, primarily the eka CLI.

Module Structure

Modules in a Nix element are directories with a mod.nix file containing an attribute set, with subdirectories of the same structure forming submodules. Features include:

  • Explicit Scope: All other .nix files in the module directory are implicitly imported as module members with their associated scope. Manual import is prohibited, ensuring a consistent global namespace.
  • Predictable Composition: O(n) for shallow, O(n * log(m)) for deep nesting.
  • Direct Type Declaration: Enables declaring code as its intended type without function wrappers. Enhances Nix's introspection capabilities, allowing complete Atom exploration in REPLs, while laying groundwork for future static analysis tooling.
  • Public/Private Distinction: Capitalized members denote public exports; all others are private by default.
  • Static File Access: mod.outPath provides access to non-Nix files, excluding submodules, offering an efficient file system API with a well-defined scope.

These features collectively provide a structured, introspectable, and efficient module system that enhances code organization and maintainability in Nix projects, while remaining otherwise unopinionated.

A Module's Scope

mod: Current Module

# string/mod.nix
{
  ToLower = mod.toLowerCase;
  Like = mod.like;
}

# string/toLowerCase.nix: mod.toLowerCase
str:
let
  head = std.substring 0 1 str;
  tail = std.substring 1 (-1) str;
in
"${mod.ToLower head}${tail}"

pre: Parent Module Chain (Recursive)

# parent/mod.nix
{
  privateHelper = x: x * 2;
  PublicFunc = x: x + 1;
}

# parent/child/mod.nix
{
  UseParentPrivate = x: pre.privateHelper x;
  UseParentPublic = x: pre.PublicFunc x;
}

atom: Top-level public API

# root/mod.nix
{
  RootFunc = x: x * 3;
}

# nested/deep/mod.nix
{
  UseRoot = x: atom.rootFunc x;
}

get: external dependencies specified in the manifest

{
  MyPkg = get.stdenv.mkDerivation {
    pname = "foo";
    version = "0.1";
    src = get.my-src-tree;
  };
}

std: A Proper Home for the Standard Library

# utils/mod.nix
{
  Double = x: std.mul 2 x;
  IsEven = x: std.mod x 2 == 0;
}

Eka's TOML Manifest (Unstable)

⚠️ The manifest's structure will change as the project develops.

The current in-repo manifest implementation is for demonstration purposes only. The canonical manifest validation layer exists in eka.

Each atom is defined by a TOML manifest file, enhancing dependency tracking and separation of concerns:

[atom]
name = "dev"
version = "0.1.0"
description = "Development environment"

[features]
default = []

[fetch.pkgs]
name = "nixpkgs"
import = true
args = [{}]

Usage (Unstable)

⚠️ Implementation detail

While it is conceptually useful to keep the Nix element minimal and in pure Nix, something like the code below should be implicit for user facing interfaces, e.g. eka.

let
  atom = builtins.fetchGit "https://github.com/ekala-project/atom";
  importAtom = import "${atom}/atom-nix/core/importAtom.nix";
in
importAtom {
  features = [
    # enabled flags
  ];
} ./atom-nix/dev.toml

Future Directions: Ekala Platform

This element lays some of the groundwork for the Ekala platform, which builds upon the innovative store-based build and distribution model introduced by Nix.

The Ekala project, through the eka CLI and its backend Eos API, aims to craft an open, unified platform that leverages the potential of this model to enhance software development, deployment, and system management at scale.

For details on eka, see the eka README.

For ongoing discussions and updates, visit our Issues page.