4.0.0 • Published 2 years ago
eslint-plugin-dtwo v4.0.0
eslint-plugin-dtwo
:sparkles: ESLint plugin for Dtwo.js
:cd: Installation
You'll first need to install ESLint:
$ npm i eslint --save-dev
success Saved 1 new dependenciesNext, install eslint-plugin-dtwo:
$ npm install eslint-plugin-dtwo --save-dev
success Saved 1 new dependenciesNote: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-dtwo globally.
:rocket: Usage
Add dtwo to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:
- Use our preset to extend recommended defaults:
{
"extends": [
"plugin:dtwo/recommended"
]
}- Or specify individual rules manually:
{
"plugins": [
"dtwo"
],
"rules": {
"dtwo/rule-name": 2
}
}:gear: Configs
This plugin provides four predefined configs:
plugin:dtwo/base- Settings and rules to enable correct ESLint parsingplugin:dtwo/recommended- Above, plus rules to enforce subjective community defaults to ensure consistency
:bulb: Rules
Base Rules
{
"extends": "plugin:dtwo/base"
}| Rule ID | Description | |
|---|---|---|
| dtwo/no-env-in-context | Disallow context.isServer/context.isClient in asyncData/fetch/dtwoServerInit | |
| dtwo/no-env-in-hooks | Disallow process.server/process.client in client only Kdu lifecycle hooks like: mounted, beforeMount, updated... | |
| dtwo/no-globals-in-created | Disallow window/document in created/beforeCreate | |
| dtwo/no-this-in-fetch-data | Disallow this in asyncData/fetch | |
| dtwo/no-cjs-in-config | Disallow require/modules.exports/exports in dtwo.config.js |
Recommended Rules
Include all the below rules, as well as all priority rules in above categories, with:
{
"extends": "plugin:dtwo/recommended"
}| Rule ID | Description | |
|---|---|---|
| dtwo/no-timing-in-fetch-data | Disallow setTimeout/setInterval in asyncData/fetch |
Other Rules
| Rule ID | Description | |
|---|---|---|
| dtwo/require-func-head | Enforce head property in component to be a function. |
4.0.0
2 years ago