summary refs log tree commit diff
path: root/lib/modules.nix
AgeCommit message (Collapse)AuthorFilesLines
2023-09-17Merge pull request #249243 from lf-/jade/declarationsWithLocationsRobert Hensing1-4/+11
nixos/modules: Add declarationPositions
2023-09-08nixos/modules: Add declarationPositionsJade Lovelace1-4/+11
What it does: line and column level *declaration* position information: $ nix repl . nix-repl> :p nixosConfigurations.micro.options.environment.systemPackages.declarationPositions [ { column = 7; file = "/nix/store/24aj3k7fgqv3ly7qkbf98qvphasrw9nb-source/nixos/modules/config/system-path.nix"; line = 63; } ] Use cases: - ctags over NixOS options, as will be presented at NixCon 2023 ;) - improving the documentation pages to go to the exact line of the declarations. Related work: - https://github.com/NixOS/nixpkgs/pull/65024 This one does it for all *definitions* rather than declarations, and it was not followed through with due to performance worries. - https://github.com/NixOS/nixpkgs/pull/208173 The basis for this change. This change is just a rebase of that one. I split it out to add the capability before adding users of it, in order to simplify review. However, the ctags script in there is a sample user of this feature. Benchmarks: conducted by evaluating my own reasonably complex NixOS configuration with the command: `hyperfine -S none -w 1 -- "nix eval .#nixosConfigurations.snowflake.config.system.build.toplevel.outPath"` ``` Benchmark 1: nix eval .#nixosConfigurations.snowflake.config.system.build.toplevel.outPath Time (mean ± σ): 8.971 s ± 0.254 s [User: 5.872 s, System: 1.388 s] Range (min … max): 8.574 s … 9.327 s 10 runs Benchmark 1: nix eval .#nixosConfigurations.snowflake.config.system.build.toplevel.outPath Time (mean ± σ): 8.766 s ± 0.160 s [User: 5.873 s, System: 1.346 s] Range (min … max): 8.496 s … 9.033 s 10 runs ``` Summary of results: it seems to be in the noise, this does not cause any visible regression in times.
2023-08-18lib/modules: Report a better error when option tree has bare typeRobert Hensing1-3/+3
Improves on 0d472a62012364d064f0b75f1da491242c6ae9c6 - https://github.com/NixOS/nixpkgs/pull/242339 We actually do have the file name. Thanks Shawn8901 for the [feedback]! feedback: https://github.com/NixOS/nixpkgs/pull/242339#issuecomment-1683107055
2023-08-14lib/modules: Report a good error when option tree has bare typeRobert Hensing1-1/+33
Note that this removes the possibility of declaring an option named `_type`.
2023-07-27Merge pull request #245271 from sternenseemann/module-system-merge-no-typeRobert Hensing1-1/+1
lib/modules: handle typeless options in mergeModules
2023-07-26lib/modules: handle typeless options in mergeModulessternenseemann1-1/+1
mkOption does not require a `type` argument and does not set the resulting attribute if it is not given. Consequently, we need to be prepared to merge options that have no type information.
2023-07-11lib.mergeModules: Add context to error messageRobert Hensing1-1/+4
2023-07-11lib/modules.nix: FormatRobert Hensing1-19/+28
2023-07-11lib/modules.nix: Inline single-use `subtree` bindingsRobert Hensing1-4/+4
2023-07-11lib/modules.nix: Make entire definition list strict in config checkRobert Hensing1-24/+21
This is a non-trivial refactor that slightly changes the semantics of the internal definition lists. Whereas previously only individual list items would trigger the exception, now the error is promoted to the whole list. This is mostly ok, because we compute the value, it is wrong to ignore a definition. However, we don't always compute the value. For instance `readOnly` only needs to count definitions. That won't be possible anymore when the error is raised for one of the items. As a consequence, an error will be raised for the errant definition instead of the number of definitions.
2023-07-11lib/modules.nix: Rename defnsByName -> pushedDownDefinitionsByNameRobert Hensing1-2/+2
2023-07-11lib/modules.nix: Rename defnsByName' -> rawDefinitionsByNameRobert Hensing1-3/+3
2023-07-11lib/modules.nix: Apply argument `module` of old fRobert Hensing1-9/+9
2023-07-11lib/modules.nix: Apply argument `modules` of old old old byNameRobert Hensing1-6/+6
2023-07-11lib/modules.nix: Apply argument `f` of old old byNameRobert Hensing1-15/+21
2023-07-11lib/modules.nix: Apply argument `attr` of old byNameRobert Hensing1-31/+15
2023-07-11lib/modules.nix: Inline byNameRobert Hensing1-27/+43
byName is not an abstraction. This is the first commit in a series that refactors it away.
2023-06-23Merge pull request #238136 from ↵Robert Hensing1-0/+35
hercules-ci/nixos-nixpkgs-dont-check-when-_module.args.pkgs-is-set `nixos/nixpkgs`: Don't check when `_module.args.pkgs` is set
2023-06-23lib/modules.nix: Clean up mergeAttrDefinitionsWithPrio implRobert Hensing1-9/+2
2023-06-23lib/modules: remove unused let bindingsfigsoda1-1/+0
2023-06-16lib.modules: Add mergeAttrDefinitionsWithPrioRobert Hensing1-0/+42
This will let us make assertions involving _module.args.pkgs, which is not an option but a value attribute, and therefore doesn't have its own highestPrio to inspect. The new function gives us that info.
2023-06-16lib: unhide _module.argspennae1-5/+0
this was a temporary fix that should hopefully no longer be necessary.
2023-06-13lib: turn *MD functions into aliasespennae1-12/+7
with docbook gone and MD the default these aren't needed any more. we can't remove them yet because there's thousands of uses, but maybe some day we can.
2023-05-06lib.modules: configurationClass -> classRobert Hensing1-1/+1
This simplifies the documentation. `configuration` is implied by `_type`.
2023-05-06lib.modules: in evalModules return move _module.class -> configurationClassRobert Hensing1-11/+1
2023-05-06lib.modules: Change class declaration in module to _classRobert Hensing1-6/+6
2023-05-06lib/modules: Move class out of specialArgsRobert Hensing1-7/+19
2023-05-06lib/modules.nix: Deduplicate documentationRobert Hensing1-29/+2
`file://./..` looks redundant, but makes the url clickable in vscode.
2023-05-06lib/modules: Only interpret class declaration in non-shorthand modeRobert Hensing1-1/+1
This is to avoid stealing keys from submodules. `class` might be common enough that reinterpreting existing `class` attributes in configurations as a declaration leads to fairly widespread problems.
2023-05-06lib/modules.nix: Refactor: extract applyModuleArgsRobert Hensing1-5/+6
2023-05-06lib/modules.nix: Refactor: evaluate applyModuleArgsIfFunction in attrs caseRobert Hensing1-1/+1
2023-05-06lib/modules.nix: Restore old collectModules interfaceRobert Hensing1-1/+1
2023-05-06lib/modules: Explain that a configuration can't be loaded as a moduleRobert Hensing1-1/+6
2023-05-06lib/modules: Improve error when a configuration is importedRobert Hensing1-0/+1
This is appears to be a fairly common mistake for beginners who want to build larger things from the system configurations, such as NixOps networks, etc. Further explanation seems appropriate.
2023-05-06lib/modules: Check against importing things with a _typeRobert Hensing1-1/+8
2023-05-06lib/modules: Add class concept to check importsRobert Hensing1-4/+22
This improves the error message when an incompatible module is imported.
2023-05-06lib/modules.nix: Make some functions privateRobert Hensing1-11/+22
The supposedly public nature of these functions has been holding back module system maintenance, while usages of these functions are expected to be rare. If used anywhere, presumably they're emulating module system behavior because some use case isn't supported properly. We should try to support such a use case directly, if it even exists.
2023-05-06lib/modules.nix: Use explicit exportsRobert Hensing1-4/+52
2023-03-22lib/modules: better error for invalid option declarationsNaïm Favier1-4/+8
Make `byName` aware of whether it's processing options or config to give slightly more accurate error messages.
2023-03-01lib/modules: Allow an "anonymous" module with key in disabledModulesRobert Hensing1-5/+29
This makes the following work disabledModules = [ foo.nixosModules.bar ]; even if `bar` is not a path, but rather a module such as { key = "/path/to/foo#nixosModules.bar"; config = ...; } By supporting this, the user will often be able to use the same syntax for both importing and disabling a module. This is becoming more relevant because flakes promote the use of attributes to reference modules. Not all of these modules in flake attributes will be identifiable, but with the help of a framework such as flake-parts, these attributes can be guaranteed to be identifiable (by outPath + attribute path).
2023-01-08lib/modules: make `mkAliasOptionModule` emit DocBookNaïm Favier1-3/+5
Follow-up to https://github.com/NixOS/nixpkgs/pull/208407 Removing `mdDoc` isn't enough, we need to emit actual DocBook.
2023-01-05lib/modules: hide _module.args docspennae1-0/+5
unfortunately we can't unconditionally make this text markdown without impacting downstream users of docs generation (as noted in #175586). hide it entirely until the transition is complete.
2023-01-05modules: add mkAliasOptionModuleMDpennae1-2/+11
mkAliasOptionModule should not default to mdDoc descriptions because that can break out-of-tree users of documentation infrastructure. add an explicitly-MD variant for now, to be removed some time after the MD transition is complete.
2022-12-17lib: fix typosfigsoda1-1/+1
2022-12-02Merge pull request #204103 from ncfavier/doc-mkOrderValentin Gagarin1-9/+10
nixos/doc: document `mkOrder` and friends
2022-12-02nixos/doc: document `mkOrder` and friendsNaïm Favier1-9/+10
Add a section on ordering option definitions. Also mention `mkDefault` in the section on `mkOverride`. Clarify the code a bit by renaming `defaultPriority` to `defaultOverridePriority` and introducing `defaultOrderPriority`.
2022-12-02lib/modules: Add context to the "option does not exist" errorRobert Hensing1-1/+12
Add trace items that provide context for a failed definition that can not be caught within the Nix language. This also adds a test for the `tryEval` behavior of `showDefs`.
2022-11-03lib.modules.doRename: Don't define warning, even as undefined, if not warning.Shea Levy1-2/+2
This fixes mkAliasOptionModule in systems with no warning option.
2022-10-01Merge pull request #193132 from figsoda/clean-upfigsoda1-9/+1
treewide: clean up
2022-09-28Merge pull request #191540 from hercules-ci/nixosTest-modularRobert Hensing1-1/+2
nixosTest: make modular