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

Commit 1444e34

Browse files
Revert "chore: rename package to @strv/eslint-config"
This reverts commit 2991cf6.
1 parent 19baa84 commit 1444e34

File tree

9 files changed

+40
-36
lines changed

9 files changed

+40
-36
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[nodejs-home]: https://nodejs.org
99

1010

11-
# ESLint-Config
11+
# JavaScript Coding Standards
1212

1313
> Write bulletproof JavaScript like a pro! 😎
1414
@@ -26,7 +26,7 @@ This repository contains various configuration files for the awesome JavaScript
2626

2727
This package can be installed via npm (make sure you also install the latest version of ESLint):
2828

29-
`npm install --save-dev eslint@latest @strv/eslint-config@latest`
29+
`npm install --save-dev eslint@latest @strv/eslint-config-javascript@latest`
3030

3131
### Configuration
3232

@@ -44,33 +44,33 @@ See the [tutorial](tutorial) directory for lots of example config files.
4444

4545
#### For [Node.js][nodejs-home]
4646

47-
- @strv/environments/nodejs/v10
48-
- @strv/environments/nodejs/v8-3
49-
- @strv/environments/nodejs/v8
50-
- @strv/environments/nodejs/v6
51-
- @strv/environments/nodejs/optional
47+
- @strv/javascript/environments/nodejs/v10
48+
- @strv/javascript/environments/nodejs/v8-3
49+
- @strv/javascript/environments/nodejs/v8
50+
- @strv/javascript/environments/nodejs/v6
51+
- @strv/javascript/environments/nodejs/optional
5252

5353
#### For [React][react-home]
5454

55-
- @strv/environments/react/v16
56-
- @strv/environments/react/v15
57-
- @strv/environments/react/optional
58-
- @strv/environments/react/accessibility
55+
- @strv/javascript/environments/react/v16
56+
- @strv/javascript/environments/react/v15
57+
- @strv/javascript/environments/react/optional
58+
- @strv/javascript/environments/react/accessibility
5959
> This one contains rules specific to web accessibility best practices.
6060
6161
#### For [Flow][flow-home]
6262

63-
- @strv/environments/flow/recommended
63+
- @strv/javascript/environments/flow/recommended
6464

6565
#### Coding styles
6666

6767
These rulesets include rules which deal with how the code looks like and not how it works. They help keep the code clean and consistent.
6868

69-
- @strv/coding-styles/recommended
70-
- @strv/coding-styles/fixable
69+
- @strv/javascript/coding-styles/recommended
70+
- @strv/javascript/coding-styles/fixable
7171
> This is a subset of the `recommended` coding style ruleset and includes only rules which [ESLint can fix automatically][eslint-fixing]. This is great for gradual adoption of coding style rulesets into existing projects.
7272
73-
- @strv/coding-styles/flow
73+
- @strv/javascript/coding-styles/flow
7474
> This one contains coding style rules for code using Flow
7575
7676
## License

environments/flow/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ These configuration files are suitable to lint Flow type annotations.
44

55
## Configurations
66

7-
### @strv/environments/flow/recommended
7+
### @strv/javascript/environments/flow/recommended
88

99
Basic ruleset for Flow. Main focus is on consistent way to write type annotations.
1010

environments/nodejs/README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,25 @@ These configuration files are suitable to lint code which will run on Node.js.
44

55
## Configurations
66

7-
### @strv/environments/nodejs/v6
7+
### @strv/javascript/environments/nodejs/v6
88

99
Suitable for projects running on Node.js v6.
1010

11-
### @strv/environments/nodejs/v8
11+
### @strv/javascript/environments/nodejs/v7
12+
13+
Suitable for projects running on Node.js v7.
14+
15+
### @strv/javascript/environments/nodejs/v8
1216

1317
Suitable for projects running on Node.js v8.
1418

15-
### @strv/environments/nodejs/v8-3
19+
### @strv/javascript/environments/nodejs/v8-3
1620

1721
Suitable for projects running on Node.js v8.3.
1822

1923
> Node.js 8.3 upgraded the v8 engine to 6.0 which [brings some ECMAScript features](https://v8project.blogspot.cz/2017/06/v8-release-60.html) previously not available in Node.js . This ruleset enables those language features.
2024
21-
### @strv/environments/nodejs/optional
25+
### @strv/javascript/environments/nodejs/optional
2226

2327
Use this ruleset in conjunction with any of the above version-specific rulesets. Provides additional insights into potential inconsistencies in the project.
2428

environments/react/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,20 @@ These configuration files are suitable to lint React components.
66

77
## Configurations
88

9-
### @strv/environments/react/v16
9+
### @strv/javascript/environments/react/v16
1010

1111
Suitable for React v16. This ruleset builds on the react/v15 ruleset documented below and bumps the React version to 16 in the plugin configuration, causing some rules to recognise React 16-specific programming patterns.
1212

13-
### @strv/environments/react/v15
13+
### @strv/javascript/environments/react/v15
1414

1515
Suitable for React v15. This ruleset configures ESLint to recognise JSX syntax and enables some rules that make the linting process more natural. Some accesssibility rules are also included to keep users happy even if they are using screen readers, braile devices or just keyboard.
1616

17-
### @strv/environments/react/optional
17+
### @strv/javascript/environments/react/optional
1818

1919
Use this ruleset in conjunction with any of the above version-specific rulesets. Provides additional insights into potential inconsistencies in the project.
2020

2121
> For new projects, it is recommended to enable this ruleset. For existing projects, it is only recommended for the brave.
2222
23-
### @strv/environment/react/accessibility
23+
### @strv/javascript/environment/react/accessibility
2424

2525
Use this ruleset to enable the [`a11y`][a11y-repo] rules which provide checks for writing accessible JSX components.

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@strv/eslint-config",
2+
"name": "@strv/eslint-config-javascript",
33
"description": "Write bulletproof JavaScript like a pro! 😎",
44
"version": "8.0.2",
55
"author": "Robert Rossmann <[email protected]>",

tutorial/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ When configuring js-coding-standards, please keep the following in mind:
1313
- Do not include extensions when extending
1414
> You should not include the file extension in your `extends:` properties - the format in which this ruleset is written should be an implementation detail for ESLint to figure out.
1515
>
16-
> - Good: `@strv/environments/nodejs/v8`
17-
> - Bad: `@strv/environments/nodejs/v8.js`
16+
> - Good: `@strv/javascript/environments/nodejs/v8`
17+
> - Bad: `@strv/javascript/environments/nodejs/v8.js`
1818
1919
- Extend from the `optional` rulesets after you extend from the main, version-specific environment ruleset
20-
> In other words, if you decide to include ie. `@strv/environments/nodejs/optional`, include it **after** you have included `@strv/environments/nodejs/v8`.
20+
> In other words, if you decide to include ie. `@strv/javascript/environments/nodejs/optional`, include it **after** you have included `@strv/javascript/environments/nodejs/v8`.
2121
2222
- Some rules are **meant** to be disabled, but only for some folders/files
2323
> For example, the rule `no-process-env` is enabled by default because accessing any property on `process.env` object causes an expensive C-level function call. However, using `process.env` is the recommended way to manage application configuration. Therefore, some configuration files disable this rule for all files located in a directory named _config_ or _configuration_. Here, you gather all the required configuration options from `process.env` and export them in a module. The rest of your application no longer needs to access `process.env` directly and instead reads the configuration from that module.

tutorial/nodejs-eslintrc.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
// directory, or a subdirectory if your project consists of both node.js and browser code.
55
module.exports = {
66
extends: [
7-
'@strv/environments/nodejs/v10',
8-
'@strv/environments/nodejs/optional',
9-
'@strv/coding-styles/recommended',
7+
'@strv/javascript/environments/nodejs/v10',
8+
'@strv/javascript/environments/nodejs/optional',
9+
'@strv/javascript/coding-styles/recommended',
1010
],
1111

1212
// As of ESLint 4.1, you no longer need to use separate, per-directory .eslintrc.js files and

tutorial/react-eslintrc.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
// directory, or a subdirectory if your project consists of both node.js and browser code.
55
module.exports = {
66
extends: [
7-
'@strv/environments/react/v16',
8-
'@strv/environments/react/optional',
9-
'@strv/coding-styles/recommended',
7+
'@strv/javascript/environments/react/v16',
8+
'@strv/javascript/environments/react/optional',
9+
'@strv/javascript/coding-styles/recommended',
1010
],
1111
}

0 commit comments

Comments
 (0)