# Tools

We use Prettier and ESLint to handle the TS/JS code and rustfmt for Rust. With the exception of a few files and directories, all of the code within the Firefly repository is run through a linting process to ensure cleanliness and consistency in terms of format, style, syntax, and more. This process happens both locally in a pre-commit Git hook (via Husky) as well as in a continuous integration workflow (see ci.lint.yml).

All of the formatting and linting commands can be run from the root directory.

With formatting there are two options to either overwrite files with fixes or just simply check them for correctness:

# 1 - fix and overwrite files
yarn format

# 2 - check files 
yarn format-check

For linting there are three options to either check the files, check the files in debug mode, or fix and overwrite the files:

# 1 - check files
yarn lint

# 2 - check files in debug mode
yarn lint-debug

# 3 - fix and overwrite files
yarn lint-fix

ℹ️ Svelte component files (*.svelte) are checked in addition to regular *.ts source code files.

Retype makes it incredibly easy to manage documentation. Simply use the following command from the root directory:

# generates locally hosted instance of the handbook
yarn docs:start