Japan Rabbit Docs

# Linting & formatting

This project uses ESLint, Stylelint, Markdownlint, and Prettier to catch errors and avoid bikeshedding by enforcing a common code style.

# Languages

  • TypeScript is linted by ESLint and formatted by Prettier
  • HTML (in templates and JSX) is linted by ESLint
  • CSS is linted by Stylelint and formatted by Prettier
  • Markdown is linted by Markdownlint and formatted by Prettier
  • JSON is formatted by Prettier
  • Images are minified by imagemin-lint-staged (only on pre-commit)

# Scripts

There are a few different contexts in which the linters run.

# Terminal

# Lint all files, fixing many violations automatically
yarn lint

See package.json to update.

# Pre-commit

Staged files are automatically linted and tested before each commit. See lint-staged.config.js to update.

# Editor

In supported editors, all files will be linted and formatted on-save. See editors.md for details.

# Configuration

This boilerplate ships with opinionated defaults, but you can edit each tools configuration in the following config files:

Last updated: 6/26/2020, 9:59:26 AM

← Editor integration →