kanufy/eslint-config-fluct

ESLint configurations that are used by fluct division of VOYAGE GROUP, Inc.

eslint-config-fluct

Basic Principles for Settings

• Ban a dangerous style.
• Sort a style to avoid errors and to increase productivity.
• We set rules as error if we think such style causes mistake easily ABSOLUTELY.
  • In other words, we make them an error that dangerous, foot-gun, or explicit mistake.
• We set rules as warn, if we think such style might be ugly but it's useful for debugging or you might write when trying an approach.
  • You can land a patch without fixing warning. But YOU should fix them.
• We set rules as off if it is just a stylistic problem and there are no increasing any productivity.
• This rule set treats ECMA262 6th (ECMA2015) or later one as Tier 1 state. If you use this rules in ~ES5 environment, you may need to set some options.

How To Use

1. install to your project

• as npm package (TBD. see #23)
• Specify tar.gz to a dependency field in your package.json.
  • "eslint-config-fluct": "https://github.com/voyagegroup/eslint-config-fluct/archive/<COMMIT_HASH>.tar.gz".
  • Please replace <COMMIT_HASH> with tag name (e.g. v1.2.3), or an arbitary commit hash.
    • You can specify master or other branch directly. But we don't recommend it strongly.

2. Import via extends fields in your .eslintrc.js

'use strict';

module.exports = {
    'extends': [
        './node_modules/eslint-config-fluct/config/eslintrc_core.js', // for eslint's builtin rules.
        './node_modules/eslint-config-fluct/config/eslintrc_node.js', // for eslint-plugin-react
        './node_modules/eslint-config-fluct/config/eslintrc_react.js', // for eslint-plugin-node
    ]
};

• see also: ESLint's document

3. Set your constomized settings.

• Set env, parserOptions, or others as you like.

Examples

• For web browsers which support only ES5.

License

• The MIT License
  • Original: https://opensource.org/licenses/MIT