README.md

Autograders Node ESLint Config

This package provides @autograders node .eslintrc as an extensible shared ESLint config.

1) Installation

If you are using NPM:

npm install --save-dev @autograders/eslint-config-node

If you are using Yarn:

yarn add --dev @autograders/eslint-config-node

2) Create a .eslintrc.js file

Create a .eslintrc.js in the same directory where package.json is with the following content:

module.exports = {
  extends: ['@autograders/eslint-config-node']
};

3) Add a lint script inside package.json

{
  "scripts": {
    "lint": "eslint \"{src,pages}/**/*.{tsx,ts}\" --fix"
  }
}

4) Test lint

If you are using NPM:

npm run lint

If you are using Yarn:

yarn lint