Skip to content

Commit

Permalink
updates based on AucaCoyan's PR
Browse files Browse the repository at this point in the history
  • Loading branch information
fdncred committed Mar 21, 2023
1 parent c634356 commit 17d1fa0
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions docs/specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,24 @@

This specification serves as a starting point to document how `nufmt` should work when formatting nushell scripts. It's meant to be very basic at this point, gradually covering more of the language features.


## Supported Features

### Indentation
### Indentation size

There should be an `--indent` parameter to allow one to specify the number of spaces to use for indentation.

### Indentation

There should be a CRLF and indentation after open braces ()`{`). (TBD - Does this apply to other symbols like `[`, `(`, `|`, etc?)

### Limit the characters per line

There should be a `--limit` parameter to limit to the number of characters per line.

### Number of empty lines before/after custom command

There should be a `--lines-before` and `--lines-after` parameter to set the number of empty lines before and after a custom command.

## Supported Commands

This is the list of the supported commands and their idiomatic formatting. Indentation will be covered by the `--indent` flag but for these examples, 2 spaces will be used.
Expand Down

0 comments on commit 17d1fa0

Please sign in to comment.