holm/flakelight
1
1
Fork 0
forked from extern/flakelight
Code Pull Requests Activity

Update repository location

Browse Source
This commit is contained in:
Archit Gupta 2023-12-18 21:46:35 -08:00
parent 60614ae7eb
commit 2d82ec80e7
3 changed files with 42 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
API_GUIDE.md
View File

@ -11,7 +11,7 @@ When called directly, Flakelight invokes `mkFlake`, as follows:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. { flakelight ./. {
# Your flake configuration here # Your flake configuration here
@ -23,7 +23,7 @@ To call `mkFlake` explicitly, you can do:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight.lib.mkFlake ./. { flakelight.lib.mkFlake ./. {
# Your flake configuration here # Your flake configuration here
@ -38,7 +38,7 @@ If you need access to module args, you can write it as bellow:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. ({ lib, config, ... }: { flakelight ./. ({ lib, config, ... }: {
# Your flake configuration here # Your flake configuration here
@ -89,7 +89,7 @@ nixpkgs used for building outputs, you can pass your flake inputs in as follows:
{ {
inputs = { inputs = {
nixpkgs.url = "nixpkgs/nixpkgs-unstable"; nixpkgs.url = "nixpkgs/nixpkgs-unstable";
flakelight.url = "github:accelbread/flakelight"; flakelight.url = "github:nix-community/flakelight";
}; };
outputs = { flakelight, ... }@inputs: outputs = { flakelight, ... }@inputs:
flakelight ./. { flakelight ./. {
@ -104,7 +104,7 @@ Or to just pass just the nixpkgs input:
{ {
inputs = { inputs = {
nixpkgs.url = "nixpkgs/nixpkgs-unstable"; nixpkgs.url = "nixpkgs/nixpkgs-unstable";
flakelight.url = "github:accelbread/flakelight"; flakelight.url = "github:nix-community/flakelight";
}; };
outputs = { flakelight, nixpkgs, ... }: outputs = { flakelight, nixpkgs, ... }:
flakelight ./. { flakelight ./. {
@ -125,7 +125,7 @@ as follows:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. { flakelight ./. {
systems = [ "x86_64-linux" "aarch64-linux" "i686-linux" "armv7l-linux" ]; systems = [ "x86_64-linux" "aarch64-linux" "i686-linux" "armv7l-linux" ];
@ -137,7 +137,7 @@ To support all systems supported by flakes, set `systems` as follows:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. ({ lib, ... }: { flakelight ./. ({ lib, ... }: {
systems = lib.systems.flakeExposed; systems = lib.systems.flakeExposed;
@ -149,7 +149,7 @@ To support all Linux systems supported by flakes, set `systems` as follows:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. ({ lib, ... }: { flakelight ./. ({ lib, ... }: {
systems = lib.intersectLists systems = lib.intersectLists
@ -169,7 +169,7 @@ To add a `example.test` output to your flake you could do the following:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. { flakelight ./. {
outputs = { outputs = {
@ -186,7 +186,7 @@ overlay (though this can be configured with the `overlays` option):
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. { flakelight ./. {
outputs.overlays.clang = final: prev: { stdenv = final.clangStdenv; }; outputs.overlays.clang = final: prev: { stdenv = final.clangStdenv; };
@ -205,7 +205,7 @@ following:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. { flakelight ./. {
perSystem = pkgs: { perSystem = pkgs: {
@ -228,7 +228,7 @@ option as follows:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. { flakelight ./. {
nixpkgs.config = { allowBroken = true; allowUnsupportedSystem = true; }; nixpkgs.config = { allowBroken = true; allowUnsupportedSystem = true; };
@ -249,7 +249,7 @@ the option as follows:
```nix ```nix
{ {
inputs = { inputs = {
flakelight.url = "github:accelbread/flakelight"; flakelight.url = "github:nix-community/flakelight";
emacs-overlay.url = "github:nix-community/emacs-overlay"; emacs-overlay.url = "github:nix-community/emacs-overlay";
}; };
outputs = { flakelight, emacs-overlay, ... }: outputs = { flakelight, emacs-overlay, ... }:
@ -266,7 +266,7 @@ You can use the values from the overlays with other options:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. { flakelight ./. {
withOverlays = final: prev: { testValue = "hi"; }; withOverlays = final: prev: { testValue = "hi"; };
@ -291,7 +291,7 @@ To set the default package, you can set the options as follows:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. { flakelight ./. {
package = { stdenv }: package = { stdenv }:
@ -314,7 +314,7 @@ To set multiple packages, you can set the options as follows:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. { flakelight ./. {
packages = { packages = {
@ -378,7 +378,7 @@ For example, these can be configured as follows:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. { flakelight ./. {
devShell = { devShell = {
@ -404,7 +404,7 @@ To add the build inputs of one of your packages, you can do as follows:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. { flakelight ./. {
package = { stdenv }: package = { stdenv }:
@ -429,7 +429,7 @@ For example:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. { flakelight ./. {
devShells.testing = { mkShell, coreutils }: devShells.testing = { mkShell, coreutils }:
@ -457,7 +457,7 @@ For example, to add an overlay to `overlays.default`, do the following:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. { flakelight ./. {
overlay = final: prev: { testValue = "hello"; }; overlay = final: prev: { testValue = "hello"; };
@ -471,7 +471,7 @@ To configure other overlays:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. { flakelight ./. {
overlays.cool = final: prev: { testValue = "cool"; }; overlays.cool = final: prev: { testValue = "cool"; };
@ -501,7 +501,7 @@ For example:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. { flakelight ./. {
checks = { checks = {
@ -529,7 +529,7 @@ For example:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. { flakelight ./. {
apps = { apps = {
@ -545,7 +545,7 @@ Alternatively, the above can be written as:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. { flakelight ./. {
apps = { emacs, bash, ... }: { apps = { emacs, bash, ... }: {
@ -570,7 +570,7 @@ For example:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. { flakelight ./. {
templates.test-template = { templates.test-template = {
@ -593,7 +593,7 @@ For example, to use a custom formatting command:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. { flakelight ./. {
formatter = pkgs: pkgs.writeShellScriptBin "format-script" '' formatter = pkgs: pkgs.writeShellScriptBin "format-script" ''
@ -626,7 +626,7 @@ For example, to set Rust and Zig formatters:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. { flakelight ./. {
devShell.packages = pkgs: [ pkgs.rustfmt pkgs.zig ]; devShell.packages = pkgs: [ pkgs.rustfmt pkgs.zig ];
@ -655,7 +655,7 @@ For example, a bundler that returns the passed package:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. { flakelight ./. {
bundler = x: x; bundler = x: x;
@ -667,7 +667,7 @@ As another example, a bundler that always returns `hello`:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. { flakelight ./. {
bundlers = { hello, ... }: { bundlers = { hello, ... }: {
@ -699,7 +699,7 @@ For example:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. ({ lib, ... }: { flakelight ./. ({ lib, ... }: {
nixosConfigurations.system = lib.nixosSystem { nixosConfigurations.system = lib.nixosSystem {
@ -712,7 +712,7 @@ For example:
```nix ```nix
{ {
inputs = { inputs = {
flakelight.url = "github:accelbread/flakelight"; flakelight.url = "github:nix-community/flakelight";
home-manger.url = "github:nix-community/home-manager"; home-manger.url = "github:nix-community/home-manager";
}; };
outputs = { flakelight, home-manager, ... }: outputs = { flakelight, home-manager, ... }:
@ -728,7 +728,7 @@ Optionally, defining as a function:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. { flakelight ./. {
nixosConfigurations.system = { lib, ... }: lib.nixosSystem { nixosConfigurations.system = { lib, ... }: lib.nixosSystem {
@ -750,7 +750,7 @@ For example:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. ({ lib, ... }: { flakelight ./. ({ lib, ... }: {
nixosModule = { system, lib, pkgs, ... }: { nixosModule = { system, lib, pkgs, ... }: {
@ -764,7 +764,7 @@ These can be paths, which is preferred as it results in better debug output:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. ({ lib, ... }: { flakelight ./. ({ lib, ... }: {
nixosModule = ./module.nix; nixosModule = ./module.nix;
@ -784,7 +784,7 @@ For example:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. { flakelight ./. {
lib = { lib = {
@ -809,7 +809,7 @@ As an example:
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. { flakelight ./. {
outputs.testvalue = 5; outputs.testvalue = 5;

10
README.md
View File

@ -41,7 +41,7 @@ system. `systems` can be set to change configured systems from the default.
```nix ```nix
{ {
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... } outputs = { flakelight, ... }
flakelight ./. { flakelight ./. {
devShell.packages = pkgs: [ pkgs.hello pkgs.coreutils ]; devShell.packages = pkgs: [ pkgs.hello pkgs.coreutils ];
@ -58,7 +58,7 @@ To use a different nixpkgs, you can instead use:
{ {
inputs = { inputs = {
nixpkgs.url = "nixpkgs/nixpkgs-unstable"; nixpkgs.url = "nixpkgs/nixpkgs-unstable";
flakelight.url = "github:accelbread/flakelight"; flakelight.url = "github:nix-community/flakelight";
}; };
outputs = { flakelight, ... }@inputs: outputs = { flakelight, ... }@inputs:
flakelight ./. { flakelight ./. {
@ -98,7 +98,7 @@ Equivalently, you can just import the `flakelight-rust` module as follows:
```nix ```nix
{ {
inputs = { inputs = {
flakelight.url = "github:accelbread/flakelight"; flakelight.url = "github:nix-community/flakelight";
flakelight-rust.url = "github:accelbread/flakelight-rust"; flakelight-rust.url = "github:accelbread/flakelight-rust";
}; };
outputs = { flakelight, flakelight-rust, ... }: flakelight ./. { outputs = { flakelight, flakelight-rust, ... }: flakelight ./. {
@ -119,7 +119,7 @@ The following example flake is for a C project with a simple `make` setup.
```nix ```nix
{ {
description = "My C application."; description = "My C application.";
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }: outputs = { flakelight, ... }:
flakelight ./. { flakelight ./. {
license = "AGPL-3.0-or-later"; license = "AGPL-3.0-or-later";
@ -168,7 +168,7 @@ like the following. Most attributes can be autoloaded.
```nix ```nix
{ {
description = "My C application."; description = "My C application.";
inputs.flakelight.url = "github:accelbread/flakelight"; inputs.flakelight.url = "github:nix-community/flakelight";
outputs = { flakelight, ... }@inputs: outputs = { flakelight, ... }@inputs:
flakelight ./. { flakelight ./. {
license = "AGPL-3.0-or-later"; license = "AGPL-3.0-or-later";

2
templates/basic/flake.nix
View File

@ -1,7 +1,7 @@
{ {
inputs = { inputs = {
nixpkgs.url = "nixpkgs/nixos-unstable"; nixpkgs.url = "nixpkgs/nixos-unstable";
flakelight.url = "github:accelbread/flakelight"; flakelight.url = "github:nix-community/flakelight";
}; };
outputs = { flakelight, ... }@inputs: outputs = { flakelight, ... }@inputs:
flakelight ./. { flakelight ./. {