From df564ebb86ce229b4e1057c494130690cedce31a Mon Sep 17 00:00:00 2001 From: Adrien Maret Date: Wed, 13 Jul 2022 15:03:40 +0200 Subject: [PATCH 1/3] Update README.md --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b008bce..5fb4fc5 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,15 @@ Kuzzle Coding Standard -## Installation +## Install our coding standard -Install ESLint and the plugin +1) Install ESLint and the plugin ```sh npm i eslint eslint-plugin-kuzzle ``` - -## Usage - -Add `kuzzle` to the plugins section of your `.eslintrc` configuration file and select the default rule set: +2) Add `kuzzle` to the plugins section of your `.eslintrc` configuration file and select the default rule set: ```json { @@ -24,14 +21,20 @@ Add `kuzzle` to the plugins section of your `.eslintrc` configuration file and s "plugin:kuzzle/typescript", ] } +``` + +3) Run Prettier to format the code accordingly +```sh +echo {}> .prettierrc.json +npx prettier lib/ test/ features/ --write ``` +4) Commit relevant files + ## Available rule sets - `plugin:kuzzle/default`: default rules between all javascript projects - `plugin:kuzzle/node`: rules for Node.js projects - `plugin:kuzzle/typescript`: rules for Typescript projects - - From 49740bbf86e825c1dba76059bc50228576482156 Mon Sep 17 00:00:00 2001 From: Adrien Maret Date: Wed, 13 Jul 2022 15:06:13 +0200 Subject: [PATCH 2/3] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5fb4fc5..caa0baa 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,9 @@ echo {}> .prettierrc.json npx prettier lib/ test/ features/ --write ``` -4) Commit relevant files +4) Remove unused eslint-related dependencies (such as `@typescript-eslint/eslint-plugin`, etc) + +5) Commit relevant files ## Available rule sets From 4ab41ae1d025f967d3a755307cee1b0bb1dd7ca6 Mon Sep 17 00:00:00 2001 From: Adrien Maret Date: Wed, 13 Jul 2022 18:00:53 +0200 Subject: [PATCH 3/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index caa0baa..b0d9530 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Kuzzle Coding Standard 1) Install ESLint and the plugin ```sh -npm i eslint eslint-plugin-kuzzle +npm i eslint eslint-plugin-kuzzle prettier ``` 2) Add `kuzzle` to the plugins section of your `.eslintrc` configuration file and select the default rule set: