Skip to content

Pipe-optimized with-pattern-functions for making Nix-flakes' output easier to use.

License

Notifications You must be signed in to change notification settings

UbiqueLambda/yafas

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Yet Another For All Systems

Pipe-optimized with-pattern-functions for making Nix-flakes' output easier to use.

E.g.:

{
  inputs = whatever0;

  outputs = { nixpkgs, yafas, ... }@inputs: 
    yafas.allLinux nixpkgs
       ({ pkgs, system }: { packages.default = whatever1; })
       |> yafas.withAarch64Darwin nixpkgs
         (_prev: { pkgs, ... }: { packages.default = whatever2; })
       |> yafas.withOverlays
         (_prev: { default = whatever3; })
       |> yafas.withOverlay "cool"
         (_prev: whatever3)
       |> yafas.withUniversals
         (_prev: { myLibs = whatever4; })
       |> yafas.map
         (prev: prev // { myLibs = prev.myLibs // { }; });
}

A minimalist pipeless example:

{
  inputs = whatever0;

  outputs = { nixpkgs, yafas, ... }@inputs: yafas.withAllSystems nixpkgs
    (universals: { pkgs, ... }: with universals; {
      packages.default = pkgs.callPackage ./some-drv.nix { inherit myLibs; }
    })
    rec {
      myLibs = import ./pure-lib.nix;
    };
}

Documentation

Supported systems

We use github.com:nix-systems/default as inputs.systems, feel free to override it.

NOTE: This does not impact system, systems, withSystems, and withSystem.

Constructors

  • Recommended:

    • allSystems: nixpkgs -> applier -> ouputs
    • systems: system[] -> nixpkgs -> applier -> ouputs
    • system: system -> nixpkgs -> applier -> ouputs
  • Filtered:

    • allDarwin: nixpkgs -> applier -> ouputs
    • allLinux: nixpkgs -> applier -> ouputs

Where applier is the lambda { pkgs, system }: { package.default = pkgs.callPackage ... { }; }.

NOTE: These function will do a system-name injection, so all the outputs here have to be system-specific:

  packages.default = x; -> packages.${system}.default = x;
  formatter = y; -> formatter.${system} = y;

Helpers

  • map: applier -> outputs -> x

Where applier is a map applier.

With per-system

  • Multiple:

    • withAllSystems: nixpkgs -> applier -> outputs -> outputs
    • withSystems: system[] -> nixpkgs -> applier -> outputs -> outputs
    • withDarwin: nixpkgs -> applier -> outputs -> outputs
    • withLinux: nixpkgs -> applier -> outputs -> outputs
  • Single:

    • withSystem: system -> nixpkgs -> applier -> outputs -> outputs
    • withAarch64Linux: nixpkgs -> applier -> outputs -> outputs
    • withAMD64Linux: nixpkgs -> applier -> outputs -> outputs
    • withAarch64Darwin: nixpkgs -> applier -> outputs -> outputs
    • withAMD64Darwin: nixpkgs -> applier -> outputs -> outputs

Where applier is the lambda _prevOutputs: { pkgs, system }: { package.default = pkgs.callPackage ... { }; }.

NOTE: Read Constructors' notes.

With per-system products

  • Generic:

    • withNestedSystem: outputName -> applier -> outputs -> outputs
  • Specific:

    • withApps: applier -> outputs -> outputs
    • withDevShells: applier -> outputs -> outputs
    • withLegacyPackages: applier -> outputs -> outputs
    • withPackages: applier -> outputs -> outputs
    • withFormatter: applier -> outputs -> outputs

Where applier is the lambda _prevOutputs: { pkgs, system }: { default = pkgs.callPackage ... { }; }.

With universals

  • Generic:

    • withUniversals: applier -> outputs -> outputs
    • withUniversal: outputName -> applier -> ouputs -> ouputs
  • Specific:

    • withHomeManagerModules: applier -> ouputs -> ouputs
    • withNixOSModules: applier -> ouputs -> ouputs
    • withOverlays: applier -> ouputs -> ouputs
    • withSchemas: applier -> ouputs -> ouputs

Where applier is the lambda _prevOutputs: { <name> = <value>; }.

With universals products

  • Generic:

    • withNestedUniversal: outputName -> name -> outputs -> outputs
  • Specific:

    • withHomeManagerModule: name -> outputs -> outputs
    • withNixOSModule: name -> outputs -> outputs
    • withOverlay: name -> outputs -> outputs
    • withSchema: name -> outputs -> outputs

Where applier is the lambda _prevOutputs: { <name> = <value>; }.

About

Pipe-optimized with-pattern-functions for making Nix-flakes' output easier to use.

Topics

Resources

License

Stars

Watchers

Forks

Languages