Skip to content

Latest commit

 

History

History
55 lines (39 loc) · 1.22 KB

README.md

File metadata and controls

55 lines (39 loc) · 1.22 KB
Raw

eslint-config-brown

ESLint rules for Brown University projects using eslint-config-airbnb as a base (with a few overrides), and exposing some additional extensions.

Usage

1. Install packages

// npm
npm i -D eslint git+https://github.com/BrownUniversity/eslint-config-brown.git#^0.19.0

// yarn
yarn add -D eslint git+https://github.com/BrownUniversity/eslint-config-brown.git#^0.19.0

2. Configure ESLint

Add "extends": "brown" to your .eslintrc:

{
  "extends": "brown",
  "env": {
    "browser": true // be sure to add this for frontend projects
  },
  "rules": {
    // your overrides
  }
}

Additional extensions:

  • brown/cypress
  • brown/flow
  • brown/jest
  • brown/prettier
  • brown/vue

The brown/prettier extension must come last in the "extends" array so it gets the chance to override other configs.

Deployment

To publish a new version, do the following:

  1. Bump version in package.json and package-lock.json
  2. Bump version in README.md install instructions (for major and minor version bumps only)
  3. Commit changes
  4. Tag new version
  5. Push master and tags to all remotes