Ardent idleberg

formatter nsis

Use this command to install Ardent with WinGet:

winget install --id=idleberg.ardent -e

An opinionated code formatter for NSIS scripts

ardent

> An opinionated code formatter for NSIS scripts.

Description

Dent formats NSIS scripts, conforming the dent-spec.

The specification defines the style — casing, indentation, blank lines, quoting and wrapping — as prose, data tables and byte-exact conformance cases. Ardent generates its lookup tables from those tables (mise run spec:codegen) and runs those cases as tests, so it and dent, the TypeScript implementation, cannot drift apart. Where Ardent and a case disagree, Ardent is wrong.

Ardent is written in Rust, which makes distribution easier for people outside the NodeJS ecosystem.

Installation

> [!TIP] > This document is primarily target at developers. If you simply want to use Ardent, please refer to the getting started guide instead.

For development purposes, use Cargo for installation.

cargo install ardent

Alternatively, you can build it from source:

# Clone the repository
git clone https://github.com/idleberg/ardent.git
cd ardent

# Setup tooling
mise install

# Build
cargo build --release

The binary is at target/release/ardent.

CLI Usage

ardent [OPTIONS] [COMMAND]

Commands:
  format  Format NSIS scripts
  check   Check if NSIS scripts are formatted correctly

Options:
  -D, --debug    Print debug messages
  -h, --help     Print help
  -V, --version  Print version

Format

Formats one or more .nsi / .nsh files.

# Print formatted output to stdout
ardent format installer.nsi

# Edit files in-place
ardent format --write src/**/*.nsi

See ardent format --help for available options.

Check

Checks whether files are already formatted.

# Check only (reports drift)
ardent check src/**/*.nsi

# Check and auto-fix (still exits 1 if drift was found)
ardent check --write src/**/*.nsi

# Print a unified diff of what would change
ardent check --diff src/**/*.nsi

See ardent check --help for available options.

Library Usage

Formatting

use ardent::{FormatterOptions, EndOfLine, Formatter};

let formatter = Formatter::new(FormatterOptions {
    end_of_line: Some(EndOfLine::Lf),
    use_tabs: true,
    indent_size: 2,
    trim_empty_lines: true,
    print_width: 120,
}).expect("valid options");

let input = r#"section "My Section"
detailprint "Hello"
sectionend
"#;

let output = formatter.format(input).expect("valid NSIS");
assert_eq!(output, "Section \"My Section\"\n\tDetailPrint \"Hello\"\nSectionEnd\n");

Checking

Returns None if the input is already formatted, or Some(formatted) if it needs changes.

use ardent::{FormatterOptions, Formatter};

let formatter = Formatter::new(FormatterOptions::default()).unwrap();

match formatter.check(input).unwrap() {
    None =&gt; println!("Already formatted"),
    Some(formatted) =&gt; println!("Needs formatting"),
}

Options

Field	Type	Default	Description
`end_of_line`	`Option`	`None` (auto-detect)	Force CRLF or LF line endings
`indent_size`	`usize`	`2`	Spaces per indent level (ignored when using tabs)
`print_width`	`usize`	`120`	Maximum line width before wrapping with `\` continuations (0 disables)
`single_quote`	`bool`	`false`	Prefer single quotes instead of double quotes
`trim_empty_lines`	`bool`	`true`	Collapse consecutive blank lines and strip leading/trailing blanks
`use_tabs`	`bool`	`true`	Indent with tabs instead of spaces
`comment-style`.	`Option`	`None`	Unify the marker used for single-line comments

> [!TIP] > While many follow their personal preferences in the tabs vs spaces discussion, accessibility is probably the strongest argument to prefer tabs. See this discussion for more context.

Benchmark

Speed is a neglectible factor for formatting NSIS files, which are usually relatively short. However, if this is an important factor for you, take note of these benchmarks run on an Apple M2 Pro with 32GB of RAM.

Benchmark 1: ardent check Examples/bigtest.nsi
  Time (mean ± σ):       3.0 ms ±   1.4 ms    [User: 1.5 ms, System: 0.8 ms]
  Range (min … max):     2.2 ms …  22.3 ms    402 runs

Benchmark 2: dent check Examples/bigtest.nsi
  Time (mean ± σ):      80.3 ms ±   6.4 ms    [User: 71.9 ms, System: 12.9 ms]
  Range (min … max):    76.3 ms … 116.3 ms    36 runs

Summary
  ardent check Examples/bigtest.nsi ran
   26.65 ± 12.73 times faster than dent check Examples/bigtest.nsi

License

This work is licensed under The MIT License.

ardent

> An opinionated code formatter for NSIS scripts.

Description

Dent formats NSIS scripts, conforming the dent-spec.

Ardent is written in Rust, which makes distribution easier for people outside the NodeJS ecosystem.

Installation

> [!TIP] > This document is primarily target at developers. If you simply want to use Ardent, please refer to the getting started guide instead.

For development purposes, use Cargo for installation.

cargo install ardent

Alternatively, you can build it from source:

# Clone the repository
git clone https://github.com/idleberg/ardent.git
cd ardent

# Setup tooling
mise install

# Build
cargo build --release

The binary is at target/release/ardent.

CLI Usage

ardent [OPTIONS] [COMMAND]

Commands:
  format  Format NSIS scripts
  check   Check if NSIS scripts are formatted correctly

Options:
  -D, --debug    Print debug messages
  -h, --help     Print help
  -V, --version  Print version

Format

Formats one or more .nsi / .nsh files.

# Print formatted output to stdout
ardent format installer.nsi

# Edit files in-place
ardent format --write src/**/*.nsi

See ardent format --help for available options.

Check

Checks whether files are already formatted.

# Check only (reports drift)
ardent check src/**/*.nsi

# Check and auto-fix (still exits 1 if drift was found)
ardent check --write src/**/*.nsi

# Print a unified diff of what would change
ardent check --diff src/**/*.nsi

See ardent check --help for available options.

Library Usage

Formatting

use ardent::{FormatterOptions, EndOfLine, Formatter};

let formatter = Formatter::new(FormatterOptions {
    end_of_line: Some(EndOfLine::Lf),
    use_tabs: true,
    indent_size: 2,
    trim_empty_lines: true,
    print_width: 120,
}).expect("valid options");

let input = r#"section "My Section"
detailprint "Hello"
sectionend
"#;

let output = formatter.format(input).expect("valid NSIS");
assert_eq!(output, "Section \"My Section\"\n\tDetailPrint \"Hello\"\nSectionEnd\n");

Checking

Returns None if the input is already formatted, or Some(formatted) if it needs changes.

use ardent::{FormatterOptions, Formatter};

let formatter = Formatter::new(FormatterOptions::default()).unwrap();

match formatter.check(input).unwrap() {
    None =&gt; println!("Already formatted"),
    Some(formatted) =&gt; println!("Needs formatting"),
}

Options

Field	Type	Default	Description
`end_of_line`	`Option`	`None` (auto-detect)	Force CRLF or LF line endings
`indent_size`	`usize`	`2`	Spaces per indent level (ignored when using tabs)
`print_width`	`usize`	`120`	Maximum line width before wrapping with `\` continuations (0 disables)
`single_quote`	`bool`	`false`	Prefer single quotes instead of double quotes
`trim_empty_lines`	`bool`	`true`	Collapse consecutive blank lines and strip leading/trailing blanks
`use_tabs`	`bool`	`true`	Indent with tabs instead of spaces
`comment-style`.	`Option`	`None`	Unify the marker used for single-line comments

> [!TIP] > While many follow their personal preferences in the tabs vs spaces discussion, accessibility is probably the strongest argument to prefer tabs. See this discussion for more context.

Benchmark

Benchmark 1: ardent check Examples/bigtest.nsi
  Time (mean ± σ):       3.0 ms ±   1.4 ms    [User: 1.5 ms, System: 0.8 ms]
  Range (min … max):     2.2 ms …  22.3 ms    402 runs

Benchmark 2: dent check Examples/bigtest.nsi
  Time (mean ± σ):      80.3 ms ±   6.4 ms    [User: 71.9 ms, System: 12.9 ms]
  Range (min … max):    76.3 ms … 116.3 ms    36 runs

Summary
  ardent check Examples/bigtest.nsi ran
   26.65 ± 12.73 times faster than dent check Examples/bigtest.nsi

License

This work is licensed under The MIT License.

Ardent idleberg

README

ardent

Description

Installation

CLI Usage

Format

Check

Library Usage

Formatting

Checking

Options

Benchmark

License

Ardent idleberg

README

ardent

Description

Installation

CLI Usage

Format

Check

Library Usage

Formatting

Checking

Options

Benchmark

License