Kuzzle Coding Standard.
This plugin is standalone, meaning that eslint
and prettier
are included in the package so you don't need to install them yourself.
- Install the plugin
npm i eslint-plugin-kuzzle --save-dev
- Add
kuzzle
to the plugins section of your.eslintrc
configuration file and select the default rule set:
{
"extends": [
"plugin:kuzzle/default",
"plugin:kuzzle/node",
"plugin:kuzzle/typescript"
]
}
-
Remove unused eslint-related dependencies (such as
@typescript-eslint/eslint-plugin
,eslint
etc) -
Commit relevant files
-
plugin:kuzzle/default
: default rules between all javascript projects -
plugin:kuzzle/node
: rules for Node.js projects -
plugin:kuzzle/typescript
: rules for Typescript projects
You can disable the sort-keys
rule on project that are not libraries:
{
"extends": [
"plugin:kuzzle/default",
"plugin:kuzzle/node",
"plugin:kuzzle/typescript"
],
"rules": {
"sort-keys": ["off"]
}
}