mirrors/flake-parts
1
0
Fork 0
mirror of https://github.com/hercules-ci/flake-parts.git synced 2024-12-14 11:47:31 +00:00
Code Activity

Use markdown by default

Browse source
This commit is contained in:
Robert Hensing 2022-11-11 06:40:37 +01:00
parent fb87cc7333
commit 6b87695050
16 changed files with 66 additions and 55 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
dev/flake.lock
View file

@ -97,11 +97,11 @@
"nixpkgs": "nixpkgs_2"
},
"locked": {
"lastModified": 1668065367,
"narHash": "sha256-v8LdAfDSzxRS4BS+qZvorRGC8nXhN9xMJevu/hf+Gt0=",
"lastModified": 1668147980,
"narHash": "sha256-dHu5VIGQvZoHtqr5tmndpiVVk5JnJ/6wZUNRwEfvIxk=",
"owner": "hercules-ci",
"repo": "hercules-ci-effects",
"rev": "692309d1cbb24847cc2b0a345ec9f0fe9481a7db",
"rev": "244595b8dcfea8c6ac52a99157653162d26ea6d3",
"type": "github"
},
"original": {
@ -183,16 +183,16 @@
},
"nixpkgs_3": {
"locked": {
"lastModified": 1667991831,
"narHash": "sha256-DHgEsLZI044B9T4AjA3K6+yB9/DqLr4dyA7OIx0FG7o=",
"owner": "NixOS",
"lastModified": 1668145650,
"narHash": "sha256-RJsYVz7j6HhXQtcFQJz9bZsgwFG8MblmOt8A4iD1AlY=",
"owner": "hercules-ci",
"repo": "nixpkgs",
"rev": "872fceeed60ae6b7766cc0a4cd5bf5901b9098ec",
"rev": "b106ff14ede4034f8771025f8ac785144358f3cd",
"type": "github"
},
"original": {
"owner": "NixOS",
"ref": "nixos-unstable",
"owner": "hercules-ci",
"ref": "options-markdown-and-errors",
"repo": "nixpkgs",
"type": "github"
}

2
dev/flake.nix
View file

@ -6,7 +6,7 @@
# As a consequence, this flake is a little non-standard, and
# we can't use the `nix` CLI as expected.
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
nixpkgs.url = "github:hercules-ci/nixpkgs/options-markdown-and-errors";
pre-commit-hooks-nix.url = "github:cachix/pre-commit-hooks.nix";
pre-commit-hooks-nix.inputs.nixpkgs.follows = "nixpkgs";

10
modules/apps.nix
View file

@ -27,14 +27,14 @@ let
type = mkOption {
type = lib.types.enum [ "app" ];
default = "app";
description = ''
A type tag for <literal>apps</literal> consumers.
description = lib.mdDoc ''
A type tag for `apps` consumers.
'';
};
program = mkOption {
type = programType;
description = ''
A path to an executable or a derivation with <literal>meta.mainProgram</literal>.
description = lib.mdDoc ''
A path to an executable or a derivation with `meta.mainProgram`.
'';
};
};
@ -46,7 +46,7 @@ mkTransposedPerSystemModule {
type = types.lazyAttrsOf appType;
default = { };
description = ''
Programs runnable with nix run <literal>.#&lt;name></literal>.
Programs runnable with nix run `<name>`.
'';
example = lib.literalExpression or lib.literalExample ''
{

2
modules/checks.nix
View file

@ -14,7 +14,7 @@ mkTransposedPerSystemModule {
type = types.lazyAttrsOf types.package;
default = { };
description = ''
Derivations to be built by nix flake check.
Derivations to be built by [`nix flake check`](https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-flake-check.html).
'';
};
file = ./checks.nix;

4
modules/darwinModules.nix
View file

@ -18,8 +18,8 @@ in
type = types.lazyAttrsOf types.unspecified;
default = { };
apply = mapAttrs (k: v: { _file = "${toString self.outPath}/flake.nix#darwinModules.${k}"; imports = [ v ]; });
description = ''
Nix-darwin modules.
description = lib.mdDoc ''
[nix-darwin](https://daiderd.com/nix-darwin/) modules.
'';
};
};

4
modules/devShells.nix
View file

@ -14,8 +14,8 @@ mkTransposedPerSystemModule {
type = types.lazyAttrsOf types.package;
default = { };
description = ''
An attribute set of packages to be built by <literal>nix develop .#&lt;name></literal>.
<literal>nix build .#&lt;name></literal> will run <literal>devShells.&lt;name></literal>.
An attribute set of packages to be used as shells.
[`nix develop .#<name>`](https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-develop.html) will run `devShells.<name>`.
'';
};
file = ./devShells.nix;

4
modules/flake.nix
View file

@ -16,8 +16,8 @@ in
{ freeformType = types.lazyAttrsOf types.raw; }
];
};
description = ''
Raw flake attributes. Any attribute can be set here, but some
description = lib.mdDoc ''
Raw flake output attributes. Any attribute can be set here, but some
attributes are represented by options, to provide appropriate
configuration merging.
'';

2
modules/formatter.nix
View file

@ -14,7 +14,7 @@ mkTransposedPerSystemModule {
type = types.nullOr types.package;
default = null;
description = ''
A package used by <literal>nix fmt</literal>.
A package used by [`nix fmt`](https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-fmt.html).
'';
};
file = ./formatter.nix;

2
modules/legacyPackages.nix
View file

@ -14,7 +14,7 @@ mkTransposedPerSystemModule {
type = types.lazyAttrsOf types.raw;
default = { };
description = ''
An attribute set of unmergeable values. This is also used by <literal>nix build .#&lt;attrpath></literal>.
An attribute set of unmergeable values. This is also used by [`nix build .#<attrpath>`](https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-build.html).
'';
};
file = ./legacyPackages.nix;

5
modules/nixosConfigurations.nix
View file

@ -15,8 +15,8 @@ in
nixosConfigurations = mkOption {
type = types.lazyAttrsOf types.raw;
default = { };
description = ''
Instantiated NixOS configurations.
description = lib.mdDoc ''
Instantiated NixOS configurations. Used by `nixos-rebuild`.
'';
example = literalExpression ''
{
@ -24,6 +24,7 @@ in
system = "x86_64-linux";
modules = [
./my-machine/nixos-configuration.nix
config.nixosModules.my-module
];
};
}

4
modules/nixosModules.nix
View file

@ -18,8 +18,10 @@ in
type = types.lazyAttrsOf types.unspecified;
default = { };
apply = mapAttrs (k: v: { _file = "${toString self.outPath}/flake.nix#nixosModules.${k}"; imports = [ v ]; });
description = ''
description = lib.mdDoc ''
NixOS modules.
You may use this for reusable pieces of configuration, service modules, etc.
'';
};
};

6
modules/overlays.nix
View file

@ -23,13 +23,13 @@ in
default = final: prev: {};
}
'';
description = ''
An attribute set of overlays.
description = lib.mdDoc ''
An attribute set of [overlays](https://nixos.org/manual/nixpkgs/stable/#chap-overlays).
Note that the overlays themselves are not mergeable. While overlays
can be composed, the order of composition is significant, but the
module system does not guarantee sufficiently deterministic
definition ordering, across versions and when changing <literal>imports</literal>.
definition ordering, across versions and when changing `imports`.
'';
};
};

5
modules/packages.nix
View file

@ -14,8 +14,9 @@ mkTransposedPerSystemModule {
type = types.lazyAttrsOf types.package;
default = { };
description = ''
An attribute set of packages to be built by <literal>nix build .#&lt;name></literal>.
<literal>nix build .#&lt;name></literal> will build <literal>packages.&lt;name></literal>.
An attribute set of packages to be built by [`nix build`](https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-build.html).
`nix build .#<name>` will build `packages.<name>`.
'';
};
file = ./packages.nix;

12
modules/perSystem.nix
View file

@ -16,17 +16,21 @@ in
{
options = {
systems = mkOption {
description = "All the system types to enumerate in the flake.";
description = lib.mdDoc ''
All the system types to enumerate in the flake output subattributes.
In other words, all valid values for `system` in e.g. `packages.<system>.foo`.
'';
type = types.listOf types.str;
};
perInput = mkOption {
description = "Function from system to function from flake to <literal>system</literal>-specific attributes.";
description = lib.mdDoc "Function from system to function from flake to `system`-specific attributes.";
type = types.functionTo (types.functionTo (types.lazyAttrsOf types.unspecified));
};
perSystem = mkOption {
description = "A function from system to flake-like attributes omitting the <literal>&lt;system></literal> attribute.";
description = lib.mdDoc "A function from system to flake-like attributes omitting the `<system>` attribute.";
type = mkPerSystemType ({ config, system, ... }: {
_file = ./perSystem.nix;
config = {
@ -46,7 +50,7 @@ in
allSystems = mkOption {
type = types.lazyAttrsOf types.unspecified;
description = "The system-specific config for each of systems.";
description = lib.mdDoc "The system-specific config for each of systems.";
internal = true;
};
};

20
modules/transposition.nix
View file

@ -17,12 +17,12 @@ let
adHoc = mkOption {
type = types.bool;
default = false;
description = ''
Whether to provide a stub option declaration for <option>perSystem.&lt;name></option>
description = lib.mdDoc ''
Whether to provide a stub option declaration for {option}`perSystem.<name>`.
The stub option declaration does not support merging and lacks
documentation, so you are recommended to declare the <option>perSystem.&lt;name></option>
option yourself and avoid <option>adHoc</option>.
documentation, so you are recommended to declare the {option}`perSystem.<name>`
option yourself and avoid {option}`adHoc`.
'';
};
};
@ -32,18 +32,18 @@ in
{
options = {
transposition = lib.mkOption {
description = ''
description = lib.mdDoc ''
A helper that defines transposed attributes in the flake outputs.
Transposition is the operation that swaps the indices of a data structure.
Here it refers specifically to the transposition between
<literal>
perSystem: .''${system}.''${attribute}
outputs: .''${attribute}.''${system}
</literal>
```plain
perSystem: .''${system}.''${attribute}
outputs: .''${attribute}.''${system}
```
It also defines the reverse operation in <option>perInput</option>.
It also defines the reverse operation in [{option}`perInput`](#opt-perInput).
'';
type =
types.lazyAttrsOf

21
site/flake-module.nix
View file

@ -16,15 +16,16 @@
let sourcePathStr = toString sourcePath;
in
opt:
let declarations = concatMap
(decl:
if hasPrefix sourcePathStr (toString decl)
then
let subpath = removePrefix sourcePathStr (toString decl);
in [{ url = baseUrl + subpath; name = sourceName + subpath; }]
else [ ]
)
opt.declarations;
let
declarations = concatMap
(decl:
if hasPrefix sourcePathStr (toString decl)
then
let subpath = removePrefix sourcePathStr (toString decl);
in [{ url = baseUrl + subpath; name = sourceName + subpath; }]
else [ ]
)
opt.declarations;
in
if declarations == [ ]
then opt // { visible = false; }
@ -39,6 +40,8 @@
transformOptions = filterTransformOptions {
inherit sourceName baseUrl sourcePath;
};
warningsAreErrors = true; # not sure if feasible long term
markdownByDefault = true;
}).optionsDocBook;
inherit title;
} ''