1.0.1 • Published 6 years ago

eslint-config-tix v1.0.1

Weekly downloads
144
License
ISC
Repository
github
Last release
6 years ago

tix-eslint-config

This package includes the shareable ESLint configuration used by TIX React Skeleton. Please refer to its documentation:

Usage in TIX React Skeleton Projects

The easiest way to use this configuration is with TIX React Skeleton, which includes it by default.

You don’t need to install it separately in TIX React Skeleton projects.

Usage Outside of TIX React Skeleton

If you want to use this ESLint configuration in a project not built with Create React App, you can install it with following steps.

First, install this package, ESLint and the necessary plugins.

npm install --save-dev eslint-config-tix-react babel-eslint@^7.2.3 eslint@^4.1.1 eslint-plugin-import@^2.6.0 eslint-plugin-react@^7.1.0 eslint-import-resolver-webpack@^0.8.4 eslint-plugin-jest@^21.15.0 eslint-plugin-jsdoc@^3.6.2

Then create a file named .eslintrc with following contents in the root folder of your project:

{
  "extends": "tix-react"
}

That's it! You can override the settings from eslint-config-tix-react by editing the .eslintrc file. Learn more about configuring ESLint on the ESLint website. If you want to enable even more accessibility rules, you can create an .eslintrc file in the root of your project with this content:

{
  "extends": ["react-app", "plugin:jsx-a11y/recommended"],
  "plugins": ["jsx-a11y"]
}