Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nix-community/nixpkgs-fmt

Nix code formatter for nixpkgs [maintainer=@zimbatm]
https://github.com/nix-community/nixpkgs-fmt

cli formatter nix nixpkgs pre-commit-hook rust-crate

Last synced: about 1 month ago
JSON representation

Nix code formatter for nixpkgs [maintainer=@zimbatm]

Host: GitHub
URL: https://github.com/nix-community/nixpkgs-fmt
Owner: nix-community
License: apache-2.0
Archived: true
Created: 2019-05-02T19:38:08.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-07-24T11:56:52.000Z (3 months ago)
Last Synced: 2024-09-24T01:02:10.933Z (about 1 month ago)
Topics: cli, formatter, nix, nixpkgs, pre-commit-hook, rust-crate
Language: Rust
Homepage: https://nix-community.github.io/nixpkgs-fmt/
Size: 3.83 MB
Stars: 581
Watchers: 11
Forks: 32
Open Issues: 35
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

awesome-nix - nixpkgs-fmt - Nix code formatter for nixpkgs. (Command-Line Tools / Discovery)

README

# nixpkgs-fmt - Nix code formatter for nixpkgs

[![CI](https://github.com/nix-community/nixpkgs-fmt/actions/workflows/push.yml/badge.svg?branch=master)](https://github.com/nix-community/nixpkgs-fmt/actions/workflows/push.yml) [![built with nix](https://builtwithnix.org/badge.svg)](https://builtwithnix.org)

**STATUS: archived. Replaced by [nixfmt](https://github.com/NixOS/nixfmt).**

This project's goal was to format the nix code in nixpkgs to increase the
consistency of the code found there. Ideally automatically with pre-commit
hooks and later ofborg enforcing the format.

## Demo

You can try nixpkgs-fmt in your browser. The page also provides a way for you
to submit code samples if you find the output not satisfying:
https://nix-community.github.io/nixpkgs-fmt/

## Design decisions

You might ask yourself; why do we need yet another nix code formatter?

The main goal of nixpkgs-fmt is to provide some overall consistency in the
nix code submitted to [nixpkgs](https://github.com/NixOS/nixpkgs), our main
package repository.

At this point it's important to understand that there are multiple possible
outputs for a code formatter. Those outputs will depend on multiple
conflicting desires and depending on how much weight is being put on each
requirement the output will change.

For nixpkgs-fmt we have a few of these:

1. Minimize merge conflicts. nixpkgs is seen in a lot of pull-requests and we
want to avoid them getting unnecessarily stale.
2. Only expand, don't collapse. It's up to the developer to choose if an
element should be on a single line or multiple lines.
3. Respect the developer's expressivity. Empty lines can be useful as a way to
separate blocks of code.
4. Only change the indent of one (+/-) per line. Not sure why but it seems
like a good thing.

Corollary rules:

* because of (1). The format is quite close to what exists in nixpkgs already.
* because of (1). Don't align values vertically, a single line change can
introduce a very big diff.
* because of (1). Avoid too many rules. More rules means more formatting
changes that create merge conflicts.
* because of (2). Don't enforce line lengths. Line length limits also create
complicated heuristics.

At the time where we started this project none of the other formatters were
weighted that way.

To implement this, we needed a whitespace and comment-preserving parser which
[rnix](https://github.com/nix-community/rnix-parser) provides to us. Then create
an engine that follows the AST and patches the tree with rewrite rules. The nice
thing about this design is that it also works on incomplete or broken nix code.
We are able to format up to the part that is missing/broken, which makes it
great for potential editor integration.

Most of the other formatters out there take a pretty-printing approach where
the AST is parsed, and then a pretty-printer inspects and formats the AST back
to code without taking spaces and newlines into account. The advantage is that
it's initially easier to implement. The output is very strict and the same AST
will always give the same output. One disadvantage is that the pretty-printer
needs to handle all the possible combination of Nix code to make them look
good.

With nixpkgs-fmt the output will depend on how the code was formatted
initially. The developer still has some input on how they want to format their
code. If there is no rule for a complicated case, the code will be left alone.
For nixpkgs this approach will be preferable since it minimizes the diff.

Well done for reading all of this, I hope this clarifies a bit why nixpkgs-fmt
exists and what role it can play.

## Usage

```
nixpkgs-fmt 1.2.0
Format Nix code

USAGE:
nixpkgs-fmt [FLAGS] [OPTIONS] [FILE]...

FLAGS:
--check Only test if the formatter would produce differences
--explain Show which rules are violated
-h, --help Prints help information
--parse Show syntax tree instead of reformatting
-V, --version Prints version information

OPTIONS:
--output-format Set output format of --parse [default: rnix] [possible values: rnix, json]

ARGS:
... File to reformat in place. If no file is passed, read from stdin.
```
### Tree traversal

When `nixpkgs-fmt` is given a folder as a file argument, it will traverse that
using the same [ignore crate](https://crates.io/crates/ignore) as ripgrep,
using 8 parallel threads.

By default it will automatically ignore files reading `.ignore`, `.gitignore`,
and `.git/info/exclude` files in that order. If additional files need to be
ignored, it is also possible to add `--exclude ` to the call.

## Installation

nixpkgs-fmt is available in nixpkgs master. `nix-env -i nixpkgs-fmt`.

It's also possible to install it directly from this repository:

`nix-env -f https://github.com/nix-community/nixpkgs-fmt/archive/master.tar.gz -iA nixpkgs-fmt`

### VSCode extensions

There are a few VSCode extensions that make using `nixpkgs-fmt` convenient.
Check out:

- [B4dM4n.nixpkgs-fmt](https://marketplace.visualstudio.com/items?itemName=B4dM4n.nixpkgs-fmt)
- [jnoortheen.nix-ide](https://marketplace.visualstudio.com/items?itemName=jnoortheen.nix-ide)

### pre-commit hook

This project can also be installed as a [pre-commit](https://pre-commit.com/)
hook.

Add to your project's `.pre-commit-config.yaml`:

```yaml
- repo: https://github.com/nix-community/nixpkgs-fmt
rev: master
hooks:
- id: nixpkgs-fmt
```

Make sure to have rust available in your environment.

Then run `pre-commit install-hooks`

## Development

Install Rust and Cargo or run `nix-shell` to load the project dependencies.

Install [pre-commit](https://pre-commit.com/) and run `pre-commit install` to
setup the git hooks on the repository. This will allow to keep the code nicely
formatted over time.

Then use `cargo run` to build and run the software.

### Running Fuzzer

```
$ cargo install cargo-fuzz
$ mkdir -p ./fuzz/corpus/fmt
$ cp test_data/**.nix ./fuzz/corpus/fmt
$ rustup run nightly -- cargo fuzz run fmt
```

or with nix:

```
$ nix-shell --run "cargo fuzz run fmt"
```

* `fmt` is the name of the target in `./fuzz/Cargo.toml`

Fuzzer will run indefinitely or until it finds a crash.
The crashing input is written to `fuzz/artifacts` directory.
Commit this `crash-` file, and it will be automatically tested by a unit-test.

## Documentation

* [HOWTO write new rules](docs/howto_rules.md)
* [HOWTO WASM](wasm/README.md)
* [How we do releases](docs/releasing.md)

## Related projects

Feel free to submit your project!

### Using nixpkgs-fmt

* [Emacs integration, including minor mode for format-on-save](https://github.com/purcell/emacs-nixpkgs-fmt)
* [rnix-lsp](https://github.com/nix-community/rnix-lsp) - A Lambda Server for Nix

### Formatters

* [alejandra](https://github.com/kamadorueda/alejandra) - Another rnix based formatter, using a rule based engine.
* [canonix](https://github.com/hercules-ci/canonix/) - Nix formatter prototype written in Haskell using the tree-sitter-nix grammar.
* [format-nix](https://github.com/justinwoo/format-nix/) - A nix formatter using tree-sitter-nix.
* [nix-format](https://github.com/taktoa/nix-format) - Emacs-based Nix formatter.
* [nix-lsp](https://gitlab.com/jD91mZM2/nix-lsp) - Nix language server using rnix.
* [nixfmt](https://github.com/serokell/nixfmt) - A nix formatter written in Haskell.

### Linters

* [nix-linter](https://github.com/Synthetica9/nix-linter)

### Parsers

* [hnix](https://github.com/haskell-nix/hnix) - Haskell implementation of Nix including a parser. The parser is not comment-preserving.
* [rnix](https://github.com/nix-community/rnix-parser) - Rust Nix parser based on [rowan](https://github.com/rust-analyzer/rowan)
* [tree-sitter-nix](https://github.com/cstrahan/tree-sitter-nix) - Tree Sitter is a forgiving parser used by Atom for on-the-fly syntax highlighting and others. This is a implementation for Nix.

## Discussions

* [nixpkgs style guide](https://nixos.org/nixpkgs/manual/#sec-syntax)
* [On Nix expression formatting](https://discourse.nixos.org/t/on-nix-expression-formatting/1521/14)
* [[Job] Implement a `nix-fmt` formatter](https://discourse.nixos.org/t/job-implement-a-nix-fmt-formatter/2819/12)

## Sponsors

This work has been sponsored by [NumTide](https://numtide.com).