chore: [eslint-configs] remove category from JSDoc

noshiro-pf · Mar 2, 2025 · 0485829 · 0485829
1 parent ad11c32
commit 0485829
Show file tree

Hide file tree

Showing 11 changed files with 1,132 additions and 1,407 deletions.
diff --git a/packages/eslint-configs/scripts/generate-rules-type-core.mts b/packages/eslint-configs/scripts/generate-rules-type-core.mts
@@ -58,14 +58,13 @@ const metaToString = (meta: DeepReadonly<Rule['meta']>): string => {
 
   if (docs === undefined) return '';
 
-  const { description, recommended, category, url } = docs;
+  const { description, recommended, url } = docs;
 
   const keyValue: DeepReadonly<[string, boolean | string | undefined][]> = [
     ['type', type],
     ['deprecated', isDeprecated(deprecated)],
     ['fixable', fixable],
     ['hasSuggestions', hasSuggestions],
-    ['category', category],
     ['recommended', recommended],
     [
       'requiresTypeChecking',

diff --git a/packages/eslint-configs/src/configs/plugins.mts b/packages/eslint-configs/src/configs/plugins.mts
@@ -103,6 +103,7 @@ export const plugins: Record<
   'react-hooks': eslintPluginReactHooks,
   // eslint-disable-next-line total-functions/no-unsafe-type-assertion
   'react-refresh': eslintPluginReactRefresh as unknown as Plugin,
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
   'react-perf': eslintPluginReactPerf,
   // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
   security: eslintPluginSecurity,

diff --git a/packages/eslint-configs/src/plugins/total-functions/rules/unsafe-assignment-rule.mts b/packages/eslint-configs/src/plugins/total-functions/rules/unsafe-assignment-rule.mts
@@ -238,7 +238,7 @@ export const createNoUnsafeAssignmentRule =
       // TODO fix this copypasta between YieldExpression and ReturnStatement
 
       YieldExpression: (node): void => {
-        if (node.argument === undefined) {
+        if (node.argument === null) {
           return;
         }
 
@@ -257,7 +257,7 @@ export const createNoUnsafeAssignmentRule =
         const sourceType = checker.getTypeAtLocation(tsNode.expression);
 
         const arrayMethodCallSafety = isSafeAssignmentFromArrayMethod(
-          node.argument ?? undefined,
+          node.argument,
           destinationType,
           sourceType,
         );
@@ -272,7 +272,7 @@ export const createNoUnsafeAssignmentRule =
             checker,
             destinationType,
             sourceType,
-            node.argument ?? undefined,
+            node.argument,
           ) === 'unsafe'
         ) {
           context.report({

diff --git a/packages/eslint-configs/src/types/rules/eslint-cypress-rules.mts b/packages/eslint-configs/src/types/rules/eslint-cypress-rules.mts
@@ -14,12 +14,11 @@ type SpreadOptionsIfIsArray<
  * @link https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-assigning-return-values.md
  *
  *  ```md
- *  | key         | value           |
- *  | :---------- | :-------------- |
- *  | type        | problem         |
- *  | deprecated  | false           |
- *  | category    | Possible Errors |
- *  | recommended | true            |
+ *  | key         | value   |
+ *  | :---------- | :------ |
+ *  | type        | problem |
+ *  | deprecated  | false   |
+ *  | recommended | true    |
  *  ```
  */
 namespace NoAssigningReturnValues {
@@ -32,12 +31,11 @@ namespace NoAssigningReturnValues {
  * @link https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/unsafe-to-chain-command.md
  *
  *  ```md
- *  | key         | value           |
- *  | :---------- | :-------------- |
- *  | type        | problem         |
- *  | deprecated  | false           |
- *  | category    | Possible Errors |
- *  | recommended | true            |
+ *  | key         | value   |
+ *  | :---------- | :------ |
+ *  | type        | problem |
+ *  | deprecated  | false   |
+ *  | recommended | true    |
  *  ```
  */
 namespace UnsafeToChainCommand {
@@ -80,12 +78,11 @@ namespace UnsafeToChainCommand {
  * @link https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-unnecessary-waiting.md
  *
  *  ```md
- *  | key         | value           |
- *  | :---------- | :-------------- |
- *  | type        | problem         |
- *  | deprecated  | false           |
- *  | category    | Possible Errors |
- *  | recommended | true            |
+ *  | key         | value   |
+ *  | :---------- | :------ |
+ *  | type        | problem |
+ *  | deprecated  | false   |
+ *  | recommended | true    |
  *  ```
  */
 namespace NoUnnecessaryWaiting {
@@ -98,12 +95,11 @@ namespace NoUnnecessaryWaiting {
  * @link https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-async-before.md
  *
  *  ```md
- *  | key         | value           |
- *  | :---------- | :-------------- |
- *  | type        | problem         |
- *  | deprecated  | false           |
- *  | category    | Possible Errors |
- *  | recommended | true            |
+ *  | key         | value   |
+ *  | :---------- | :------ |
+ *  | type        | problem |
+ *  | deprecated  | false   |
+ *  | recommended | true    |
  *  ```
  */
 namespace NoAsyncBefore {
@@ -116,12 +112,11 @@ namespace NoAsyncBefore {
  * @link https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-async-tests.md
  *
  *  ```md
- *  | key         | value           |
- *  | :---------- | :-------------- |
- *  | type        | problem         |
- *  | deprecated  | false           |
- *  | category    | Possible Errors |
- *  | recommended | true            |
+ *  | key         | value   |
+ *  | :---------- | :------ |
+ *  | type        | problem |
+ *  | deprecated  | false   |
+ *  | recommended | true    |
  *  ```
  */
 namespace NoAsyncTests {
@@ -134,12 +129,11 @@ namespace NoAsyncTests {
  * @link https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/assertion-before-screenshot.md
  *
  *  ```md
- *  | key         | value           |
- *  | :---------- | :-------------- |
- *  | type        | problem         |
- *  | deprecated  | false           |
- *  | category    | Possible Errors |
- *  | recommended | false           |
+ *  | key         | value   |
+ *  | :---------- | :------ |
+ *  | type        | problem |
+ *  | deprecated  | false   |
+ *  | recommended | false   |
  *  ```
  */
 namespace AssertionBeforeScreenshot {
@@ -152,12 +146,11 @@ namespace AssertionBeforeScreenshot {
  * @link https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/require-data-selectors.md
  *
  *  ```md
- *  | key         | value           |
- *  | :---------- | :-------------- |
- *  | type        | suggestion      |
- *  | deprecated  | false           |
- *  | category    | Possible Errors |
- *  | recommended | false           |
+ *  | key         | value      |
+ *  | :---------- | :--------- |
+ *  | type        | suggestion |
+ *  | deprecated  | false      |
+ *  | recommended | false      |
  *  ```
  */
 namespace RequireDataSelectors {
@@ -170,12 +163,11 @@ namespace RequireDataSelectors {
  * @link https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-force.md
  *
  *  ```md
- *  | key         | value           |
- *  | :---------- | :-------------- |
- *  | type        | suggestion      |
- *  | deprecated  | false           |
- *  | category    | Possible Errors |
- *  | recommended | false           |
+ *  | key         | value      |
+ *  | :---------- | :--------- |
+ *  | type        | suggestion |
+ *  | deprecated  | false      |
+ *  | recommended | false      |
  *  ```
  */
 namespace NoForce {
@@ -188,12 +180,11 @@ namespace NoForce {
  * @link https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-pause.md
  *
  *  ```md
- *  | key         | value           |
- *  | :---------- | :-------------- |
- *  | type        | suggestion      |
- *  | deprecated  | false           |
- *  | category    | Possible Errors |
- *  | recommended | false           |
+ *  | key         | value      |
+ *  | :---------- | :--------- |
+ *  | type        | suggestion |
+ *  | deprecated  | false      |
+ *  | recommended | false      |
  *  ```
  */
 namespace NoPause {
@@ -206,12 +197,11 @@ namespace NoPause {
  * @link https://github.com/cypress-io/eslint-plugin-cypress/blob/master/docs/rules/no-debug.md
  *
  *  ```md
- *  | key         | value           |
- *  | :---------- | :-------------- |
- *  | type        | suggestion      |
- *  | deprecated  | false           |
- *  | category    | Possible Errors |
- *  | recommended | false           |
+ *  | key         | value      |
+ *  | :---------- | :--------- |
+ *  | type        | suggestion |
+ *  | deprecated  | false      |
+ *  | recommended | false      |
  *  ```
  */
 namespace NoDebug {