Compare commits
2 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3a5cdb5900 | ||
|
|
d8f92486c3 |
72
README.md
Normal file
72
README.md
Normal file
@@ -0,0 +1,72 @@
|
|||||||
|
# repo-lib
|
||||||
|
|
||||||
|
Simple Nix flake library for:
|
||||||
|
|
||||||
|
- a shared development shell (`mkDevShell`)
|
||||||
|
- an optional release command (`mkRelease`)
|
||||||
|
- a starter template (`template/`)
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
- [Nix](https://nixos.org/download/) with flakes enabled
|
||||||
|
- [`direnv`](https://direnv.net/) (recommended)
|
||||||
|
|
||||||
|
## Use the template (new repo)
|
||||||
|
|
||||||
|
From your new project folder:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
nix flake new myapp -t git+https://git.dgren.dev/eric/nix-flake-lib.git#default
|
||||||
|
```
|
||||||
|
|
||||||
|
## Use the library (existing repo)
|
||||||
|
|
||||||
|
Add this flake input:
|
||||||
|
|
||||||
|
```nix
|
||||||
|
inputs.devshell-lib.url = "git+https://git.dgren.dev/eric/nix-flake-lib?ref=v0.0.5";
|
||||||
|
inputs.devshell-lib.inputs.nixpkgs.follows = "nixpkgs";
|
||||||
|
```
|
||||||
|
|
||||||
|
Create your shell from `mkDevShell`:
|
||||||
|
|
||||||
|
```nix
|
||||||
|
env = devshell-lib.lib.mkDevShell {
|
||||||
|
inherit system;
|
||||||
|
extraPackages = [ ];
|
||||||
|
tools = [ ];
|
||||||
|
additionalHooks = { };
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
Expose it in `devShells` as `default` and run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
nix develop
|
||||||
|
```
|
||||||
|
|
||||||
|
## Common commands
|
||||||
|
|
||||||
|
```bash
|
||||||
|
nix fmt # format files
|
||||||
|
```
|
||||||
|
|
||||||
|
## Optional: release command
|
||||||
|
|
||||||
|
If your flake defines:
|
||||||
|
|
||||||
|
```nix
|
||||||
|
packages.${system}.release = devshell-lib.lib.mkRelease { inherit system; };
|
||||||
|
```
|
||||||
|
|
||||||
|
Run releases with:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
release
|
||||||
|
release patch
|
||||||
|
release minor beta
|
||||||
|
release stable
|
||||||
|
release set 1.2.3
|
||||||
|
```
|
||||||
|
|
||||||
|
The release script uses `./VERSION` as the source of truth and creates tags like `v1.2.3`.
|
||||||
10
template/.vscode/settings.json
vendored
Normal file
10
template/.vscode/settings.json
vendored
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
{
|
||||||
|
"files.exclude": {
|
||||||
|
"**/.git": true,
|
||||||
|
"**/.svn": true,
|
||||||
|
"**/.hg": true,
|
||||||
|
"**/.DS_Store": true,
|
||||||
|
"**/Thumbs.db": true,
|
||||||
|
"VERSION": true
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -4,7 +4,7 @@
|
|||||||
|
|
||||||
inputs = {
|
inputs = {
|
||||||
nixpkgs.url = "github:nixos/nixpkgs?ref=nixos-unstable";
|
nixpkgs.url = "github:nixos/nixpkgs?ref=nixos-unstable";
|
||||||
devshell-lib.url = "git+https://git.dgren.dev/eric/nix-flake-lib?ref=v0.0.5";
|
devshell-lib.url = "git+https://git.dgren.dev/eric/nix-flake-lib?ref=v1.0.0";
|
||||||
devshell-lib.inputs.nixpkgs.follows = "nixpkgs";
|
devshell-lib.inputs.nixpkgs.follows = "nixpkgs";
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user