carbon-lang/docs/project/contribution_tools.md

Contribution tools

The Carbon language project has a number of tools used to assist in preparing contributions.

Table of contents

• pre-commit
• markdown-toc
• Prettier
  • vim-prettier

pre-commit

We use pre-commit to run various checks. This will automatically run important checks, including formatting.

To set up pre-commit:

• Follow the installation instructions.
• Enable per-repo: pre-commit install

When modifying or adding pre-commit hooks, please run pre-commit run --all-files to see what changes.

markdown-toc

pre-commit enabled: markdown-toc will be run by pre-commit, if installed.

We use markdown-toc to provide GitHub-compatible tables of contents for some documents.

If run manually, specify --bullets=- to use Prettier-compatible bullets, or always run Prettier after markdown-toc.

Prettier

pre-commit enabled: Prettier will be run by pre-commit, if installed.

We use Prettier for formatting. There is an rc file for configuration.

vim-prettier

If you use vim-prettier, it may help to add to your .virmc:

let g:prettier#config#print_width = '80'
let g:prettier#config#tab_width = '2'
let g:prettier#config#use_tabs = 'false'
let g:prettier#config#prose_wrap = 'always'