Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aldoborrero/lib-extras
A collection of extra functions to `nixpkgs.lib`
https://github.com/aldoborrero/lib-extras
flakes nix nixos nixpkgs
Last synced: 24 days ago
JSON representation
A collection of extra functions to `nixpkgs.lib`
- Host: GitHub
- URL: https://github.com/aldoborrero/lib-extras
- Owner: aldoborrero
- License: mit
- Created: 2023-10-20T16:52:29.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-14T15:11:27.000Z (about 1 year ago)
- Last Synced: 2024-11-07T07:51:48.260Z (2 months ago)
- Topics: flakes, nix, nixos, nixpkgs
- Language: Nix
- Homepage:
- Size: 12.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# lib-extras
> A collection of extra (and maybe opinioated) functions to `nixpkgs.lib`!
This project aims to enhance the default `nixpkgs.lib` with additional extra functions.
## Functions
Below you can find the supported list of extra functions categorized by utility. The list for now is very small,
but more functions will be created for sure:
### Filesystem:
- **collectNixFiles**: Collects `.nix` files recursively from a directory and returns them as an attribute set.
### Flake:
- **mkApp**: Produces an "app" type for Nix flakes given a derivation and optional parameters.
- **filterPkgs**: Filters packages based on a specified attribute path and criteria.
### Nix:
- **mkNixpkgs**: Imports and configures a Nixpkgs environment with custom settings, overlays, and system type.
## Usage
To use `lib-extras` in your project:
1. Add this repository as an input to your flake.
```nix
lib-extras = {
url = "github:aldoborrero/lib-extras";
inputs.nixpkgs.follows = "nixpkgs";
};
```
1. Use the extended library in your Nix expressions:
```nix
lib = nixpkgs.lib.extend (final: _: inputs.lib-extras.lib final);
```
## Development
To make the most of this repository, you should have the following installed:
- [Nix](https://nixos.org/)
- [Direnv](https://direnv.net/)
After cloning this repository and entering inside, run `direnv allow` when prompted, and you will be met with the menu prompt.
## Contributing
Contributions to `lib-extras` are welcome! Whether you're fixing bugs, improving documentation, or introducing a new feature, your efforts and contributions will be appreciated.
1. Fork this repository.
1. Create a new branch for your feature or fix.
1. Commit your changes with meaningful commit messages.
1. Open a pull request and provide a description of your changes.
## License
This project is licensed under the MIT license. For more details, see the `LICENSE` file in the repository.