@blumintinc/eslint-plugin-blumint 1.0.2 → 1.0.3

package/plugin/docs/rules/no-async-foreach.md

@@ -1,41 +0,0 @@
-# Disallow Array.forEach with an async callback function (`@blumintinc/blumint/no-async-foreach`)
-
-💼 This rule is enabled in the ✅ `recommended` config.
-
-<!-- end auto-generated rule header -->
-
-This rule disallows the use of `Array.forEach` callbacks with the async keyword. These are typically found when sequential promise execution is desired, but in fact these will execute almost concurrently. The use of a standard `for` loop is suggested instead, which will execute sequentially. If concurrent execution is required, `Promise.all` or `Promise.allSettled` should be used.
-
-## Rule Details
-
-This rule is aimed at ensuring that the async keyword is not used in an `Array.forEach` callback.
-
-Examples of **incorrect** code for this rule:
-
-```typescript
-['a','b','c'].forEach(async (letter) => {
-    await someAsyncFunction(letter)
-    console.log(letter)
-    })
-['foo','bar'].forEach(async function (letter) {
-    await someAsyncFunction(letter)
-    console.log(letter)
-})
-```
-
-Examples of **correct** code for this rule:
-
-```typescript
-['a','b','c'].forEach(letter) => {
-    someSyncFunction(letter)
-    console.log(letter)
-    })
-['foo','bar'].forEach(function (letter) {
-    someSyncFunction(letter)
-    console.log(letter)
-})
-for (const letter of ['a', 'b', 'c']) {             
-    someSyncFunction(letter);
-    console.log(letter); 
- }
-```

package/plugin/docs/rules/no-conditional-literals-in-jsx.md

@@ -1,27 +0,0 @@
-# Disallow use of conditional literals in JSX code (`@blumintinc/blumint/no-conditional-literals-in-jsx`)
-
-💼 This rule is enabled in the ✅ `recommended` config.
-
-<!-- end auto-generated rule header -->
-
-This rule disallows the use of conditional literals in JSX.
-
-## Rule Details
-
-Browser auto-translation will break if pieces of text nodes are be rendered conditionally.
-
-Examples of **incorrect** code for this rule:
-
-```jsx
-<div>This will cause {conditional && 'errors'}</div>
-<div><span>This will {conditional && 'also'} cause errors </span></div>
-```
-
-Examples of **correct** code for this rule:
-
-```jsx
-      <div>Foo</div>
-      <div>
-        Bar {conditional && <span>Baz</span>}
-      </div>
-```

package/plugin/docs/rules/no-filter-without-return.md

@@ -1,43 +0,0 @@
-# Disallow Array.filter callbacks without an explicit return (if part of a block statement) (`@blumintinc/blumint/no-filter-without-return`)
-
-💼 This rule is enabled in the ✅ `recommended` config.
-
-<!-- end auto-generated rule header -->
-
-This rule disallows the use of `Array.filter` callbacks that are part of a block statement but do not contain an explicit return statement. When using `Array.filter`, it's common to return a boolean value directly from a concise arrow function. However, if you're using a block statement (enclosed in `{}`), an explicit `return` statement is required.
-
-## Rule Details
-
-This rule is aimed at ensuring that there is an explicit return statement in `Array.filter` callbacks that are part of a block statement.
-
-Examples of **incorrect** code for this rule:
-
-```typescript
-['a'].filter((x) => {console.log(x)})
-['a'].filter((x) => {if (x) {
-    return true
-}
-else {}
-}
-)
-['a'].filter((x) => { if (x !== 'a') { console.log(x) } else { return true } })
-```
-
-Examples of **correct** code for this rule:
-
-```typescript
-['a'].filter((x) => !x)
-['a'].filter((x) => !!x)
-['a'].filter((x) => {
-    if (x === 'test') {
-        return true
-    }
-    else {
-        return false
-    }
-})
-['a'].filter(function (x) {
-  return true
-})
-['a'].filter((x) => x === 'a' ? true : false)
-```

package/plugin/docs/rules/no-misused-switch-case.md

@@ -1,38 +0,0 @@
-# Prevent misuse of logical OR in switch case statements (`@blumintinc/blumint/no-misused-switch-case`)
-
-💼 This rule is enabled in the ✅ `recommended` config.
-
-<!-- end auto-generated rule header -->
-
-This rule prevents the misuse of logical OR in switch case statements. Instead, cascading cases should be used. This improves code readability and understanding.
-
-## Rule Details
-
-This rule specifically targets `SwitchStatement` and issues a warning if a case uses a logical OR in its test.
-
-### Examples of incorrect code for this rule:
-
-```typescript
-switch (value) {
-  case 'a' || 'b':
-    console.log('It is a or b');
-    break;
-  default:
-    console.log('Unknown value');
-}
-```
-
-### Examples of correct code for this rule:
-
-```typescript
-switch (value) {
-  case 'a':
-  case 'b':
-    console.log('It is a or b');
-    break;
-  default:
-    console.log('Unknown value');
-}
-```
-
-In the correct example, instead of using a logical OR in the case test, cascading cases are used to capture the multiple possibilities. This is the standard way to handle multiple possibilities in a switch case and adheres to the rule.

package/plugin/docs/rules/no-unpinned-dependencies.md

@@ -1,34 +0,0 @@
-# Enforces pinned dependencies (`@blumintinc/blumint/no-unpinned-dependencies`)
-
-💼 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 -->
-
-Unpinned dependencies can cause problems, including hard to diagnose breaking changes.
-
-## Rule Details
-
-This rule aims to prevent the use of unpinned dependencies.
-
-Examples of **incorrect** code for this rule:
-
-```json
-
-{dependencies: {eslint: "^8.19.0"}}
-{dependencies: {eslint: "~8.19.0"}}
-
-```
-
-Examples of **correct** code for this rule:
-
-```json
-
-{dependencies: {eslint: "8.19.0"}}
-
-```
-
-## When Not To Use It
-
-If pinned dependencies are ok in your codebase.

package/plugin/docs/rules/no-useless-fragment.md

@@ -1,25 +0,0 @@
-# Prevent unnecessary use of React fragments (`@blumintinc/blumint/no-useless-fragment`)
-
-⚠️ 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 that React fragments (`<>...</>`) are only used when necessary. A fragment is deemed unnecessary if it wraps only a single child.
-
-## Rule Details
-
-Examples of **incorrect** code for this rule:
-
-```jsx
-<><ChildComponent /></>
-```
-
-Examples of **correct** code for this rule:
-
-```jsx
-<><ChildComponent /><AnotherChild /></>
-<><ChildComponent />Some Text<AnotherChild /></>
-```
-

package/plugin/docs/rules/prefer-fragment-shorthand.md

@@ -1,25 +0,0 @@
-# Prefer <> shorthand for <React.Fragment> (`@blumintinc/blumint/prefer-fragment-shorthand`)
-
-⚠️ 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 prefers the use of fragment shorthand, `<>` over `<React.Fragment>`
-
-## Rule Details
-
-Examples of **incorrect** code for this rule:
-
-```jsx
-<React.Fragment>Hello World</React.Fragment>
-<React.Fragment><ChildComponent /></React.Fragment>
-```
-
-Examples of **correct** code for this rule:
-
-```jsx
-<>Hello World</>
-<><ChildComponent /></>
-```

package/plugin/docs/rules/prefer-type-over-interface.md

@@ -1,25 +0,0 @@
-# Prefer using type alias over interface (`@blumintinc/blumint/prefer-type-over-interface`)
-
-⚠️ 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 prefers the use of `Type` over `Interface` in Typescript.
-
-## Rule Details
-
-Examples of **incorrect** code for this rule:
-
-```typescript
-interface SomeInterface { field: string; };
-interface AnotherInterface extends SomeInterface { otherField: number; };
-```
-
-Examples of **correct** code for this rule:
-
-```typescript
-type SomeType = { field: string; };
-type AnotherType = SomeType & { otherField: number; };
-```

package/plugin/docs/rules/require-memo.md

@@ -1,36 +0,0 @@
-# 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 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
-
-Examples of **incorrect** code for this rule:
-
-```jsx
-const Component = ({foo, bar}) => return (
-    <SomeOtherComponent>{foo}{bar}</SomeOtherComponent>
-)
-```
-
-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>
-)
-```
-