DEPRECATION NOTICE: This package has been moved to @hack4impact-uiuc/eslint-plugin and will not be publishing further versions under the h4iuiuc scope

eslint-plugin

An ESLint plugin intended for use with Hack4Impact UIUC projects.

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install @h4iuiuc/eslint-plugin:

npm install @h4iuiuc/eslint-plugin --save-dev

Usage

To enable @h4iuiuc/eslint-plugin, you'll need to create a .eslintrc.json file for ESLint configuration.

This plugin abstracts away configuration from the user, extending configs from eslint-plugin-import, eslint-plugin-jsx-a11y, eslint-plugin-react, and eslint-plugin-react-hooks through the recommended config (inspired by eslint-config-react-app).

For a JavaScript-only app all you'll need to have in your .eslintrc.json file is the following:

{
  "plugins": ["@h4iuiuc"],
  "extends": ["plugin:@h4iuiuc/recommended"]
}

If your app uses TypeScript at all, you'll want to use @typescript-eslint/eslint-plugin by extending the typescript config as follows:

{
  "plugins": ["@h4iuiuc"],
  "extends": ["plugin:@h4iuiuc/recommended", "plugin:@h4iuiuc/typescript"]
}

If you need to modify or disable specific rules, you can do so in the rules section of your .eslintrc.json file. For example, if you wish to disable no-anonymous-parameterless-props, add the following to your .eslintrc.json file:

{
  "rules": {
    "@h4iuiuc/no-anonymous-parameterless-props": "off"
  }
}

Note that disabling rules from plugins requires prefixing them with their corresponding scope and/or plugin name.

Fixes

Some rules (see table below) are fixable using the --fix ESLint option.

Supported Rules

Rules

| Rule | Default | Fixable | | --------------------------------------------------------------------------------------- | ------------------------- | ------------------ | | no-access-state-after-set | :triangular_flag_on_post: | :x: | | no-null-ternary | :triangular_flag_on_post: | :heavy_check_mark: | | no-anonymous-parameterless-props | :triangular_flag_on_post: | :heavy_check_mark: |

Key

| Symbol | Meaning | | ------------------------- | --------------------------- | | :triangular_flag_on_post: | Error | | :warning: | Warning | | :heavy_multiplication_x: | Off | | :heavy_check_mark: | Fixable and autofix-enabled | | :x: | Not fixable |