@dormdev/eslint-config
ESLint config with Prettier and React
Last updated 5 months ago by thomaswangio .
MIT · Repository · Original npm · Tarball · package.json
$ cnpm install @dormdev/eslint-config 
SYNC missed versions from official npm registry.

Just a ESLint config with Prettier and React

A forked version of eslint-config-wesbos! This package intentionally includes all of the required devDependencies so you don't need to install them again in your own project. Just follow the installation instructions and you can start linting your React project right away.

What it does

  • Lints JavaScript based on the latest standards
  • Fixes issues and formatting errors with Prettier
  • Lints + Fixes inside of html script tags
  • Lints + Fixes React via eslint-config-airbnb
  • You can see all the rules here.

Installation

  1. If you don't already have a package.json file, create one with yarn init.

  2. Install the package:

yarn add @dormdev/eslint-config
  1. Create a .eslintrc file in the root of your project's directory (it should live where package.json does). Your .eslintrc file should look like this:
{
  "extends": ["@dormdev/eslint-config"]
}

Tip: You can alternatively put this object in your package.json under the property "eslintConfig":. This makes one less file in your project.

  1. You can add two scripts to your package.json to lint and/or fix:
"scripts": {
  "lint": "eslint .",
  "lint:fix": "eslint . --fix"
},
  1. Now you can manually lint your code by running yarn run lint and fix all fixable issues with yarn run lint:fix. You probably want your editor to do this though.

Settings

If you'd like to overwrite eslint or prettier settings, you can add the rules in your .eslintrc file. The ESLint rules go directly under "rules" while prettier options go under "prettier/prettier". Note that prettier rules overwrite anything in the config (semicolons and single quotes), so you'll need to include those as well.

{
  "extends": [
    "dormdev"
  ],
  "rules": {
    // some rules
    "prettier/prettier": [
      "error",
      {
        "semi": false,
        "singleQuote": true,
      }
    ]
  }
}

With VS Code

You should read this entire thing. Serious!

Once you have done one, or both, of the above installs. You probably want your editor to lint and fix for you. Here are the instructions for VS Code:

  1. Install the ESLint package
  2. Now we need to setup some VS Code settings via Code/FilePreferencesSettings. It's easier to enter these settings while editing the settings.json file, so click the {} icon in the top right corner:
{
  "editor.formatOnSave": true,
  "[javascript]": {
    "editor.formatOnSave": false
  },
  "[javascriptreact]": {
    "editor.formatOnSave": false
  },
  "prettier.disableLanguages": ["javascript", "javascriptreact"],
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  }
}

Current Tags

  • 0.1.4                                ...           latest (5 months ago)

4 Versions

  • 0.1.4                                ...           5 months ago
  • 0.1.3                                ...           5 months ago
  • 0.1.2                                ...           5 months ago
  • 0.1.1                                ...           5 months ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 4
Last Day 0
Last Week 4
Last Month 1
Dev Dependencies (0)
None
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |