https://github.com/suzuki-shunsuke/nllint
Linter to check newlines at the end of files
https://github.com/suzuki-shunsuke/nllint
Last synced: about 2 months ago
JSON representation
Linter to check newlines at the end of files
- Host: GitHub
- URL: https://github.com/suzuki-shunsuke/nllint
- Owner: suzuki-shunsuke
- License: mit
- Created: 2023-11-20T00:08:13.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-29T12:50:32.000Z (6 months ago)
- Last Synced: 2024-10-29T15:17:40.716Z (6 months ago)
- Language: Go
- Size: 523 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# nllint
Linter to check newlines at the end of files
--
```console
$ echo -n {} > foo.json
$ echo -n "{}\n\n" > bar.json
$ nllint foo.json bar.json
ERRO[0000] a file is invalid error="a newline at the end of file is missing" file_path=foo.json nllint_version= program=nllint
# --trim-space (-s): Check leading and trailing white spaces in files
$ nllint -s foo.json bar.json
ERRO[0000] a file is invalid error="a newline at the end of file is missing" file_path=foo.json nllint_version= program=nllint
ERRO[0000] a file is invalid error="leading and trailing white spaces in files should be trimmed" file_path=bar.json nllint_version= program=nllint
# -fix (-f): Fix files and outputs fixed file paths to the stdout
$ nllint -s -fix foo.json bar.json
WARN[0000] a newline at the end of file is missing file_path=foo.json nllint_version= program=nllint
foo.json
WARN[0000] leading and trailing white spaces in files should be trimmed file_path=bar.json nllint_version= program=nllint
bar.json
```
## Motivation
Each line should have a newline of the end of line because [that’s how the POSIX standard defines a line](https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_206):
Please see https://stackoverflow.com/a/729795/6364492
## Install
nllint is a single binary written in [Go](https://go.dev/). So you only need to install an execurable file into `$PATH`.
1. [Homebrew](https://brew.sh/)
```sh
brew install suzuki-shunsuke/nllint/nllint
```
2. [Scoop](https://scoop.sh/)
```sh
scoop bucket add suzuki-shunsuke https://github.com/suzuki-shunsuke/scoop-bucket
scoop install nllint
```
3. [aqua](https://aquaproj.github.io/)
```sh
aqua g -i suzuki-shunsuke/nllint
```
4. Download a prebuilt binary from [GitHub Releases](https://github.com/suzuki-shunsuke/nllint/releases) and install it into `$PATH`
## Usage
```sh
$ nllint help
nllint - Check newlines at the end of files
https://github.com/suzuki-shunsuke/nllint
Usage:
nllint [-fix (-f)] [-trim-space (-s)] [-ignore-notfound (-i)] [...]
Options:
-help, -h Show help
-version, -v Show version
-fix, -f Fix files
-trim-space, -s Disallow leading and trailing white spaces in files
-ignore-notfound, -i Ignore not found files
```
## :bulb: Auto Fix by CI
--
It's useful to format code automatically with nllint and push a commit to the remote branch in CI.
1. List changed files
1. Run `nllint -f [-s] [...]`
1. Push a commit to the remote branch
Please refer to this repository's workflows as the example.
- [test.yaml](.github/workflows/test.yaml)
- [wc-test.yaml](.github/workflows/wc-test.yaml)
`nllint` is enough fast, so we think it's also okay to lint all files instead of only changed files.
```sh
git ls-files | xargs nllint -f -s
```
## LICENSE
[MIT](LICENSE)