@blumintinc/eslint-plugin-blumint 0.1.23 → 1.0.2

package/plugin/README.md

@@ -0,0 +1,80 @@
+# @blumintinc/eslint-plugin-blumint
+
+Custom eslint rules for use at BluMint
+
+## Installation
+
+You'll first need to install [ESLint](https://eslint.org/):
+
+```sh
+npm i eslint --save-dev
+```
+
+Next, install `@blumintinc/eslint-plugin-blumint`:
+
+```sh
+npm install @blumintinc/eslint-plugin-blumint --save-dev
+```
+
+## Usage
+
+Add `@blumintinc/blumint` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
+
+```json
+{
+    "plugins": [
+        "@blumintinc/blumint"
+    ]
+}
+```
+
+
+Then configure the rules you want to use under the rules section.
+
+```json
+{
+    "rules": {
+        "blumint/rule-name": "error"
+    }
+}
+```
+
+Or use the recommended config:
+
+```json
+{
+    "extends": ["some-other-plugin", "plugin:@blumintinc/blumint/recommended"]
+}
+```
+
+## Rules
+
+<!-- begin auto-generated rules list -->
+
+💼 Configurations enabled in.\
+⚠️ Configurations set to warn in.\
+✅ Set in the `recommended` configuration.\
+🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).
+
+| Name                                                                               | Description                                                                                                                                     | 💼 | ⚠️ | 🔧 |
+| :--------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------- | :- | :- | :- |
+| [array-methods-this-context](docs/rules/array-methods-this-context.md)             | Prevent misuse of Array methods in OOP                                                                                                          |    | ✅  |    |
+| [class-methods-read-top-to-bottom](docs/rules/class-methods-read-top-to-bottom.md) | Ensures classes read linearly from top to bottom.                                                                                               |    | ✅  | 🔧 |
+| [dynamic-https-errors](docs/rules/dynamic-https-errors.md)                         | Dynamic error details should only be in the third argument of the HttpsError constructor. The second argument is hashed to produce a unique id. |    | ✅  |    |
+| [export-if-in-doubt](docs/rules/export-if-in-doubt.md)                             | All top-level const definitions, type definitions, and functions should be exported                                                             |    |    |    |
+| [extract-global-constants](docs/rules/extract-global-constants.md)                 | Extract constants/functions to the global scope when possible                                                                                   |    |    |    |
+| [generic-starts-with-t](docs/rules/generic-starts-with-t.md)                       | Enforce TypeScript generic types to start with T                                                                                                |    | ✅  |    |
+| [no-async-array-filter](docs/rules/no-async-array-filter.md)                       | Disallow async callbacks for Array.filter                                                                                                       | ✅  |    |    |
+| [no-async-foreach](docs/rules/no-async-foreach.md)                                 | Disallow Array.forEach with an async callback function                                                                                          | ✅  |    |    |
+| [no-conditional-literals-in-jsx](docs/rules/no-conditional-literals-in-jsx.md)     | Disallow use of conditional literals in JSX code                                                                                                | ✅  |    |    |
+| [no-filter-without-return](docs/rules/no-filter-without-return.md)                 | Disallow Array.filter callbacks without an explicit return (if part of a block statement)                                                       | ✅  |    |    |
+| [no-misused-switch-case](docs/rules/no-misused-switch-case.md)                     | Prevent misuse of logical OR in switch case statements                                                                                          | ✅  |    |    |
+| [no-unpinned-dependencies](docs/rules/no-unpinned-dependencies.md)                 | Enforces pinned dependencies                                                                                                                    | ✅  |    | 🔧 |
+| [no-useless-fragment](docs/rules/no-useless-fragment.md)                           | Prevent unnecessary use of React fragments                                                                                                      |    | ✅  | 🔧 |
+| [prefer-fragment-shorthand](docs/rules/prefer-fragment-shorthand.md)               | Prefer <> shorthand for <React.Fragment>                                                                                                        |    | ✅  | 🔧 |
+| [prefer-type-over-interface](docs/rules/prefer-type-over-interface.md)             | Prefer using type alias over interface                                                                                                          |    | ✅  | 🔧 |
+| [require-memo](docs/rules/require-memo.md)                                         | React components must be memoized                                                                                                               | ✅  |    | 🔧 |
+
+<!-- end auto-generated rules list -->
+
+

package/{docs → plugin/docs}/rules/class-methods-read-top-to-bottom.md

@@ -1,7 +1,9 @@
-# Try to keep classes reading top to bottom (`@blumintinc/blumint/class-methods-read-top-to-bottom`)
+# Ensures classes read linearly from top to bottom (`@blumintinc/blumint/class-methods-read-top-to-bottom`)
 
 ⚠️ This rule _warns_ in the ✅ `recommended` config.
 
+🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
+
 <!-- end auto-generated rule header -->
 
 This rule enforces an ordering of class methods according to BluMint's code style.

package/{docs → plugin/docs}/rules/dynamic-https-errors.md

@@ -1,4 +1,4 @@
-# Dynamic elements of errors should be in the 'details' field (`@blumintinc/blumint/dynamic-https-errors`)
+# Dynamic error details should only be in the third argument of the HttpsError constructor. The second argument is hashed to produce a unique id (`@blumintinc/blumint/dynamic-https-errors`)
 
 ⚠️ This rule _warns_ in the ✅ `recommended` config.
 

package/{docs → plugin/docs}/rules/require-memo.md

@@ -1,8 +1,12 @@
-# Requires memoization of react components (`@blumintinc/blumint/require-memo`)
+# React components must be memoized (`@blumintinc/blumint/require-memo`)
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
 <!-- end auto-generated rule header -->
 
-This rule enforces that React components (that are not pure) to be memoized. If the component name includes "Unmemoized", then this rule is ignored.
+This rule enforces that React components (that are not pure) to be memoized using our custom `memo` implementation. The rule supports both absolute imports (`src/util/memo`) and relative imports (`../util/memo`) based on the file location. If the component name includes "Unmemoized", then this rule is ignored.
 
 ## Rule Details
 
@@ -17,11 +21,14 @@ const Component = ({foo, bar}) => return (
 Examples of **correct** code for this rule:
 
 ```jsx
+import { memo } from 'src/util/memo';
+
 const MemoizedComponent = memo(function BigComponent({foo, bar}) {
     return (
         <SomeOtherComponent>{foo}{bar}</SomeOtherComponent>
     )
 })
+
 const ComponentUnmemoized = ({foo, bar}) => return (
     <SomeOtherComponent>{foo}{bar}</SomeOtherComponent>
 )