Skip to main content

code

Usage: chr code [OPTIONS] COMMAND [ARGS]...

Code quality management (formatting, linting)

╭─ Options ───────────────────────────────────────────────────────────────────╮
│ -h, --help Show this message and exit │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────╮
│ lint Analyze Rell code to find potential issue and coding style │
│ violations. Configurable using .rell_lint file │
│ format Automatically format Rell code. Configurable using .rell_format │
│ file │
╰─────────────────────────────────────────────────────────────────────────────╯

You can use the code command (chr code) for code quality management (formatting and linting).

code lint

Usage: chr code lint [<options>] [<files>]...

Analyze Rell code to find potential issue and coding style violations.
Configurable using .rell_lint file

Configuration Properties:
-s, --settings=<settings> Alternate path for project settings file

Options:
--source-dir=<path> source directory
-fo, --formatter-options=<path>
Formatter options file (default '.rell_format')
-lo, --linter-options=<path> Linter options file (default '.rell_lint')
--fix Fix all auto-fixable issues
-h, --help Show this message and exit

Arguments:
<files> Files or dirs to show/fix linter issues from. (.rell: All files
ending with rell extension) (main/: Matches all files in main
directory on explicit path) (**/main/*: Matches all files in main
directory independent on parent paths)

The lint command chr code lint allows you to analyze Rell code to find potential issue and coding style.

code format

Usage: chr code format [<options>]

Automatically format Rell code. Configurable using .rell_format file

Configuration Properties:
-s, --settings=<settings> Alternate path for project settings file

Options:
--source-dir=<path> source directory
--file=<path> single Rell file
-fo, --formatter-options=<path>
Formatter options file (default '.rell_format')
-h, --help Show this message and exit

The format command chr code format allows you to automatically format Rell code. It can be configured by using .rell_format.