README

Installation

npm install eslint \
            eslint-watch \
            typescript \
            eslint-config-jaden-digital \
            eslint-config-airbnb-typescript@^9.0.0 \
            @typescript-eslint/parser@^3.7.1 \
            @typescript-eslint/eslint-plugin@^3.7.1 \
            eslint-plugin-import@^2.22.0 \
            eslint-plugin-jsx-a11y@^6.3.1 \
            eslint-plugin-react@^7.20.5 \
            eslint-plugin-react-hooks@^4.0.8 \
            --save-dev

Next, create a .eslintrc.js config file in the root of your project, and populate it with the following:

module.exports = {
    root: true,
    parser: '@typescript-eslint/parser',
    parserOptions: {
        tsconfigRootDir: __dirname,
        project: ['./tsconfig.json'],
    },
    plugins: [
      '@typescript-eslint',
    ],
    extends: 'eslint-config-jaden-digital'
}

And then create a .eslintignore and add patterns for files you wish to ignore, for example:

node_modules
vendor
.eslintrc.js
**/*.test.ts

resources/js/build

resources/js/src/typings

resources/js/src/type-declarations.d.ts

Add these in your package.json scripts object

  "scripts": {
      ...
      "lint": "npx eslint . --ext .ts,.tsx",
      "lint:watch": "npx esw -w . --ext .ts,.tsx --color --cache",
      ...
  }

Usage

Run them from your command line like this:

npm run lint

npm run lint:watch

yarn lint

yarn lint:watch

You can of course pass options through to eslint or esw. For example, if you only want to see errors and suppress warnings, pass the --quiet param by calling any of the above options like this:

npm run lint -- --quiet

npm run lint:watch -- --quiet

yarn lint -- --quiet

yarn lint:watch -- --quiet

You can auto fix errors by passing --fix in the exact same way as ```--quiet`` is demonstrated above