mirror of
https://github.com/facebook/docusaurus.git
synced 2025-04-30 10:48:05 +02:00
74 lines
1.9 KiB
Markdown
74 lines
1.9 KiB
Markdown
---
|
||
sidebar_position: 0
|
||
id: eslint-plugin
|
||
title: '📦 eslint-plugin'
|
||
slug: '/api/misc/@docusaurus/eslint-plugin'
|
||
---
|
||
|
||
[ESLint](https://eslint.org/) is a tool that statically analyzes your code and reports problems or suggests best practices through editor hints and command line. Docusaurus provides an ESLint plugin to enforce best Docusaurus practices.
|
||
|
||
## Installation
|
||
|
||
```bash npm2yarn
|
||
npm install --save-dev @docusaurus/eslint-plugin
|
||
```
|
||
|
||
## Usage
|
||
|
||
Add `@docusaurus` to the plugins section of your `.eslintrc` configuration file:
|
||
|
||
```json title=".eslintrc"
|
||
{
|
||
"plugins": ["@docusaurus"]
|
||
}
|
||
```
|
||
|
||
Then, you can extend one of the configs (e.g. the `recommended` config):
|
||
|
||
```json title=".eslintrc"
|
||
{
|
||
"extends": ["plugin:@docusaurus/recommended"]
|
||
}
|
||
```
|
||
|
||
Each config contains a set of rules. For more fine-grained control, you can also configure the rules you want to use directly:
|
||
|
||
```json title=".eslintrc"
|
||
{
|
||
"rules": {
|
||
"@docusaurus/string-literal-i18n-messages": "error",
|
||
"@docusaurus/no-untranslated-text": "warn"
|
||
}
|
||
}
|
||
```
|
||
|
||
## Supported Configs
|
||
|
||
- Recommended: recommended rule set for most Docusaurus sites that should be extended from.
|
||
- All: **all** rules enabled. This will change between minor versions, so you should not use this if you want to avoid unexpected breaking changes.
|
||
|
||
## Supported Rules
|
||
|
||
| Name | Description | |
|
||
| --- | --- | --- |
|
||
| [`@docusaurus/no-untranslated-text`](./no-untranslated-text.md) | Enforce text labels in JSX to be wrapped by translate calls | |
|
||
| [`@docusaurus/string-literal-i18n-messages`](./string-literal-i18n-messages.md) | Enforce translate APIs to be called on plain text labels | ✅ |
|
||
|
||
✅ = recommended
|
||
|
||
## Example configuration
|
||
|
||
Here's an example configuration:
|
||
|
||
```js title=".eslintrc.js"
|
||
module.exports = {
|
||
extends: ['plugin:@docusaurus/recommended'],
|
||
plugins: ['@docusaurus'],
|
||
rules: {
|
||
'@docusaurus/no-untranslated-text': [
|
||
'warn',
|
||
{ignoredStrings: ['·', '—', '×']},
|
||
],
|
||
},
|
||
};
|
||
```
|