Skip to content
This repository was archived by the owner on Mar 7, 2019. It is now read-only.

Commit b67e19d

Browse files
Further update docs and README
1 parent e7a0a9d commit b67e19d

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,13 @@ This package can be installed via npm:
2929

3030
Once the ruleset is installed, you must create your own *.eslintrc.{js,json,yml}* configuration file in your project's root and include those rulesets that you want to use. See the [examples](examples) directory for, well... examples.
3131

32+
> **WARNING:** The order in which various configuration files are loaded **DOES MATTER**. The recommended load order is the following:
33+
>
34+
> - One of the versioned configurations for the chosen environment, ie. *environments/nodejs/v6*
35+
> - The best practices configuration file (if it exists), ie. *environments/nodejs/best-practices*
36+
> - The optional configuration file (if it exists), ie. *environments/nodejs/optional*
37+
> - Coding style ruleset, ie. *coding-styles/base*
38+
3239
## Structure
3340

3441
The ESLint rules are semantically grouped into various categories for easy composition.

examples/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Project configuration examples
22

3-
To use these rulesets, you must have an *.eslintrc* configuration file present in your project root. In this file, you then include those rulesets which you would like to use in your project.
3+
To use these rulesets, you must have an *.eslintrc.{js,json,yml}* configuration file present in your project root. In this file, you then include those rulesets which you would like to use in your project.
44

5-
The path to the ruleset must start with `eslint-config-javascript` (this ruleset's package name). Optionally, ESLint allows to drop the `eslint-config` to keep it short. The rest of the path is an actual folder/file in this repository. Extensions can be omitted. For detailed explanation, see ESLint's [shareable configs][shareable-configs].
5+
Your `extends` entry must always start with `@strv/javascript`. The rest of the path is an actual folder/file in this repository. Extensions **should** be omitted. For detailed explanation, see ESLint's [shareable configs][shareable-configs].
66

7-
Your configuration file can either be json, classic Node.js module, or YAML file.
7+
Your configuration file can either be json, classic Node.js module, or YAML file. It is recommended **not** to use json, because sometimes you might want to include some comment as to why you are doing this or that, which is not possible with json.
88

99
```js
1010
// .eslintrc.js

0 commit comments

Comments
 (0)