eslint-config-vast

eslint-config-vast

ESLint shareable config Vast's JavaScript coding standards

Installation

npm install eslint-config-vast --save-dev

Usage

For server-side (Node.js) code

Create .eslintrc file in the root of your project with the following config:

{
  "extends": "eslint-config-vast",
  "rules": {
    // Your overrides...
  }
}

For client-side code

Since the default settings are for server-side, in case you want to use the config for a client-side project, or in case you want to add an additional .stylelintrc file in a client-side code folder (e.g. /client/.eslintrc), use the following config:

{
    "extends": "eslint-config-vast",
    "env": {
        "browser": true,
        "es6": false // if you're not using Babel
    },
    "parserOptions": {
        "sourceType": "module", // if you're using Babel
        "ecmaVersion": 8 // if you're using Babel
    },
    "globals": {
            "SOME_GLOBAL": false
    },
    "rules": {
        // Your overrides...
    }
}

Setting up ESLint

If you haven’t already set up ESLint on your project, run:

npm install eslint --save-dev

Add "eslint" to "scripts" in package.json (wrap globstar pattern with single quotes):

"scripts": {
    "eslint": "eslint js tests *.js --ignore-pattern 'js/vendor/**/*.js'"
}

...and then you can run:

npm run eslint

To add a Git pre-commit hook for ESLint, run:

npm install pre-commit --save-dev

...and add this to package.json:

"pre-commit": [
  "eslint"
]

Tip: For real-time linting in your text editor, see ESLint integrations for editors.

Tip: Run eslint --fix /path/to/file.js to automatically fix as many issues as possible.

Tip: You can create a personal configuration file in your home directory (~/.eslintrc), it will only be used if no other configuration files are found. See Configuration Cascading and Hierarchy. But make sure to all install dependencies globally with -g flag.

Related

• eslint-config-vast-react for React
• eslint-config-standard for JavaScript Standard Style Guide
• eslint-config-airbnb-base
  • eslint-config-airbnb for React
• eslint-config-xo for XO (ESLint-based linter)
  • eslint-config-xo-react for React

License

MIT © 2016 Vast.com, Inc.