Skip to content

Commit

Permalink
docs: add info about prettier and editorconfig
Browse files Browse the repository at this point in the history
  • Loading branch information
mandrasch committed Dec 5, 2024
1 parent 8172670 commit 86553f6
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,23 @@ Textlint’s [default terminology](https://github.com/sapegin/textlint-rule-term

Run `npm run textlint` to check everything, and you can apply “fixable” changes using `npm run textlint:fix`. Be careful automating fixes to be sure they don’t have any unintended side effects!

### Prettier and EditorConfig

Prettier is used for auto-formatting files, see `.prettierrc`. EditorConfig is used for basic IDE settings, see `.editorconfig`. The EditorConfig configuration is [automatically parsed by Prettier](https://prettier.io/docs/en/configuration.html#editorconfig).

If you work with Visual Studio Code, please install these three extensions:

- https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode
- https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig
- https://marketplace.visualstudio.com/items?itemName=astro-build.astro-vscode

Auto-format on save is activated via `.vscode/settings.json` for Visual Studio Code.

General commands:

- Use `npx prettier --check .` to verify everything is properly formatted
- Use `npx prettier --write .` to auto-format all files

### Sponsor Management

The `src/featured-sponsors.json` file is used for manually curating prominent sponsors.
Expand Down

0 comments on commit 86553f6

Please sign in to comment.