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

Commit

Permalink
docs: cosmetic tweaks to tutorials
Browse files Browse the repository at this point in the history
  • Loading branch information
robertrossmann committed Jun 25, 2018
1 parent eda4bd2 commit 28a55cb
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions tutorial/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ When configuring js-coding-standards, please keep the following in mind:
> 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`.
- Some rules are **meant** to be disabled, but only for some folders/files
> For example, the rule `no-process-env` is enabled by default because accessing any 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.
> 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.
- Always consider re-configuring a rule rather than disabling it completely
> If a rule does not quite fit your exiting codebase and fixing the issues would take considerable amount of time/energy, please consider first if the rule could be re-configured to suit your project's current style, rather than disabling it right away.
# Example configuration files
## Example configuration files

Some example configuration files have been prepared for you to look at / add to your project right away. Look for them in this directory!
4 changes: 2 additions & 2 deletions tutorial/nodejs-eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
// directory, or a subdirectory if your project consists of both node.js and browser code.
module.exports = {
extends: [
'@strv/javascript/environments/nodejs/v8',
'@strv/javascript/environments/nodejs/v10',
'@strv/javascript/environments/nodejs/optional',
'@strv/javascript/coding-styles/recommended',
],
Expand All @@ -23,7 +23,7 @@ module.exports = {
},

rules: {
'func-names': 0,
'func-names': 'off',
},
}],
}
2 changes: 1 addition & 1 deletion tutorial/react-eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
// directory, or a subdirectory if your project consists of both node.js and browser code.
module.exports = {
extends: [
'@strv/javascript/environments/react/v15',
'@strv/javascript/environments/react/v16',
'@strv/javascript/environments/react/optional',
'@strv/javascript/coding-styles/recommended',
],
Expand Down

0 comments on commit 28a55cb

Please sign in to comment.