Miss any of our Open RFC calls?Watch the recordings here! »

eslint-config-prev

7.0.0 • Public • Published

prev

Code Style Prev NPM Version Build Status Dependency Status

ESLint shareable config for ES2015+

Translations: Korean

Install

$ npm install --save-dev eslint eslint-config-prev

Usage

Add extends field to your ESLint config (if you haven't created, create one):

.eslintrc.yml:

extends: prev

Or if you prefer package.json:

{
  "eslintConfig": {
    "extends": "prev"
  }
}

Available configs

Every config provided by this sharable config have ECMAScript modules support and esnext features by default.

  • prev: The basic config for common JavaScript projects. This config is assuming you are in node environment (e.g. nodejs, webpack, ...).
  • prev/react: The config for React projects with support for React and JSX.
  • prev/native: The config for ReactNative projects with support for React and JSX.

If you are on browser environment, you may need to add browser option to env field:

env:
  browser: true

Advanced usage

Globals

Whenever you need to use global variables for some case (e.g. refering external library), you can add them to your config to let ESLint recognize that variables are populated in global:

globals:
  $: false

You can specify the variable name with boolean value as a property of globals object in the config. Specifying true will allow the variable to be overwritten in the code or false to disallow overwriting.

Using script source type

Every config enables modules syntax by default. Add next to config if you want to disable it:

parserOptions:
  sourceType: script

Using ES5 instead of ES2015+

This is not generally recommended, you can fallback to ES5 by adding next to your config if you need. This will change environment to ES5:

env:
  es6: false
parserOptions:
  ecmaVersion: 5

Note: However, ESLint might still show you error or warning since this sharable config is created in mind that you are in ES2015+ environment. In this case, you can safely disable the rule manually.

Composing configs

By default, the top-level configs described above enforce you to use ECMAScript modules and esnext features via Babel.

If you don't want to be enforced by this rule to use them, you can choose what you just need and compose your own rules from rules directory:

.eslintrc.yml:

extends:
  - prev/rules/base
  - prev/rules/react

package.json:

{
  "eslintConfig": {
    "extends": [
      "prev/rules/base",
      "prev/rules/react"
    ]
  }
}

Electron

If you are on Electron environment, you may need to add electron module to core-modules. So that eslint-import-plugin can consider the electron module as a core module like path:

settings:
  import/core-modules: electron

You can find more details about ESLint configuration here.

Badge

If you loved this config, please consider to add this fancy badge to your awesome project!

Code Style Prev

[![Code Style Prev](https://img.shields.io/badge/code%20style-prev-32c8fc.svg)](https://github.com/preco21/eslint-config-prev)

License

MIT

Install

npm i eslint-config-prev

DownloadsWeekly Downloads

18

Version

7.0.0

License

MIT

Unpacked Size

34.2 kB

Total Files

13

Last publish

Collaborators

  • avatar