# @nsis/dent-cli

> An opinionated code formatter for NSIS scripts

![License](https://img.shields.io/npm/l/%40nsis%2Fdent-cli?style=for-the-badge)
[![Version](https://img.shields.io/npm/v/@nsis/dent-cli?style=for-the-badge)](https://www.npmjs.org/package/@nsis/dent-cli)
[![Build](https://img.shields.io/github/actions/workflow/status/idleberg/nsis-javascript-tools/ci.yml?style=for-the-badge)](https://github.com/idleberg/nsis-javascript-tools/actions)

## Installation

### Node.js

For single-use, use `npx` to download and run the CLI:

```sh
$ npx -y @nsis/dent-cli --help
```

Or, if you prefer to install the CLI:

```sh
$ npm install --global @nsis/dent-cli
$ dent --help
```

### Homebrew

```sh
brew install idleberg/asahi/dent
```

### Native Builds

In the past, you could download precompiled binaries from the release page. This is no longer the case. Instead, feel free to download [ardent](https://github.com/idleberg/ardent), an API-compatible implementation written in Rust.

## Usage

The CLI exposes two sub-commands:

- `dent format` — formats NSIS scripts
- `dent check` — checks if a script needs formatting

```
Usage: dent [options] [command]

Opinionated formatter for NSIS scripts

Options:
  -V, --version               output the version number
  -D, --debug                 prints additional debug messages (default: false)
  -h, --help                  display help for command

Commands:
  format [options] [file...]  format NSIS scripts
  check [options] [file...]   check whether NSIS scripts are formatted (exits non-zero on drift)
```

Run `dent --help` to list sub-commands, or `dent <command> --help` for command-specific options.

## Related

- [dent](https://www.npmjs.com/package/@nsis/dent)

## License

This work is licensed under [The MIT License](LICENSE).