mirror of
https://github.com/hsjobeki/noogle.git
synced 2024-09-11 21:07:53 +03:00
add snapshot tests and seperate sub.project for builtin types
This commit is contained in:
parent
d3c2864bbf
commit
74aa82d716
30
flake.nix
30
flake.nix
@ -15,12 +15,12 @@
|
|||||||
system = "x86_64-linux";
|
system = "x86_64-linux";
|
||||||
pkgs = nixpkgs.legacyPackages.${system};
|
pkgs = nixpkgs.legacyPackages.${system};
|
||||||
websiteName = (builtins.fromJSON (builtins.readFile ./website/package.json)).name;
|
websiteName = (builtins.fromJSON (builtins.readFile ./website/package.json)).name;
|
||||||
inherit (self.packages.${system}) indexer nixpkgs-data;
|
inherit (self.packages.${system}) indexer nixpkgs-data builtins-data;
|
||||||
|
|
||||||
prepareData = prefix: ''
|
prepareData = prefix: ''
|
||||||
cp -f ${nixpkgs-data.lib} ${prefix}./models/data/lib.json
|
cp -f ${nixpkgs-data.lib} ${prefix}/lib.json
|
||||||
cp -f ${nixpkgs-data.build_support} ${prefix}./models/data/trivial-builders.json
|
cp -f ${nixpkgs-data.build_support} ${prefix}/trivial-builders.json
|
||||||
node ${prefix}./scripts/make-builtins.js ${prefix}./models/data
|
cp -f ${builtins-data}/lib/data.json ${prefix}/builtins.json
|
||||||
'';
|
'';
|
||||||
|
|
||||||
dream2nixOutput = dream2nix.lib.makeFlakeOutputs {
|
dream2nixOutput = dream2nix.lib.makeFlakeOutputs {
|
||||||
@ -31,7 +31,7 @@
|
|||||||
|
|
||||||
packageOverrides = {
|
packageOverrides = {
|
||||||
${websiteName}.staticPage = {
|
${websiteName}.staticPage = {
|
||||||
preBuild = prepareData "";
|
preBuild = prepareData "models/data";
|
||||||
installPhase = ''
|
installPhase = ''
|
||||||
runHook preInstall
|
runHook preInstall
|
||||||
|
|
||||||
@ -43,6 +43,20 @@
|
|||||||
runHook postInstall
|
runHook postInstall
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
|
tests.run = {
|
||||||
|
installPhase = "";
|
||||||
|
preBuild = ''
|
||||||
|
ls -la
|
||||||
|
mkdir -p data
|
||||||
|
${prepareData "data"}
|
||||||
|
|
||||||
|
'';
|
||||||
|
doCheck = true;
|
||||||
|
checkPhase = ''
|
||||||
|
ls -la
|
||||||
|
npm run test -- --ci
|
||||||
|
'';
|
||||||
|
};
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
in
|
in
|
||||||
@ -84,7 +98,8 @@
|
|||||||
buildInputs = with pkgs; [ nodejs-18_x rustfmt rustc cargo clippy ];
|
buildInputs = with pkgs; [ nodejs-18_x rustfmt rustc cargo clippy ];
|
||||||
inputsFrom = [ indexer ];
|
inputsFrom = [ indexer ];
|
||||||
shellHook = ''
|
shellHook = ''
|
||||||
${prepareData "./website/"}
|
${prepareData "website/models/data"}
|
||||||
|
${prepareData "tests/data"}
|
||||||
${self.checks.${system}.pre-commit-check.shellHook}
|
${self.checks.${system}.pre-commit-check.shellHook}
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
@ -96,9 +111,6 @@
|
|||||||
nixpkgs-fmt.enable = true;
|
nixpkgs-fmt.enable = true;
|
||||||
statix.enable = true;
|
statix.enable = true;
|
||||||
markdownlint.enable = true;
|
markdownlint.enable = true;
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
};
|
};
|
||||||
excludes = [ "indexer/test" ];
|
excludes = [ "indexer/test" ];
|
||||||
settings = {
|
settings = {
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
// simple script
|
// simple script
|
||||||
|
// test.json in generated with "cargo run -- --dir ./test"
|
||||||
const data = require("./test.json");
|
const data = require("./test.json");
|
||||||
const fs = require("fs");
|
const fs = require("fs");
|
||||||
|
|
||||||
|
@ -1,231 +0,0 @@
|
|||||||
{ pkgs
|
|
||||||
, lib
|
|
||||||
, options
|
|
||||||
, transformOptions ? lib.id
|
|
||||||
, # function for additional transformations of the options
|
|
||||||
documentType ? "appendix"
|
|
||||||
, # TODO deprecate "appendix" in favor of "none"
|
|
||||||
# and/or rename function to moduleOptionDoc for clean slate
|
|
||||||
# If you include more than one option list into a document, you need to
|
|
||||||
# provide different ids.
|
|
||||||
variablelistId ? "configuration-variable-list"
|
|
||||||
, # String to prefix to the option XML/HTML id attributes.
|
|
||||||
optionIdPrefix ? "opt-"
|
|
||||||
, revision ? ""
|
|
||||||
, # Specify revision for the options
|
|
||||||
# a set of options the docs we are generating will be merged into, as if by recursiveUpdate.
|
|
||||||
# used to split the options doc build into a static part (nixos/modules) and a dynamic part
|
|
||||||
# (non-nixos modules imported via configuration.nix, other module sources).
|
|
||||||
baseOptionsJSON ? null
|
|
||||||
, # instead of printing warnings for eg options with missing descriptions (which may be lost
|
|
||||||
# by nix build unless -L is given), emit errors instead and fail the build
|
|
||||||
warningsAreErrors ? true
|
|
||||||
, # allow docbook option docs if `true`. only markdown documentation is allowed when set to
|
|
||||||
# `false`, and a different renderer may be used with different bugs and performance
|
|
||||||
# characteristics but (hopefully) indistinguishable output.
|
|
||||||
allowDocBook ? true
|
|
||||||
, # whether lib.mdDoc is required for descriptions to be read as markdown.
|
|
||||||
markdownByDefault ? false
|
|
||||||
,
|
|
||||||
}:
|
|
||||||
let
|
|
||||||
/*
|
|
||||||
Generate JSON, XML and DocBook documentation for given NixOS options.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
{ pkgs, }:
|
|
||||||
|
|
||||||
let
|
|
||||||
eval = import (pkgs.path + "/nixos/lib/eval-config.nix") {
|
|
||||||
baseModules = [
|
|
||||||
../module.nix
|
|
||||||
];
|
|
||||||
modules = [];
|
|
||||||
};
|
|
||||||
in pkgs.nixosOptionsDoc {
|
|
||||||
options = eval.options;
|
|
||||||
}
|
|
||||||
|
|
||||||
Type:
|
|
||||||
nixosOptionsDoc :: {
|
|
||||||
pkgs :: AttrSet,
|
|
||||||
lib :: AttrSet,
|
|
||||||
options :: AttrSet,
|
|
||||||
transformOptions? :: String,
|
|
||||||
documentType? :: String,
|
|
||||||
variablelistId? :: String,
|
|
||||||
optionIdPrefix? :: String,
|
|
||||||
revision? :: String,
|
|
||||||
baseOptionsJSON? :: AttrSet,
|
|
||||||
warningsAreErrors? :: Bool,
|
|
||||||
allowDocBook? :: Bool,
|
|
||||||
markdownByDefault? :: Bool,
|
|
||||||
} -> {
|
|
||||||
optionsNix :: AttrSet,
|
|
||||||
optionsAsciiDoc :: Derivation,
|
|
||||||
optionsCommonMark :: Derivation,
|
|
||||||
optionsJSON optionsXML :: Derivation,
|
|
||||||
optionsDocBook :: Derivation,
|
|
||||||
}
|
|
||||||
*/
|
|
||||||
rawOpts = lib.optionAttrSetToDocList options;
|
|
||||||
transformedOpts = map transformOptions rawOpts;
|
|
||||||
filteredOpts = lib.filter (opt: opt.visible && !opt.internal) transformedOpts;
|
|
||||||
optionsList =
|
|
||||||
lib.flip map filteredOpts
|
|
||||||
(
|
|
||||||
opt:
|
|
||||||
opt
|
|
||||||
// lib.optionalAttrs (opt ? relatedPackages && opt.relatedPackages != [ ]) { relatedPackages = genRelatedPackages opt.relatedPackages opt.name; }
|
|
||||||
);
|
|
||||||
|
|
||||||
# Generate DocBook documentation for a list of packages. This is
|
|
||||||
# what `relatedPackages` option of `mkOption` from
|
|
||||||
# ../../../lib/options.nix influences.
|
|
||||||
#
|
|
||||||
# Each element of `relatedPackages` can be either
|
|
||||||
# - a string: that will be interpreted as an attribute name from `pkgs` and turned into a link
|
|
||||||
# to search.nixos.org,
|
|
||||||
# - a list: that will be interpreted as an attribute path from `pkgs` and turned into a link
|
|
||||||
# to search.nixos.org,
|
|
||||||
# - an attrset: that can specify `name`, `path`, `comment`
|
|
||||||
# (either of `name`, `path` is required, the rest are optional).
|
|
||||||
#
|
|
||||||
# NOTE: No checks against `pkgs` are made to ensure that the referenced package actually exists.
|
|
||||||
# Such checks are not compatible with option docs caching.
|
|
||||||
genRelatedPackages = packages: optName:
|
|
||||||
let
|
|
||||||
unpack = p:
|
|
||||||
if lib.isString p
|
|
||||||
then { name = p; }
|
|
||||||
else if lib.isList p
|
|
||||||
then { path = p; }
|
|
||||||
else p;
|
|
||||||
describe = args:
|
|
||||||
let
|
|
||||||
title = args.title or null;
|
|
||||||
name = args.name or (lib.concatStringsSep "." args.path);
|
|
||||||
in
|
|
||||||
''
|
|
||||||
<listitem>
|
|
||||||
<para>
|
|
||||||
<link xlink:href="https://search.nixos.org/packages?show=${name}&sort=relevance&query=${name}">
|
|
||||||
<literal>${lib.optionalString (title != null) "${title} aka "}pkgs.${name}</literal>
|
|
||||||
</link>
|
|
||||||
</para>
|
|
||||||
${lib.optionalString (args ? comment) "<para>${args.comment}</para>"}
|
|
||||||
</listitem>
|
|
||||||
'';
|
|
||||||
in
|
|
||||||
"<itemizedlist>${lib.concatStringsSep "\n" (map (p: describe (unpack p)) packages)}</itemizedlist>";
|
|
||||||
|
|
||||||
optionsNix = builtins.listToAttrs (map
|
|
||||||
(o: {
|
|
||||||
name = o.name;
|
|
||||||
value = removeAttrs o [ "name" "visible" "internal" ];
|
|
||||||
})
|
|
||||||
optionsList);
|
|
||||||
in
|
|
||||||
rec {
|
|
||||||
inherit optionsNix;
|
|
||||||
|
|
||||||
optionsAsciiDoc = pkgs.runCommand "options.adoc" { } ''
|
|
||||||
${pkgs.python3Minimal}/bin/python ${./generateDoc.py} \
|
|
||||||
--format asciidoc \
|
|
||||||
${optionsJSON}/share/doc/nixos/options.json \
|
|
||||||
> $out
|
|
||||||
'';
|
|
||||||
|
|
||||||
optionsCommonMark = pkgs.runCommand "options.md" { } ''
|
|
||||||
${pkgs.python3Minimal}/bin/python ${./generateDoc.py} \
|
|
||||||
--format commonmark \
|
|
||||||
${optionsJSON}/share/doc/nixos/options.json \
|
|
||||||
> $out
|
|
||||||
'';
|
|
||||||
|
|
||||||
optionsJSON =
|
|
||||||
pkgs.runCommand "options.json"
|
|
||||||
{
|
|
||||||
meta.description = "List of NixOS options in JSON format";
|
|
||||||
nativeBuildInputs = [
|
|
||||||
pkgs.brotli
|
|
||||||
(
|
|
||||||
let
|
|
||||||
# python3Minimal can't be overridden with packages on Darwin, due to a missing framework.
|
|
||||||
# Instead of modifying stdenv, we take the easy way out, since most people on Darwin will
|
|
||||||
# just be hacking on the Nixpkgs manual (which also uses make-options-doc).
|
|
||||||
python =
|
|
||||||
if pkgs.stdenv.isDarwin
|
|
||||||
then pkgs.python3
|
|
||||||
else pkgs.python3Minimal;
|
|
||||||
self = python.override {
|
|
||||||
inherit self;
|
|
||||||
includeSiteCustomize = true;
|
|
||||||
};
|
|
||||||
in
|
|
||||||
self.withPackages (p: [ p.mistune ])
|
|
||||||
)
|
|
||||||
];
|
|
||||||
options =
|
|
||||||
builtins.toFile "options.json"
|
|
||||||
(builtins.unsafeDiscardStringContext (builtins.toJSON optionsNix));
|
|
||||||
# merge with an empty set if baseOptionsJSON is null to run markdown
|
|
||||||
# processing on the input options
|
|
||||||
baseJSON =
|
|
||||||
if baseOptionsJSON == null
|
|
||||||
then builtins.toFile "base.json" "{}"
|
|
||||||
else baseOptionsJSON;
|
|
||||||
}
|
|
||||||
''
|
|
||||||
# Export list of options in different format.
|
|
||||||
dst=$out/share/doc/nixos
|
|
||||||
mkdir -p $dst
|
|
||||||
|
|
||||||
python ${./mergeJSON.py} \
|
|
||||||
${lib.optionalString warningsAreErrors "--warnings-are-errors"} \
|
|
||||||
${lib.optionalString (! allowDocBook) "--error-on-docbook"} \
|
|
||||||
${lib.optionalString markdownByDefault "--markdown-by-default"} \
|
|
||||||
$baseJSON $options \
|
|
||||||
> $dst/options.json
|
|
||||||
|
|
||||||
brotli -9 < $dst/options.json > $dst/options.json.br
|
|
||||||
|
|
||||||
mkdir -p $out/nix-support
|
|
||||||
echo "file json $dst/options.json" >> $out/nix-support/hydra-build-products
|
|
||||||
echo "file json-br $dst/options.json.br" >> $out/nix-support/hydra-build-products
|
|
||||||
'';
|
|
||||||
|
|
||||||
# Convert options.json into an XML file.
|
|
||||||
# The actual generation of the xml file is done in nix purely for the convenience
|
|
||||||
# of not having to generate the xml some other way
|
|
||||||
optionsXML = pkgs.runCommand "options.xml" { } ''
|
|
||||||
export NIX_STORE_DIR=$TMPDIR/store
|
|
||||||
export NIX_STATE_DIR=$TMPDIR/state
|
|
||||||
${pkgs.nix}/bin/nix-instantiate \
|
|
||||||
--eval --xml --strict ${./optionsJSONtoXML.nix} \
|
|
||||||
--argstr file ${optionsJSON}/share/doc/nixos/options.json \
|
|
||||||
> "$out"
|
|
||||||
'';
|
|
||||||
|
|
||||||
optionsDocBook = pkgs.runCommand "options-docbook.xml" { } ''
|
|
||||||
optionsXML=${optionsXML}
|
|
||||||
if grep /nixpkgs/nixos/modules $optionsXML; then
|
|
||||||
echo "The manual appears to depend on the location of Nixpkgs, which is bad"
|
|
||||||
echo "since this prevents sharing via the NixOS channel. This is typically"
|
|
||||||
echo "caused by an option default that refers to a relative path (see above"
|
|
||||||
echo "for hints about the offending path)."
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
${pkgs.python3Minimal}/bin/python ${./sortXML.py} $optionsXML sorted.xml
|
|
||||||
${pkgs.libxslt.bin}/bin/xsltproc \
|
|
||||||
--stringparam documentType '${documentType}' \
|
|
||||||
--stringparam revision '${revision}' \
|
|
||||||
--stringparam variablelistId '${variablelistId}' \
|
|
||||||
--stringparam optionIdPrefix '${optionIdPrefix}' \
|
|
||||||
-o intermediate.xml ${./options-to-docbook.xsl} sorted.xml
|
|
||||||
${pkgs.libxslt.bin}/bin/xsltproc \
|
|
||||||
-o "$out" ${./postprocess-option-descriptions.xsl} intermediate.xml
|
|
||||||
'';
|
|
||||||
}
|
|
987
indexer/test/types.nix
Normal file
987
indexer/test/types.nix
Normal file
@ -0,0 +1,987 @@
|
|||||||
|
# Definitions related to run-time type checking. Used in particular
|
||||||
|
# to type-check NixOS configurations.
|
||||||
|
{ lib }:
|
||||||
|
|
||||||
|
let
|
||||||
|
inherit (lib)
|
||||||
|
elem
|
||||||
|
flip
|
||||||
|
isAttrs
|
||||||
|
isBool
|
||||||
|
isDerivation
|
||||||
|
isFloat
|
||||||
|
isFunction
|
||||||
|
isInt
|
||||||
|
isList
|
||||||
|
isString
|
||||||
|
isStorePath
|
||||||
|
toDerivation
|
||||||
|
toList
|
||||||
|
;
|
||||||
|
inherit (lib.lists)
|
||||||
|
all
|
||||||
|
concatLists
|
||||||
|
count
|
||||||
|
elemAt
|
||||||
|
filter
|
||||||
|
foldl'
|
||||||
|
head
|
||||||
|
imap1
|
||||||
|
last
|
||||||
|
length
|
||||||
|
tail
|
||||||
|
;
|
||||||
|
inherit (lib.attrsets)
|
||||||
|
attrNames
|
||||||
|
filterAttrs
|
||||||
|
hasAttr
|
||||||
|
mapAttrs
|
||||||
|
optionalAttrs
|
||||||
|
zipAttrsWith
|
||||||
|
;
|
||||||
|
inherit (lib.options)
|
||||||
|
getFiles
|
||||||
|
getValues
|
||||||
|
mergeDefaultOption
|
||||||
|
mergeEqualOption
|
||||||
|
mergeOneOption
|
||||||
|
mergeUniqueOption
|
||||||
|
showFiles
|
||||||
|
showOption
|
||||||
|
;
|
||||||
|
inherit (lib.strings)
|
||||||
|
concatMapStringsSep
|
||||||
|
concatStringsSep
|
||||||
|
escapeNixString
|
||||||
|
hasInfix
|
||||||
|
isStringLike
|
||||||
|
;
|
||||||
|
inherit (lib.trivial)
|
||||||
|
boolToString
|
||||||
|
;
|
||||||
|
|
||||||
|
inherit (lib.modules)
|
||||||
|
mergeDefinitions
|
||||||
|
fixupOptionType
|
||||||
|
mergeOptionDecls
|
||||||
|
;
|
||||||
|
outer_types =
|
||||||
|
rec {
|
||||||
|
isType = type: x: (x._type or "") == type;
|
||||||
|
|
||||||
|
setType = typeName: value: value // {
|
||||||
|
_type = typeName;
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
/* Default type merging function
|
||||||
|
takes two type functors and return the merged type
|
||||||
|
|
||||||
|
*/
|
||||||
|
defaultTypeMerge = f: f':
|
||||||
|
let wrapped = f.wrapped.typeMerge f'.wrapped.functor;
|
||||||
|
payload = f.binOp f.payload f'.payload;
|
||||||
|
in
|
||||||
|
# cannot merge different types
|
||||||
|
if f.name != f'.name
|
||||||
|
then null
|
||||||
|
# simple types
|
||||||
|
else if (f.wrapped == null && f'.wrapped == null)
|
||||||
|
&& (f.payload == null && f'.payload == null)
|
||||||
|
then f.type
|
||||||
|
# composed types
|
||||||
|
else if (f.wrapped != null && f'.wrapped != null) && (wrapped != null)
|
||||||
|
then f.type wrapped
|
||||||
|
# value types
|
||||||
|
else if (f.payload != null && f'.payload != null) && (payload != null)
|
||||||
|
then f.type payload
|
||||||
|
else null;
|
||||||
|
|
||||||
|
/* Default type functor */
|
||||||
|
defaultFunctor = name: {
|
||||||
|
inherit name;
|
||||||
|
type = types.${name} or null;
|
||||||
|
wrapped = null;
|
||||||
|
payload = null;
|
||||||
|
binOp = a: b: null;
|
||||||
|
};
|
||||||
|
|
||||||
|
isOptionType = isType "option-type";
|
||||||
|
/*
|
||||||
|
Function that creates an optionType to be used in the module system.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
Type:
|
||||||
|
{
|
||||||
|
name :: String;
|
||||||
|
description :: String ?;
|
||||||
|
descriptionClass :: "noun" | "conjunction" | "composite" ?;
|
||||||
|
check :: (a -> Bool) ?;
|
||||||
|
merge ::
|
||||||
|
emptyValue :: {} ?;
|
||||||
|
getSubOptions :: ( [String] -> {}) ?;
|
||||||
|
getSubModules :: ( [Module] ) ?;
|
||||||
|
substSubModules :: ( [Module] ) ?;
|
||||||
|
typeMerge ::
|
||||||
|
functor ::
|
||||||
|
deprecationMessage ::
|
||||||
|
nestedTypes ::
|
||||||
|
}
|
||||||
|
->
|
||||||
|
{
|
||||||
|
name :: String
|
||||||
|
name check merge emptyValue getSubOptions getSubModules substSubModules
|
||||||
|
typeMerge functor deprecationMessage nestedTypes descriptionClass;
|
||||||
|
description = if description == null then name else description;
|
||||||
|
|
||||||
|
_type :: "option-type";
|
||||||
|
};
|
||||||
|
|
||||||
|
*/
|
||||||
|
mkOptionType =
|
||||||
|
{ # Human-readable representation of the type, should be equivalent to
|
||||||
|
# the type function name.
|
||||||
|
name
|
||||||
|
, # Description of the type, defined recursively by embedding the wrapped type if any.
|
||||||
|
description ? null
|
||||||
|
# A hint for whether or not this description needs parentheses. Possible values:
|
||||||
|
# - "noun": a simple noun phrase such as "positive integer"
|
||||||
|
# - "conjunction": a phrase with a potentially ambiguous "or" connective.
|
||||||
|
# - "composite": a phrase with an "of" connective
|
||||||
|
# See the `optionDescriptionPhrase` function.
|
||||||
|
, descriptionClass ? null
|
||||||
|
, # DO NOT USE WITHOUT KNOWING WHAT YOU ARE DOING!
|
||||||
|
# Function applied to each definition that must return false when a definition
|
||||||
|
# does not match the type. It should not check more than the root of the value,
|
||||||
|
# because checking nested values reduces laziness, leading to unnecessary
|
||||||
|
# infinite recursions in the module system.
|
||||||
|
# Further checks of nested values should be performed by throwing in
|
||||||
|
# the merge function.
|
||||||
|
# Strict and deep type checking can be performed by calling lib.deepSeq on
|
||||||
|
# the merged value.
|
||||||
|
#
|
||||||
|
# See https://github.com/NixOS/nixpkgs/pull/6794 that introduced this change,
|
||||||
|
# https://github.com/NixOS/nixpkgs/pull/173568 and
|
||||||
|
# https://github.com/NixOS/nixpkgs/pull/168295 that attempted to revert this,
|
||||||
|
# https://github.com/NixOS/nixpkgs/issues/191124 and
|
||||||
|
# https://github.com/NixOS/nixos-search/issues/391 for what happens if you ignore
|
||||||
|
# this disclaimer.
|
||||||
|
check ? (x: true)
|
||||||
|
, # Merge a list of definitions together into a single value.
|
||||||
|
# This function is called with two arguments: the location of
|
||||||
|
# the option in the configuration as a list of strings
|
||||||
|
# (e.g. ["boot" "loader "grub" "enable"]), and a list of
|
||||||
|
# definition values and locations (e.g. [ { file = "/foo.nix";
|
||||||
|
# value = 1; } { file = "/bar.nix"; value = 2 } ]).
|
||||||
|
merge ? mergeDefaultOption
|
||||||
|
, # Whether this type has a value representing nothingness. If it does,
|
||||||
|
# this should be a value of the form { value = <the nothing value>; }
|
||||||
|
# If it doesn't, this should be {}
|
||||||
|
# This may be used when a value is required for `mkIf false`. This allows the extra laziness in e.g. `lazyAttrsOf`.
|
||||||
|
emptyValue ? {}
|
||||||
|
, # Return a flat list of sub-options. Used to generate
|
||||||
|
# documentation.
|
||||||
|
getSubOptions ? prefix: {}
|
||||||
|
, # List of modules if any, or null if none.
|
||||||
|
getSubModules ? null
|
||||||
|
, # Function for building the same option type with a different list of
|
||||||
|
# modules.
|
||||||
|
substSubModules ? m: null
|
||||||
|
, # Function that merge type declarations.
|
||||||
|
# internal, takes a functor as argument and returns the merged type.
|
||||||
|
# returning null means the type is not mergeable
|
||||||
|
typeMerge ? defaultTypeMerge functor
|
||||||
|
, # The type functor.
|
||||||
|
# internal, representation of the type as an attribute set.
|
||||||
|
# name: name of the type
|
||||||
|
# type: type function.
|
||||||
|
# wrapped: the type wrapped in case of compound types.
|
||||||
|
# payload: values of the type, two payloads of the same type must be
|
||||||
|
# combinable with the binOp binary operation.
|
||||||
|
# binOp: binary operation that merge two payloads of the same type.
|
||||||
|
functor ? defaultFunctor name
|
||||||
|
, # The deprecation message to display when this type is used by an option
|
||||||
|
# If null, the type isn't deprecated
|
||||||
|
deprecationMessage ? null
|
||||||
|
, # The types that occur in the definition of this type. This is used to
|
||||||
|
# issue deprecation warnings recursively. Can also be used to reuse
|
||||||
|
# nested types
|
||||||
|
nestedTypes ? {}
|
||||||
|
}:
|
||||||
|
{ _type = "option-type";
|
||||||
|
inherit
|
||||||
|
name check merge emptyValue getSubOptions getSubModules substSubModules
|
||||||
|
typeMerge functor deprecationMessage nestedTypes descriptionClass;
|
||||||
|
description = if description == null then name else description;
|
||||||
|
};
|
||||||
|
|
||||||
|
# optionDescriptionPhrase :: (str -> bool) -> optionType -> str
|
||||||
|
#
|
||||||
|
# Helper function for producing unambiguous but readable natural language
|
||||||
|
# descriptions of types.
|
||||||
|
#
|
||||||
|
# Parameters
|
||||||
|
#
|
||||||
|
# optionDescriptionPhase unparenthesize optionType
|
||||||
|
#
|
||||||
|
# `unparenthesize`: A function from descriptionClass string to boolean.
|
||||||
|
# It must return true when the class of phrase will fit unambiguously into
|
||||||
|
# the description of the caller.
|
||||||
|
#
|
||||||
|
# `optionType`: The option type to parenthesize or not.
|
||||||
|
# The option whose description we're returning.
|
||||||
|
#
|
||||||
|
# Return value
|
||||||
|
#
|
||||||
|
# The description of the `optionType`, with parentheses if there may be an
|
||||||
|
# ambiguity.
|
||||||
|
optionDescriptionPhrase = unparenthesize: t:
|
||||||
|
if unparenthesize (t.descriptionClass or null)
|
||||||
|
then t.description
|
||||||
|
else "(${t.description})";
|
||||||
|
|
||||||
|
# When adding new types don't forget to document them in
|
||||||
|
# nixos/doc/manual/development/option-types.xml!
|
||||||
|
types = rec {
|
||||||
|
/*
|
||||||
|
Can be anything.
|
||||||
|
|
||||||
|
Merge behavior: None; Merging is disabled.
|
||||||
|
|
||||||
|
*/
|
||||||
|
raw = mkOptionType rec {
|
||||||
|
name = "raw";
|
||||||
|
description = "raw value";
|
||||||
|
descriptionClass = "noun";
|
||||||
|
check = value: true;
|
||||||
|
merge = mergeOneOption;
|
||||||
|
};
|
||||||
|
/*
|
||||||
|
Can be anything.
|
||||||
|
|
||||||
|
Merge behavior: Custom Logic
|
||||||
|
*/
|
||||||
|
anything = mkOptionType {
|
||||||
|
name = "anything";
|
||||||
|
description = "anything";
|
||||||
|
descriptionClass = "noun";
|
||||||
|
check = value: true;
|
||||||
|
merge = loc: defs:
|
||||||
|
let
|
||||||
|
getType = value:
|
||||||
|
if isAttrs value && isStringLike value
|
||||||
|
then "stringCoercibleSet"
|
||||||
|
else builtins.typeOf value;
|
||||||
|
|
||||||
|
# Returns the common type of all definitions, throws an error if they
|
||||||
|
# don't have the same type
|
||||||
|
commonType = foldl' (type: def:
|
||||||
|
if getType def.value == type
|
||||||
|
then type
|
||||||
|
else throw "The option `${showOption loc}' has conflicting option types in ${showFiles (getFiles defs)}"
|
||||||
|
) (getType (head defs).value) defs;
|
||||||
|
|
||||||
|
mergeFunction = {
|
||||||
|
# Recursively merge attribute sets
|
||||||
|
set = (attrsOf anything).merge;
|
||||||
|
# Safe and deterministic behavior for lists is to only accept one definition
|
||||||
|
# listOf only used to apply mkIf and co.
|
||||||
|
list =
|
||||||
|
if length defs > 1
|
||||||
|
then throw "The option `${showOption loc}' has conflicting definitions, in ${showFiles (getFiles defs)}."
|
||||||
|
else (listOf anything).merge;
|
||||||
|
# This is the type of packages, only accept a single definition
|
||||||
|
stringCoercibleSet = mergeOneOption;
|
||||||
|
lambda = loc: defs: arg: anything.merge
|
||||||
|
(loc ++ [ "<function body>" ])
|
||||||
|
(map (def: {
|
||||||
|
file = def.file;
|
||||||
|
value = def.value arg;
|
||||||
|
}) defs);
|
||||||
|
# Otherwise fall back to only allowing all equal definitions
|
||||||
|
}.${commonType} or mergeEqualOption;
|
||||||
|
in mergeFunction loc defs;
|
||||||
|
};
|
||||||
|
|
||||||
|
/*
|
||||||
|
Can be anything.
|
||||||
|
|
||||||
|
Merge behavior: Default logic
|
||||||
|
*/
|
||||||
|
unspecified = mkOptionType {
|
||||||
|
name = "unspecified";
|
||||||
|
description = "unspecified value";
|
||||||
|
descriptionClass = "noun";
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
/*
|
||||||
|
Allows Boolean values
|
||||||
|
|
||||||
|
Merge behavior: Enabled; see lib.mergeEqualOption;
|
||||||
|
*/
|
||||||
|
bool = mkOptionType {
|
||||||
|
name = "bool";
|
||||||
|
description = "boolean";
|
||||||
|
descriptionClass = "noun";
|
||||||
|
check = isBool;
|
||||||
|
merge = mergeEqualOption;
|
||||||
|
};
|
||||||
|
|
||||||
|
int = mkOptionType {
|
||||||
|
name = "int";
|
||||||
|
description = "signed integer";
|
||||||
|
descriptionClass = "noun";
|
||||||
|
check = isInt;
|
||||||
|
merge = mergeEqualOption;
|
||||||
|
};
|
||||||
|
|
||||||
|
/* Specialized subdomains of int
|
||||||
|
|
||||||
|
- ints.between
|
||||||
|
- ints.unsigned
|
||||||
|
- ints.u8
|
||||||
|
- ints.u16
|
||||||
|
- ints.u32
|
||||||
|
- ints.s8
|
||||||
|
- ints.s16
|
||||||
|
- ints.s32
|
||||||
|
|
||||||
|
|
||||||
|
Example:
|
||||||
|
(ints.between 0 100).check (-1)
|
||||||
|
=> false
|
||||||
|
(ints.between 0 100).check (101)
|
||||||
|
=> false
|
||||||
|
(ints.between 0 0).check 0
|
||||||
|
=> true
|
||||||
|
*/
|
||||||
|
ints =
|
||||||
|
let
|
||||||
|
betweenDesc = lowest: highest:
|
||||||
|
"${toString lowest} and ${toString highest} (both inclusive)";
|
||||||
|
between = lowest: highest:
|
||||||
|
assert lib.assertMsg (lowest <= highest)
|
||||||
|
"ints.between: lowest must be smaller than highest";
|
||||||
|
addCheck int (x: x >= lowest && x <= highest) // {
|
||||||
|
name = "intBetween";
|
||||||
|
description = "integer between ${betweenDesc lowest highest}";
|
||||||
|
};
|
||||||
|
ign = lowest: highest: name: docStart:
|
||||||
|
between lowest highest // {
|
||||||
|
inherit name;
|
||||||
|
description = docStart + "; between ${betweenDesc lowest highest}";
|
||||||
|
};
|
||||||
|
unsign = bit: range: ign 0 (range - 1)
|
||||||
|
"unsignedInt${toString bit}" "${toString bit} bit unsigned integer";
|
||||||
|
sign = bit: range: ign (0 - (range / 2)) (range / 2 - 1)
|
||||||
|
"signedInt${toString bit}" "${toString bit} bit signed integer";
|
||||||
|
|
||||||
|
in {
|
||||||
|
/* An int with a fixed range.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
(ints.between 0 100).check (-1)
|
||||||
|
=> false
|
||||||
|
(ints.between 0 100).check (101)
|
||||||
|
=> false
|
||||||
|
(ints.between 0 0).check 0
|
||||||
|
=> true
|
||||||
|
*/
|
||||||
|
inherit between;
|
||||||
|
|
||||||
|
unsigned = addCheck types.int (x: x >= 0) // {
|
||||||
|
name = "unsignedInt";
|
||||||
|
description = "unsigned integer, meaning >=0";
|
||||||
|
};
|
||||||
|
positive = addCheck types.int (x: x > 0) // {
|
||||||
|
name = "positiveInt";
|
||||||
|
description = "positive integer, meaning >0";
|
||||||
|
};
|
||||||
|
u8 = unsign 8 256;
|
||||||
|
u16 = unsign 16 65536;
|
||||||
|
# the biggest int Nix accepts is 2^63 - 1 (9223372036854775808)
|
||||||
|
# the smallest int Nix accepts is -2^63 (-9223372036854775807)
|
||||||
|
u32 = unsign 32 4294967296;
|
||||||
|
# u64 = unsign 64 18446744073709551616;
|
||||||
|
|
||||||
|
s8 = sign 8 256;
|
||||||
|
s16 = sign 16 65536;
|
||||||
|
s32 = sign 32 4294967296;
|
||||||
|
};
|
||||||
|
|
||||||
|
/*
|
||||||
|
Port number can be unsigned 16 bit
|
||||||
|
|
||||||
|
from 0 to 65536
|
||||||
|
|
||||||
|
Alias of ints.u16 for a port number. -> See tye.ints for more infos.
|
||||||
|
*/
|
||||||
|
port = ints.u16;
|
||||||
|
|
||||||
|
/*
|
||||||
|
A Float number
|
||||||
|
|
||||||
|
For more information about validation see: lib.isFloat
|
||||||
|
|
||||||
|
Merge behavior: Enabled; see lib.mergeEqualOption
|
||||||
|
*/
|
||||||
|
float = mkOptionType {
|
||||||
|
name = "float";
|
||||||
|
description = "floating point number";
|
||||||
|
descriptionClass = "noun";
|
||||||
|
check = isFloat;
|
||||||
|
merge = mergeEqualOption;
|
||||||
|
};
|
||||||
|
|
||||||
|
/*
|
||||||
|
Can be either an Int or a Float
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
*/
|
||||||
|
number = either int float;
|
||||||
|
|
||||||
|
numbers = let
|
||||||
|
betweenDesc = lowest: highest:
|
||||||
|
"${builtins.toJSON lowest} and ${builtins.toJSON highest} (both inclusive)";
|
||||||
|
in {
|
||||||
|
between = lowest: highest:
|
||||||
|
assert lib.assertMsg (lowest <= highest)
|
||||||
|
"numbers.between: lowest must be smaller than highest";
|
||||||
|
addCheck number (x: x >= lowest && x <= highest) // {
|
||||||
|
name = "numberBetween";
|
||||||
|
description = "integer or floating point number between ${betweenDesc lowest highest}";
|
||||||
|
};
|
||||||
|
|
||||||
|
nonnegative = addCheck number (x: x >= 0) // {
|
||||||
|
name = "numberNonnegative";
|
||||||
|
description = "nonnegative integer or floating point number, meaning >=0";
|
||||||
|
};
|
||||||
|
positive = addCheck number (x: x > 0) // {
|
||||||
|
name = "numberPositive";
|
||||||
|
description = "positive integer or floating point number, meaning >0";
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
str = mkOptionType {
|
||||||
|
name = "str";
|
||||||
|
description = "string";
|
||||||
|
descriptionClass = "noun";
|
||||||
|
check = isString;
|
||||||
|
merge = mergeEqualOption;
|
||||||
|
};
|
||||||
|
|
||||||
|
nonEmptyStr = mkOptionType {
|
||||||
|
name = "nonEmptyStr";
|
||||||
|
description = "non-empty string";
|
||||||
|
descriptionClass = "noun";
|
||||||
|
check = x: str.check x && builtins.match "[ \t\n]*" x == null;
|
||||||
|
inherit (str) merge;
|
||||||
|
};
|
||||||
|
|
||||||
|
# Allow a newline character at the end and trim it in the merge function.
|
||||||
|
singleLineStr =
|
||||||
|
let
|
||||||
|
inherit (strMatching "[^\n\r]*\n?") check merge;
|
||||||
|
in
|
||||||
|
mkOptionType {
|
||||||
|
name = "singleLineStr";
|
||||||
|
description = "(optionally newline-terminated) single-line string";
|
||||||
|
descriptionClass = "noun";
|
||||||
|
inherit check;
|
||||||
|
merge = loc: defs:
|
||||||
|
lib.removeSuffix "\n" (merge loc defs);
|
||||||
|
};
|
||||||
|
|
||||||
|
strMatching = pattern: mkOptionType {
|
||||||
|
name = "strMatching ${escapeNixString pattern}";
|
||||||
|
description = "string matching the pattern ${pattern}";
|
||||||
|
descriptionClass = "noun";
|
||||||
|
check = x: str.check x && builtins.match pattern x != null;
|
||||||
|
inherit (str) merge;
|
||||||
|
};
|
||||||
|
|
||||||
|
# Merge multiple definitions by concatenating them (with the given
|
||||||
|
# separator between the values).
|
||||||
|
separatedString = sep: mkOptionType rec {
|
||||||
|
name = "separatedString";
|
||||||
|
description = if sep == ""
|
||||||
|
then "Concatenated string" # for types.string.
|
||||||
|
else "strings concatenated with ${builtins.toJSON sep}"
|
||||||
|
;
|
||||||
|
descriptionClass = "noun";
|
||||||
|
check = isString;
|
||||||
|
merge = loc: defs: concatStringsSep sep (getValues defs);
|
||||||
|
functor = (defaultFunctor name) // {
|
||||||
|
payload = sep;
|
||||||
|
binOp = sepLhs: sepRhs:
|
||||||
|
if sepLhs == sepRhs then sepLhs
|
||||||
|
else null;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
lines = separatedString "\n";
|
||||||
|
commas = separatedString ",";
|
||||||
|
envVar = separatedString ":";
|
||||||
|
|
||||||
|
# Deprecated; should not be used because it quietly concatenates
|
||||||
|
# strings, which is usually not what you want.
|
||||||
|
string = separatedString "" // {
|
||||||
|
name = "string";
|
||||||
|
deprecationMessage = "See https://github.com/NixOS/nixpkgs/pull/66346 for better alternative types.";
|
||||||
|
};
|
||||||
|
|
||||||
|
passwdEntry = entryType: addCheck entryType (str: !(hasInfix ":" str || hasInfix "\n" str)) // {
|
||||||
|
name = "passwdEntry ${entryType.name}";
|
||||||
|
description = "${optionDescriptionPhrase (class: class == "noun") entryType}, not containing newlines or colons";
|
||||||
|
};
|
||||||
|
|
||||||
|
attrs = mkOptionType {
|
||||||
|
name = "attrs";
|
||||||
|
description = "attribute set";
|
||||||
|
check = isAttrs;
|
||||||
|
merge = loc: foldl' (res: def: res // def.value) {};
|
||||||
|
emptyValue = { value = {}; };
|
||||||
|
};
|
||||||
|
|
||||||
|
/*
|
||||||
|
A package is a top-level store path (/nix/store/hash-name). This includes:
|
||||||
|
|
||||||
|
- derivations
|
||||||
|
- more generally, attribute sets with an `outPath` or `__toString` attribute
|
||||||
|
pointing to a store path, e.g. flake inputs
|
||||||
|
- strings with context, e.g. "${pkgs.foo}" or (toString pkgs.foo)
|
||||||
|
- hardcoded store path literals (/nix/store/hash-foo) or strings without context
|
||||||
|
("/nix/store/hash-foo"). These get a context added to them using builtins.storePath.
|
||||||
|
*/
|
||||||
|
package = mkOptionType {
|
||||||
|
name = "package";
|
||||||
|
descriptionClass = "noun";
|
||||||
|
check = x: isDerivation x || isStorePath x;
|
||||||
|
merge = loc: defs:
|
||||||
|
let res = mergeOneOption loc defs;
|
||||||
|
in if builtins.isPath res || (builtins.isString res && ! builtins.hasContext res)
|
||||||
|
then toDerivation res
|
||||||
|
else res;
|
||||||
|
};
|
||||||
|
|
||||||
|
shellPackage = package // {
|
||||||
|
check = x: isDerivation x && hasAttr "shellPath" x;
|
||||||
|
};
|
||||||
|
|
||||||
|
path = mkOptionType {
|
||||||
|
name = "path";
|
||||||
|
descriptionClass = "noun";
|
||||||
|
check = x: isStringLike x && builtins.substring 0 1 (toString x) == "/";
|
||||||
|
merge = mergeEqualOption;
|
||||||
|
};
|
||||||
|
|
||||||
|
listOf = elemType: mkOptionType rec {
|
||||||
|
name = "listOf";
|
||||||
|
description = "list of ${optionDescriptionPhrase (class: class == "noun" || class == "composite") elemType}";
|
||||||
|
descriptionClass = "composite";
|
||||||
|
check = isList;
|
||||||
|
merge = loc: defs:
|
||||||
|
map (x: x.value) (filter (x: x ? value) (concatLists (imap1 (n: def:
|
||||||
|
imap1 (m: def':
|
||||||
|
(mergeDefinitions
|
||||||
|
(loc ++ ["[definition ${toString n}-entry ${toString m}]"])
|
||||||
|
elemType
|
||||||
|
[{ inherit (def) file; value = def'; }]
|
||||||
|
).optionalValue
|
||||||
|
) def.value
|
||||||
|
) defs)));
|
||||||
|
emptyValue = { value = []; };
|
||||||
|
getSubOptions = prefix: elemType.getSubOptions (prefix ++ ["*"]);
|
||||||
|
getSubModules = elemType.getSubModules;
|
||||||
|
substSubModules = m: listOf (elemType.substSubModules m);
|
||||||
|
functor = (defaultFunctor name) // { wrapped = elemType; };
|
||||||
|
nestedTypes.elemType = elemType;
|
||||||
|
};
|
||||||
|
|
||||||
|
nonEmptyListOf = elemType:
|
||||||
|
let list = addCheck (types.listOf elemType) (l: l != []);
|
||||||
|
in list // {
|
||||||
|
description = "non-empty ${optionDescriptionPhrase (class: class == "noun") list}";
|
||||||
|
emptyValue = { }; # no .value attr, meaning unset
|
||||||
|
};
|
||||||
|
|
||||||
|
attrsOf = elemType: mkOptionType rec {
|
||||||
|
name = "attrsOf";
|
||||||
|
description = "attribute set of ${optionDescriptionPhrase (class: class == "noun" || class == "composite") elemType}";
|
||||||
|
descriptionClass = "composite";
|
||||||
|
check = isAttrs;
|
||||||
|
merge = loc: defs:
|
||||||
|
mapAttrs (n: v: v.value) (filterAttrs (n: v: v ? value) (zipAttrsWith (name: defs:
|
||||||
|
(mergeDefinitions (loc ++ [name]) elemType defs).optionalValue
|
||||||
|
)
|
||||||
|
# Push down position info.
|
||||||
|
(map (def: mapAttrs (n: v: { inherit (def) file; value = v; }) def.value) defs)));
|
||||||
|
emptyValue = { value = {}; };
|
||||||
|
getSubOptions = prefix: elemType.getSubOptions (prefix ++ ["<name>"]);
|
||||||
|
getSubModules = elemType.getSubModules;
|
||||||
|
substSubModules = m: attrsOf (elemType.substSubModules m);
|
||||||
|
functor = (defaultFunctor name) // { wrapped = elemType; };
|
||||||
|
nestedTypes.elemType = elemType;
|
||||||
|
};
|
||||||
|
|
||||||
|
# A version of attrsOf that's lazy in its values at the expense of
|
||||||
|
# conditional definitions not working properly. E.g. defining a value with
|
||||||
|
# `foo.attr = mkIf false 10`, then `foo ? attr == true`, whereas with
|
||||||
|
# attrsOf it would correctly be `false`. Accessing `foo.attr` would throw an
|
||||||
|
# error that it's not defined. Use only if conditional definitions don't make sense.
|
||||||
|
lazyAttrsOf = elemType: mkOptionType rec {
|
||||||
|
name = "lazyAttrsOf";
|
||||||
|
description = "lazy attribute set of ${optionDescriptionPhrase (class: class == "noun" || class == "composite") elemType}";
|
||||||
|
descriptionClass = "composite";
|
||||||
|
check = isAttrs;
|
||||||
|
merge = loc: defs:
|
||||||
|
zipAttrsWith (name: defs:
|
||||||
|
let merged = mergeDefinitions (loc ++ [name]) elemType defs;
|
||||||
|
# mergedValue will trigger an appropriate error when accessed
|
||||||
|
in merged.optionalValue.value or elemType.emptyValue.value or merged.mergedValue
|
||||||
|
)
|
||||||
|
# Push down position info.
|
||||||
|
(map (def: mapAttrs (n: v: { inherit (def) file; value = v; }) def.value) defs);
|
||||||
|
emptyValue = { value = {}; };
|
||||||
|
getSubOptions = prefix: elemType.getSubOptions (prefix ++ ["<name>"]);
|
||||||
|
getSubModules = elemType.getSubModules;
|
||||||
|
substSubModules = m: lazyAttrsOf (elemType.substSubModules m);
|
||||||
|
functor = (defaultFunctor name) // { wrapped = elemType; };
|
||||||
|
nestedTypes.elemType = elemType;
|
||||||
|
};
|
||||||
|
|
||||||
|
# TODO: deprecate this in the future:
|
||||||
|
loaOf = elemType: types.attrsOf elemType // {
|
||||||
|
name = "loaOf";
|
||||||
|
deprecationMessage = "Mixing lists with attribute values is no longer"
|
||||||
|
+ " possible; please use `types.attrsOf` instead. See"
|
||||||
|
+ " https://github.com/NixOS/nixpkgs/issues/1800 for the motivation.";
|
||||||
|
nestedTypes.elemType = elemType;
|
||||||
|
};
|
||||||
|
|
||||||
|
# Value of given type but with no merging (i.e. `uniq list`s are not concatenated).
|
||||||
|
uniq = elemType: mkOptionType rec {
|
||||||
|
name = "uniq";
|
||||||
|
inherit (elemType) description descriptionClass check;
|
||||||
|
merge = mergeOneOption;
|
||||||
|
emptyValue = elemType.emptyValue;
|
||||||
|
getSubOptions = elemType.getSubOptions;
|
||||||
|
getSubModules = elemType.getSubModules;
|
||||||
|
substSubModules = m: uniq (elemType.substSubModules m);
|
||||||
|
functor = (defaultFunctor name) // { wrapped = elemType; };
|
||||||
|
nestedTypes.elemType = elemType;
|
||||||
|
};
|
||||||
|
|
||||||
|
unique = { message }: type: mkOptionType rec {
|
||||||
|
name = "unique";
|
||||||
|
inherit (type) description descriptionClass check;
|
||||||
|
merge = mergeUniqueOption { inherit message; };
|
||||||
|
emptyValue = type.emptyValue;
|
||||||
|
getSubOptions = type.getSubOptions;
|
||||||
|
getSubModules = type.getSubModules;
|
||||||
|
substSubModules = m: uniq (type.substSubModules m);
|
||||||
|
functor = (defaultFunctor name) // { wrapped = type; };
|
||||||
|
nestedTypes.elemType = type;
|
||||||
|
};
|
||||||
|
|
||||||
|
# Null or value of ...
|
||||||
|
nullOr = elemType: mkOptionType rec {
|
||||||
|
name = "nullOr";
|
||||||
|
description = "null or ${optionDescriptionPhrase (class: class == "noun" || class == "conjunction") elemType}";
|
||||||
|
descriptionClass = "conjunction";
|
||||||
|
check = x: x == null || elemType.check x;
|
||||||
|
merge = loc: defs:
|
||||||
|
let nrNulls = count (def: def.value == null) defs; in
|
||||||
|
if nrNulls == length defs then null
|
||||||
|
else if nrNulls != 0 then
|
||||||
|
throw "The option `${showOption loc}` is defined both null and not null, in ${showFiles (getFiles defs)}."
|
||||||
|
else elemType.merge loc defs;
|
||||||
|
emptyValue = { value = null; };
|
||||||
|
getSubOptions = elemType.getSubOptions;
|
||||||
|
getSubModules = elemType.getSubModules;
|
||||||
|
substSubModules = m: nullOr (elemType.substSubModules m);
|
||||||
|
functor = (defaultFunctor name) // { wrapped = elemType; };
|
||||||
|
nestedTypes.elemType = elemType;
|
||||||
|
};
|
||||||
|
|
||||||
|
functionTo = elemType: mkOptionType {
|
||||||
|
name = "functionTo";
|
||||||
|
description = "function that evaluates to a(n) ${optionDescriptionPhrase (class: class == "noun" || class == "composite") elemType}";
|
||||||
|
descriptionClass = "composite";
|
||||||
|
check = isFunction;
|
||||||
|
merge = loc: defs:
|
||||||
|
fnArgs: (mergeDefinitions (loc ++ [ "<function body>" ]) elemType (map (fn: { inherit (fn) file; value = fn.value fnArgs; }) defs)).mergedValue;
|
||||||
|
getSubOptions = prefix: elemType.getSubOptions (prefix ++ [ "<function body>" ]);
|
||||||
|
getSubModules = elemType.getSubModules;
|
||||||
|
substSubModules = m: functionTo (elemType.substSubModules m);
|
||||||
|
functor = (defaultFunctor "functionTo") // { wrapped = elemType; };
|
||||||
|
nestedTypes.elemType = elemType;
|
||||||
|
};
|
||||||
|
|
||||||
|
# A submodule (like typed attribute set). See NixOS manual.
|
||||||
|
submodule = modules: submoduleWith {
|
||||||
|
shorthandOnlyDefinesConfig = true;
|
||||||
|
modules = toList modules;
|
||||||
|
};
|
||||||
|
|
||||||
|
# A module to be imported in some other part of the configuration.
|
||||||
|
deferredModule = deferredModuleWith { };
|
||||||
|
|
||||||
|
# A module to be imported in some other part of the configuration.
|
||||||
|
# `staticModules`' options will be added to the documentation, unlike
|
||||||
|
# options declared via `config`.
|
||||||
|
deferredModuleWith = attrs@{ staticModules ? [] }: mkOptionType {
|
||||||
|
name = "deferredModule";
|
||||||
|
description = "module";
|
||||||
|
descriptionClass = "noun";
|
||||||
|
check = x: isAttrs x || isFunction x || path.check x;
|
||||||
|
merge = loc: defs: {
|
||||||
|
imports = staticModules ++ map (def: lib.setDefaultModuleLocation "${def.file}, via option ${showOption loc}" def.value) defs;
|
||||||
|
};
|
||||||
|
inherit (submoduleWith { modules = staticModules; })
|
||||||
|
getSubOptions
|
||||||
|
getSubModules;
|
||||||
|
substSubModules = m: deferredModuleWith (attrs // {
|
||||||
|
staticModules = m;
|
||||||
|
});
|
||||||
|
functor = defaultFunctor "deferredModuleWith" // {
|
||||||
|
type = types.deferredModuleWith;
|
||||||
|
payload = {
|
||||||
|
inherit staticModules;
|
||||||
|
};
|
||||||
|
binOp = lhs: rhs: {
|
||||||
|
staticModules = lhs.staticModules ++ rhs.staticModules;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
# The type of a type!
|
||||||
|
optionType = mkOptionType {
|
||||||
|
name = "optionType";
|
||||||
|
description = "optionType";
|
||||||
|
descriptionClass = "noun";
|
||||||
|
check = value: value._type or null == "option-type";
|
||||||
|
merge = loc: defs:
|
||||||
|
if length defs == 1
|
||||||
|
then (head defs).value
|
||||||
|
else let
|
||||||
|
# Prepares the type definitions for mergeOptionDecls, which
|
||||||
|
# annotates submodules types with file locations
|
||||||
|
optionModules = map ({ value, file }:
|
||||||
|
{
|
||||||
|
_file = file;
|
||||||
|
# There's no way to merge types directly from the module system,
|
||||||
|
# but we can cheat a bit by just declaring an option with the type
|
||||||
|
options = lib.mkOption {
|
||||||
|
type = value;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
) defs;
|
||||||
|
# Merges all the types into a single one, including submodule merging.
|
||||||
|
# This also propagates file information to all submodules
|
||||||
|
mergedOption = fixupOptionType loc (mergeOptionDecls loc optionModules);
|
||||||
|
in mergedOption.type;
|
||||||
|
};
|
||||||
|
|
||||||
|
submoduleWith =
|
||||||
|
{ modules
|
||||||
|
, specialArgs ? {}
|
||||||
|
, shorthandOnlyDefinesConfig ? false
|
||||||
|
, description ? null
|
||||||
|
}@attrs:
|
||||||
|
let
|
||||||
|
inherit (lib.modules) evalModules;
|
||||||
|
|
||||||
|
allModules = defs: map ({ value, file }:
|
||||||
|
if isAttrs value && shorthandOnlyDefinesConfig
|
||||||
|
then { _file = file; config = value; }
|
||||||
|
else { _file = file; imports = [ value ]; }
|
||||||
|
) defs;
|
||||||
|
|
||||||
|
base = evalModules {
|
||||||
|
inherit specialArgs;
|
||||||
|
modules = [{
|
||||||
|
# This is a work-around for the fact that some sub-modules,
|
||||||
|
# such as the one included in an attribute set, expects an "args"
|
||||||
|
# attribute to be given to the sub-module. As the option
|
||||||
|
# evaluation does not have any specific attribute name yet, we
|
||||||
|
# provide a default for the documentation and the freeform type.
|
||||||
|
#
|
||||||
|
# This is necessary as some option declaration might use the
|
||||||
|
# "name" attribute given as argument of the submodule and use it
|
||||||
|
# as the default of option declarations.
|
||||||
|
#
|
||||||
|
# We use lookalike unicode single angle quotation marks because
|
||||||
|
# of the docbook transformation the options receive. In all uses
|
||||||
|
# > and < wouldn't be encoded correctly so the encoded values
|
||||||
|
# would be used, and use of `<` and `>` would break the XML document.
|
||||||
|
# It shouldn't cause an issue since this is cosmetic for the manual.
|
||||||
|
_module.args.name = lib.mkOptionDefault "‹name›";
|
||||||
|
}] ++ modules;
|
||||||
|
};
|
||||||
|
|
||||||
|
freeformType = base._module.freeformType;
|
||||||
|
|
||||||
|
name = "submodule";
|
||||||
|
|
||||||
|
in
|
||||||
|
mkOptionType {
|
||||||
|
inherit name;
|
||||||
|
description =
|
||||||
|
if description != null then description
|
||||||
|
else freeformType.description or name;
|
||||||
|
check = x: isAttrs x || isFunction x || path.check x;
|
||||||
|
merge = loc: defs:
|
||||||
|
(base.extendModules {
|
||||||
|
modules = [ { _module.args.name = last loc; } ] ++ allModules defs;
|
||||||
|
prefix = loc;
|
||||||
|
}).config;
|
||||||
|
emptyValue = { value = {}; };
|
||||||
|
getSubOptions = prefix: (base.extendModules
|
||||||
|
{ inherit prefix; }).options // optionalAttrs (freeformType != null) {
|
||||||
|
# Expose the sub options of the freeform type. Note that the option
|
||||||
|
# discovery doesn't care about the attribute name used here, so this
|
||||||
|
# is just to avoid conflicts with potential options from the submodule
|
||||||
|
_freeformOptions = freeformType.getSubOptions prefix;
|
||||||
|
};
|
||||||
|
getSubModules = modules;
|
||||||
|
substSubModules = m: submoduleWith (attrs // {
|
||||||
|
modules = m;
|
||||||
|
});
|
||||||
|
nestedTypes = lib.optionalAttrs (freeformType != null) {
|
||||||
|
freeformType = freeformType;
|
||||||
|
};
|
||||||
|
functor = defaultFunctor name // {
|
||||||
|
type = types.submoduleWith;
|
||||||
|
payload = {
|
||||||
|
inherit modules specialArgs shorthandOnlyDefinesConfig description;
|
||||||
|
};
|
||||||
|
binOp = lhs: rhs: {
|
||||||
|
modules = lhs.modules ++ rhs.modules;
|
||||||
|
specialArgs =
|
||||||
|
let intersecting = builtins.intersectAttrs lhs.specialArgs rhs.specialArgs;
|
||||||
|
in if intersecting == {}
|
||||||
|
then lhs.specialArgs // rhs.specialArgs
|
||||||
|
else throw "A submoduleWith option is declared multiple times with the same specialArgs \"${toString (attrNames intersecting)}\"";
|
||||||
|
shorthandOnlyDefinesConfig =
|
||||||
|
if lhs.shorthandOnlyDefinesConfig == null
|
||||||
|
then rhs.shorthandOnlyDefinesConfig
|
||||||
|
else if rhs.shorthandOnlyDefinesConfig == null
|
||||||
|
then lhs.shorthandOnlyDefinesConfig
|
||||||
|
else if lhs.shorthandOnlyDefinesConfig == rhs.shorthandOnlyDefinesConfig
|
||||||
|
then lhs.shorthandOnlyDefinesConfig
|
||||||
|
else throw "A submoduleWith option is declared multiple times with conflicting shorthandOnlyDefinesConfig values";
|
||||||
|
description =
|
||||||
|
if lhs.description == null
|
||||||
|
then rhs.description
|
||||||
|
else if rhs.description == null
|
||||||
|
then lhs.description
|
||||||
|
else if lhs.description == rhs.description
|
||||||
|
then lhs.description
|
||||||
|
else throw "A submoduleWith option is declared multiple times with conflicting descriptions";
|
||||||
|
};
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
# A value from a set of allowed ones.
|
||||||
|
enum = values:
|
||||||
|
let
|
||||||
|
inherit (lib.lists) unique;
|
||||||
|
show = v:
|
||||||
|
if builtins.isString v then ''"${v}"''
|
||||||
|
else if builtins.isInt v then builtins.toString v
|
||||||
|
else if builtins.isBool v then boolToString v
|
||||||
|
else ''<${builtins.typeOf v}>'';
|
||||||
|
in
|
||||||
|
mkOptionType rec {
|
||||||
|
name = "enum";
|
||||||
|
description =
|
||||||
|
# Length 0 or 1 enums may occur in a design pattern with type merging
|
||||||
|
# where an "interface" module declares an empty enum and other modules
|
||||||
|
# provide implementations, each extending the enum with their own
|
||||||
|
# identifier.
|
||||||
|
if values == [] then
|
||||||
|
"impossible (empty enum)"
|
||||||
|
else if builtins.length values == 1 then
|
||||||
|
"value ${show (builtins.head values)} (singular enum)"
|
||||||
|
else
|
||||||
|
"one of ${concatMapStringsSep ", " show values}";
|
||||||
|
descriptionClass =
|
||||||
|
if builtins.length values < 2
|
||||||
|
then "noun"
|
||||||
|
else "conjunction";
|
||||||
|
check = flip elem values;
|
||||||
|
merge = mergeEqualOption;
|
||||||
|
functor = (defaultFunctor name) // { payload = values; binOp = a: b: unique (a ++ b); };
|
||||||
|
};
|
||||||
|
|
||||||
|
# Either value of type `t1` or `t2`.
|
||||||
|
either = t1: t2: mkOptionType rec {
|
||||||
|
name = "either";
|
||||||
|
description = "${optionDescriptionPhrase (class: class == "noun" || class == "conjunction") t1} or ${optionDescriptionPhrase (class: class == "noun" || class == "conjunction" || class == "composite") t2}";
|
||||||
|
descriptionClass = "conjunction";
|
||||||
|
check = x: t1.check x || t2.check x;
|
||||||
|
merge = loc: defs:
|
||||||
|
let
|
||||||
|
defList = map (d: d.value) defs;
|
||||||
|
in
|
||||||
|
if all (x: t1.check x) defList
|
||||||
|
then t1.merge loc defs
|
||||||
|
else if all (x: t2.check x) defList
|
||||||
|
then t2.merge loc defs
|
||||||
|
else mergeOneOption loc defs;
|
||||||
|
typeMerge = f':
|
||||||
|
let mt1 = t1.typeMerge (elemAt f'.wrapped 0).functor;
|
||||||
|
mt2 = t2.typeMerge (elemAt f'.wrapped 1).functor;
|
||||||
|
in
|
||||||
|
if (name == f'.name) && (mt1 != null) && (mt2 != null)
|
||||||
|
then functor.type mt1 mt2
|
||||||
|
else null;
|
||||||
|
functor = (defaultFunctor name) // { wrapped = [ t1 t2 ]; };
|
||||||
|
nestedTypes.left = t1;
|
||||||
|
nestedTypes.right = t2;
|
||||||
|
};
|
||||||
|
|
||||||
|
# Any of the types in the given list
|
||||||
|
oneOf = ts:
|
||||||
|
let
|
||||||
|
head' = if ts == [] then throw "types.oneOf needs to get at least one type in its argument" else head ts;
|
||||||
|
tail' = tail ts;
|
||||||
|
in foldl' either head' tail';
|
||||||
|
|
||||||
|
# Either value of type `coercedType` or `finalType`, the former is
|
||||||
|
# converted to `finalType` using `coerceFunc`.
|
||||||
|
coercedTo = coercedType: coerceFunc: finalType:
|
||||||
|
assert lib.assertMsg (coercedType.getSubModules == null)
|
||||||
|
"coercedTo: coercedType must not have submodules (it’s a ${
|
||||||
|
coercedType.description})";
|
||||||
|
mkOptionType rec {
|
||||||
|
name = "coercedTo";
|
||||||
|
description = "${optionDescriptionPhrase (class: class == "noun") finalType} or ${optionDescriptionPhrase (class: class == "noun") coercedType} convertible to it";
|
||||||
|
check = x: (coercedType.check x && finalType.check (coerceFunc x)) || finalType.check x;
|
||||||
|
merge = loc: defs:
|
||||||
|
let
|
||||||
|
coerceVal = val:
|
||||||
|
if coercedType.check val then coerceFunc val
|
||||||
|
else val;
|
||||||
|
in finalType.merge loc (map (def: def // { value = coerceVal def.value; }) defs);
|
||||||
|
emptyValue = finalType.emptyValue;
|
||||||
|
getSubOptions = finalType.getSubOptions;
|
||||||
|
getSubModules = finalType.getSubModules;
|
||||||
|
substSubModules = m: coercedTo coercedType coerceFunc (finalType.substSubModules m);
|
||||||
|
typeMerge = t1: t2: null;
|
||||||
|
functor = (defaultFunctor name) // { wrapped = finalType; };
|
||||||
|
nestedTypes.coercedType = coercedType;
|
||||||
|
nestedTypes.finalType = finalType;
|
||||||
|
};
|
||||||
|
|
||||||
|
# Augment the given type with an additional type check function.
|
||||||
|
addCheck = elemType: check: elemType // { check = x: elemType.check x && check x; };
|
||||||
|
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
in outer_types // outer_types.types
|
@ -1 +0,0 @@
|
|||||||
x86_64-linux
|
|
@ -32,3 +32,26 @@ workspaceMembers = []
|
|||||||
name = "indexer"
|
name = "indexer"
|
||||||
relPath = "indexer"
|
relPath = "indexer"
|
||||||
version = "0.1.0"
|
version = "0.1.0"
|
||||||
|
|
||||||
|
[builtins-data]
|
||||||
|
name = "builtins-data"
|
||||||
|
relPath = "scripts"
|
||||||
|
subsystem = "nodejs"
|
||||||
|
translator = "package-lock"
|
||||||
|
builder = "strict-builder"
|
||||||
|
translators = ["package-lock", "package-json"]
|
||||||
|
|
||||||
|
[builtins-data.subsystemInfo]
|
||||||
|
nodejs = 18
|
||||||
|
|
||||||
|
|
||||||
|
[tests]
|
||||||
|
name = "tests"
|
||||||
|
relPath = "tests"
|
||||||
|
subsystem = "nodejs"
|
||||||
|
translator = "package-lock"
|
||||||
|
builder = "strict-builder"
|
||||||
|
translators = ["package-lock", "package-json"]
|
||||||
|
|
||||||
|
[tests.subsystemInfo]
|
||||||
|
nodejs = 18
|
||||||
|
2
scripts/.gitignore
vendored
Normal file
2
scripts/.gitignore
vendored
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
data.json
|
||||||
|
node_modules
|
@ -24,7 +24,7 @@ if (!DATA_PATH) {
|
|||||||
],
|
],
|
||||||
};
|
};
|
||||||
});
|
});
|
||||||
fs.writeFile(`${DATA_PATH}/builtins.json`, JSON.stringify(info), (err) => {
|
fs.writeFile(`${DATA_PATH}/data.json`, JSON.stringify(info), (err) => {
|
||||||
if (err) {
|
if (err) {
|
||||||
console.error(err);
|
console.error(err);
|
||||||
}
|
}
|
11
scripts/package.json
Normal file
11
scripts/package.json
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
{
|
||||||
|
"name": "builtins-data",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"description": "",
|
||||||
|
"main": "make-builtins.js",
|
||||||
|
"scripts": {
|
||||||
|
"build": "node ./make-builtins.js ./"
|
||||||
|
},
|
||||||
|
"author": "",
|
||||||
|
"license": "ISC"
|
||||||
|
}
|
3
tests/.gitignore
vendored
Normal file
3
tests/.gitignore
vendored
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
|
||||||
|
node_modules
|
||||||
|
data/*
|
4160
tests/__snapshots__/data.test.js.snap
Normal file
4160
tests/__snapshots__/data.test.js.snap
Normal file
File diff suppressed because it is too large
Load Diff
9
tests/data.test.js
Normal file
9
tests/data.test.js
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
import libData from "./data/lib.json";
|
||||||
|
|
||||||
|
test("adds 1 + 2 to equal 3", () => {
|
||||||
|
expect(1 + 2).toBe(3);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("confirm data update", () => {
|
||||||
|
expect(libData).toMatchSnapshot();
|
||||||
|
});
|
10
tests/jest.config.js
Normal file
10
tests/jest.config.js
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
/** @type {import('jest').Config} */
|
||||||
|
|
||||||
|
import { defaults } from "jest-config";
|
||||||
|
|
||||||
|
const config = {
|
||||||
|
...defaults,
|
||||||
|
// transform: {},
|
||||||
|
};
|
||||||
|
|
||||||
|
export default config;
|
3434
tests/package-lock.json
generated
Normal file
3434
tests/package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
15
tests/package.json
Normal file
15
tests/package.json
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
{
|
||||||
|
"name": "tests",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"description": "",
|
||||||
|
"module": "index.js",
|
||||||
|
"type": "module",
|
||||||
|
"scripts": {
|
||||||
|
"test": "NODE_OPTIONS=--experimental-vm-modules npx jest"
|
||||||
|
},
|
||||||
|
"author": "",
|
||||||
|
"license": "ISC",
|
||||||
|
"devDependencies": {
|
||||||
|
"jest": "^29.4.3"
|
||||||
|
}
|
||||||
|
}
|
Loading…
Reference in New Issue
Block a user