Skip to content

refactor(kit): improve readability #1071

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 15, 2025
Merged

refactor(kit): improve readability #1071

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/core/src/component/component-collector.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import type { ComponentDetectionHint } from "./component-detection-hint";
import type { FunctionComponent } from "./component-semantic-node";
import * as AST from "@eslint-react/ast";
import { _ } from "@eslint-react/eff";
import { type RuleContext, SEL } from "@eslint-react/kit";
import { type RuleContext, Selector as SEL } from "@eslint-react/kit";
import { getId } from "@eslint-react/shared";
import { AST_NODE_TYPES as T } from "@typescript-eslint/types";

Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/component/component-name.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import type * as AST from "@eslint-react/ast";
import type { RuleContext } from "@eslint-react/kit";
import type { TSESTree } from "@typescript-eslint/types";
import { _ } from "@eslint-react/eff";
import { RE } from "@eslint-react/kit";
import { RegExp as RE } from "@eslint-react/kit";

import { getFunctionComponentId } from "./component-id";

Expand Down
4 changes: 2 additions & 2 deletions packages/plugins/eslint-plugin-react-debug/src/rules/jsx.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import type { RuleListener } from "@typescript-eslint/utils/ts-eslint";
import type { CamelCase } from "string-ts";
import * as ER from "@eslint-react/core";
import { flow } from "@eslint-react/eff";
import { JsxConfig, Report, type RuleContext, type RuleFeature } from "@eslint-react/kit";
import { JsxConfig, Reporter as RPT, type RuleContext, type RuleFeature } from "@eslint-react/kit";
import { AST_NODE_TYPES as T, type TSESTree } from "@typescript-eslint/types";
import { match, P } from "ts-pattern";
import { JsxEmit } from "typescript";
Expand Down Expand Up @@ -71,6 +71,6 @@ export function create(context: RuleContext<MessageID, []>): RuleListener {
} as const);
}
return {
"JSXElement, JSXFragment": flow(getReportDescriptor(context), Report.make(context).send),
"JSXElement, JSXFragment": flow(getReportDescriptor(context), RPT.make(context).send),
};
}
2 changes: 1 addition & 1 deletion packages/plugins/eslint-plugin-react-dom/src/rules/no-script-url.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import type { RuleContext, RuleFeature } from "@eslint-react/kit";
import type { RuleListener } from "@typescript-eslint/utils/ts-eslint";
import type { CamelCase } from "string-ts";
import * as ER from "@eslint-react/core";
import { RE } from "@eslint-react/kit";
import { RegExp as RE } from "@eslint-react/kit";
import { AST_NODE_TYPES as T } from "@typescript-eslint/types";

import { createRule } from "../utils";
Expand Down
4 changes: 2 additions & 2 deletions packages/plugins/eslint-plugin-react-dom/src/rules/no-unknown-property.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
import { getSettingsFromContext } from "@eslint-react/shared";
import { createRule } from "../utils";
import { compare } from "compare-versions";
import { Report } from "@eslint-react/kit";
import { Reporter as RPT } from "@eslint-react/kit";
import type { RuleContext, RuleFeature } from "@eslint-react/kit";
import type { RuleListener } from "@typescript-eslint/utils/ts-eslint";

Expand Down Expand Up @@ -1090,7 +1090,7 @@ export default createRule({
});

export function create(context: RuleContext<MessageID, unknown[]>): RuleListener {
const report = Report.make(context);
const report = RPT.make(context);
function getIgnoreConfig() {
return context.options[0]?.ignore || DEFAULTS.ignore;
}
Expand Down
2 changes: 1 addition & 1 deletion packages/plugins/eslint-plugin-react-naming-convention/src/rules/component-name.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import type { JSONSchema4 } from "@typescript-eslint/utils/json-schema";
import type { RuleListener } from "@typescript-eslint/utils/ts-eslint";
import * as AST from "@eslint-react/ast";
import * as ER from "@eslint-react/core";
import { RE } from "@eslint-react/kit";
import { RegExp as RE } from "@eslint-react/kit";

import { createRule } from "../utils";

Expand Down
2 changes: 1 addition & 1 deletion packages/plugins/eslint-plugin-react-naming-convention/src/rules/filename.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import type { RuleContext, RuleFeature } from "@eslint-react/kit";
import type { JSONSchema4 } from "@typescript-eslint/utils/json-schema";
import type { RuleListener } from "@typescript-eslint/utils/ts-eslint";
import path from "node:path";
import { RE } from "@eslint-react/kit";
import { RegExp as RE } from "@eslint-react/kit";
import { camelCase, kebabCase, pascalCase, snakeCase } from "string-ts";
import { match } from "ts-pattern";

Expand Down
4 changes: 2 additions & 2 deletions packages/plugins/eslint-plugin-react-x/src/rules/no-array-index-key.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import type { CamelCase } from "string-ts";
import * as AST from "@eslint-react/ast";
import * as ER from "@eslint-react/core";
import { _ } from "@eslint-react/eff";
import { Report, type RuleContext, type RuleFeature } from "@eslint-react/kit";
import { Reporter as RPT, type RuleContext, type RuleFeature } from "@eslint-react/kit";
import { unsafeDecodeSettings } from "@eslint-react/shared";
import { AST_NODE_TYPES as T } from "@typescript-eslint/types";
import { isMatching } from "ts-pattern";
Expand Down Expand Up @@ -109,7 +109,7 @@ export default createRule<[], MessageID>({
});

export function create(context: RuleContext<MessageID, []>): RuleListener {
const report = Report.make(context);
const report = RPT.make(context);
const indexParamNames: Array<string | _> = [];

function isArrayIndex(node: TSESTree.Node): node is TSESTree.Identifier {
Expand Down
4 changes: 2 additions & 2 deletions packages/plugins/eslint-plugin-react-x/src/rules/no-leaked-conditional-rendering.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import type { ReportDescriptor, RuleListener } from "@typescript-eslint/utils/ts
import type { CamelCase } from "string-ts";
import * as AST from "@eslint-react/ast";
import { _, flow } from "@eslint-react/eff";
import { Report, type RuleContext, type RuleFeature } from "@eslint-react/kit";
import { Reporter as RPT, type RuleContext, type RuleFeature } from "@eslint-react/kit";
import { getSettingsFromContext } from "@eslint-react/shared";
import * as VAR from "@eslint-react/var";
import { getConstrainedTypeAtLocation } from "@typescript-eslint/type-utils";
Expand Down Expand Up @@ -268,7 +268,7 @@ export function create(context: RuleContext<MessageID, []>): RuleListener {
.otherwise(() => _);
}
return {
JSXExpressionContainer: flow(getReportDescriptor, Report.make(context).send),
JSXExpressionContainer: flow(getReportDescriptor, RPT.make(context).send),
};
}

Expand Down
2 changes: 1 addition & 1 deletion packages/plugins/eslint-plugin-react-x/src/rules/no-missing-context-display-name.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import type { TSESTree } from "@typescript-eslint/types";
import type { RuleListener } from "@typescript-eslint/utils/ts-eslint";
import type { CamelCase } from "string-ts";
import * as ER from "@eslint-react/core";
import { type RuleContext, type RuleFeature, SEL } from "@eslint-react/kit";
import { type RuleContext, type RuleFeature, Selector as SEL } from "@eslint-react/kit";
import { AST_NODE_TYPES as T } from "@typescript-eslint/types";

import { createRule } from "../utils";
Expand Down
4 changes: 2 additions & 2 deletions packages/plugins/eslint-plugin-react-x/src/rules/no-missing-key.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import type { ReportDescriptor, RuleListener } from "@typescript-eslint/utils/ts
import * as AST from "@eslint-react/ast";
import * as ER from "@eslint-react/core";

import { Report, type RuleContext, type RuleFeature } from "@eslint-react/kit";
import { Reporter as RPT, type RuleContext, type RuleFeature } from "@eslint-react/kit";

import { AST_NODE_TYPES as T } from "@typescript-eslint/types";
import { match } from "ts-pattern";
Expand Down Expand Up @@ -36,7 +36,7 @@ export default createRule<[], MessageID>({
});

export function create(context: RuleContext<MessageID, []>): RuleListener {
const report = Report.make(context);
const report = RPT.make(context);
const state = { isWithinChildrenToArray: false };

function checkIteratorElement(node: TSESTree.Node): null | ReportDescriptor<MessageID> {
Expand Down
2 changes: 1 addition & 1 deletion packages/plugins/eslint-plugin-react-x/src/rules/no-unstable-default-props.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import type { CamelCase } from "string-ts";
import * as AST from "@eslint-react/ast";
import * as ER from "@eslint-react/core";
import { getOrElseUpdate } from "@eslint-react/eff";
import { SEL } from "@eslint-react/kit";
import { Selector as SEL } from "@eslint-react/kit";
import * as VAR from "@eslint-react/var";
import { AST_NODE_TYPES as T } from "@typescript-eslint/types";
import { match } from "ts-pattern";
Expand Down
2 changes: 1 addition & 1 deletion packages/shared/src/settings.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import type { SharedConfigurationSettings } from "@typescript-eslint/utils/ts-es
import type { PartialDeep } from "type-fest";
import type { CustomHooks, ESLintReactSettings } from "./schemas";
import { identity } from "@eslint-react/eff";
import { RE } from "@eslint-react/kit";
import { RegExp as RE } from "@eslint-react/kit";
import * as z from "@zod/mini";
import { shallowEqual } from "fast-equals";
import memoize from "micro-memoize";
Expand Down
4 changes: 2 additions & 2 deletions ...ocs/@eslint-react/namespaces/RE/README.md → ...@eslint-react/namespaces/RegExp/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

***

[@eslint-react/kit](../../../README.md) / RE
[@eslint-react/kit](../../../README.md) / RegExp

# RE
# RegExp

## Variables

Expand Down
2 changes: 1 addition & 1 deletion ...react/namespaces/RE/functions/isRegExp.md → ...t/namespaces/RegExp/functions/isRegExp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

***

[@eslint-react/kit](../../../../README.md) / [RE](../README.md) / isRegExp
[@eslint-react/kit](../../../../README.md) / [RegExp](../README.md) / isRegExp

# Function: isRegExp()

Expand Down
2 changes: 1 addition & 1 deletion ...react/namespaces/RE/functions/toRegExp.md → ...t/namespaces/RegExp/functions/toRegExp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

***

[@eslint-react/kit](../../../../README.md) / [RE](../README.md) / toRegExp
[@eslint-react/kit](../../../../README.md) / [RegExp](../README.md) / toRegExp

# Function: toRegExp()

Expand Down
2 changes: 1 addition & 1 deletion ...namespaces/RE/variables/ANNOTATION_JSX.md → ...spaces/RegExp/variables/ANNOTATION_JSX.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

***

[@eslint-react/kit](../../../../README.md) / [RE](../README.md) / ANNOTATION\_JSX
[@eslint-react/kit](../../../../README.md) / [RegExp](../README.md) / ANNOTATION\_JSX

# Variable: ANNOTATION\_JSX

Expand Down
2 changes: 1 addition & 1 deletion ...paces/RE/variables/ANNOTATION_JSX_FRAG.md → ...s/RegExp/variables/ANNOTATION_JSX_FRAG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

***

[@eslint-react/kit](../../../../README.md) / [RE](../README.md) / ANNOTATION\_JSX\_FRAG
[@eslint-react/kit](../../../../README.md) / [RegExp](../README.md) / ANNOTATION\_JSX\_FRAG

# Variable: ANNOTATION\_JSX\_FRAG

Expand Down
2 changes: 1 addition & 1 deletion ...variables/ANNOTATION_JSX_IMPORT_SOURCE.md → ...variables/ANNOTATION_JSX_IMPORT_SOURCE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

***

[@eslint-react/kit](../../../../README.md) / [RE](../README.md) / ANNOTATION\_JSX\_IMPORT\_SOURCE
[@eslint-react/kit](../../../../README.md) / [RegExp](../README.md) / ANNOTATION\_JSX\_IMPORT\_SOURCE

# Variable: ANNOTATION\_JSX\_IMPORT\_SOURCE

Expand Down
2 changes: 1 addition & 1 deletion ...es/RE/variables/ANNOTATION_JSX_RUNTIME.md → ...egExp/variables/ANNOTATION_JSX_RUNTIME.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

***

[@eslint-react/kit](../../../../README.md) / [RE](../README.md) / ANNOTATION\_JSX\_RUNTIME
[@eslint-react/kit](../../../../README.md) / [RegExp](../README.md) / ANNOTATION\_JSX\_RUNTIME

# Variable: ANNOTATION\_JSX\_RUNTIME

Expand Down
2 changes: 1 addition & 1 deletion ...act/namespaces/RE/variables/CAMEL_CASE.md → ...namespaces/RegExp/variables/CAMEL_CASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

***

[@eslint-react/kit](../../../../README.md) / [RE](../README.md) / CAMEL\_CASE
[@eslint-react/kit](../../../../README.md) / [RegExp](../README.md) / CAMEL\_CASE

# Variable: CAMEL\_CASE

Expand Down
2 changes: 1 addition & 1 deletion ...namespaces/RE/variables/COMPONENT_NAME.md → ...spaces/RegExp/variables/COMPONENT_NAME.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

***

[@eslint-react/kit](../../../../README.md) / [RE](../README.md) / COMPONENT\_NAME
[@eslint-react/kit](../../../../README.md) / [RegExp](../README.md) / COMPONENT\_NAME

# Variable: COMPONENT\_NAME

Expand Down
2 changes: 1 addition & 1 deletion ...aces/RE/variables/COMPONENT_NAME_LOOSE.md → .../RegExp/variables/COMPONENT_NAME_LOOSE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

***

[@eslint-react/kit](../../../../README.md) / [RE](../README.md) / COMPONENT\_NAME\_LOOSE
[@eslint-react/kit](../../../../README.md) / [RegExp](../README.md) / COMPONENT\_NAME\_LOOSE

# Variable: COMPONENT\_NAME\_LOOSE

Expand Down
2 changes: 1 addition & 1 deletion .../namespaces/RE/variables/CONSTANT_CASE.md → ...espaces/RegExp/variables/CONSTANT_CASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

***

[@eslint-react/kit](../../../../README.md) / [RE](../README.md) / CONSTANT\_CASE
[@eslint-react/kit](../../../../README.md) / [RegExp](../README.md) / CONSTANT\_CASE

# Variable: CONSTANT\_CASE

Expand Down
2 changes: 1 addition & 1 deletion ...eact/namespaces/RE/variables/HOOK_NAME.md → .../namespaces/RegExp/variables/HOOK_NAME.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

***

[@eslint-react/kit](../../../../README.md) / [RE](../README.md) / HOOK\_NAME
[@eslint-react/kit](../../../../README.md) / [RegExp](../README.md) / HOOK\_NAME

# Variable: HOOK\_NAME

Expand Down
2 changes: 1 addition & 1 deletion ...react/namespaces/RE/variables/HTML_TAG.md → ...t/namespaces/RegExp/variables/HTML_TAG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

***

[@eslint-react/kit](../../../../README.md) / [RE](../README.md) / HTML\_TAG
[@eslint-react/kit](../../../../README.md) / [RegExp](../README.md) / HTML\_TAG

# Variable: HTML\_TAG

Expand Down
2 changes: 1 addition & 1 deletion ...paces/RE/variables/JAVASCRIPT_PROTOCOL.md → ...s/RegExp/variables/JAVASCRIPT_PROTOCOL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

***

[@eslint-react/kit](../../../../README.md) / [RE](../README.md) / JAVASCRIPT\_PROTOCOL
[@eslint-react/kit](../../../../README.md) / [RegExp](../README.md) / JAVASCRIPT\_PROTOCOL

# Variable: JAVASCRIPT\_PROTOCOL

Expand Down
2 changes: 1 addition & 1 deletion ...t-react/namespaces/RE/variables/JS_EXT.md → ...act/namespaces/RegExp/variables/JS_EXT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

***

[@eslint-react/kit](../../../../README.md) / [RE](../README.md) / JS\_EXT
[@eslint-react/kit](../../../../README.md) / [RegExp](../README.md) / JS\_EXT

# Variable: JS\_EXT

Expand Down
2 changes: 1 addition & 1 deletion .../namespaces/RE/variables/JS_IDENTIFIER.md → ...espaces/RegExp/variables/JS_IDENTIFIER.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

***

[@eslint-react/kit](../../../../README.md) / [RE](../README.md) / JS\_IDENTIFIER
[@eslint-react/kit](../../../../README.md) / [RegExp](../README.md) / JS\_IDENTIFIER

# Variable: JS\_IDENTIFIER

Expand Down
2 changes: 1 addition & 1 deletion ...act/namespaces/RE/variables/KEBAB_CASE.md → ...namespaces/RegExp/variables/KEBAB_CASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

***

[@eslint-react/kit](../../../../README.md) / [RE](../README.md) / KEBAB\_CASE
[@eslint-react/kit](../../../../README.md) / [RegExp](../README.md) / KEBAB\_CASE

# Variable: KEBAB\_CASE

Expand Down
2 changes: 1 addition & 1 deletion ...ct/namespaces/RE/variables/PASCAL_CASE.md → ...amespaces/RegExp/variables/PASCAL_CASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

***

[@eslint-react/kit](../../../../README.md) / [RE](../README.md) / PASCAL\_CASE
[@eslint-react/kit](../../../../README.md) / [RegExp](../README.md) / PASCAL\_CASE

# Variable: PASCAL\_CASE

Expand Down
2 changes: 1 addition & 1 deletion ...act/namespaces/RE/variables/REGEXP_STR.md → ...namespaces/RegExp/variables/REGEXP_STR.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

***

[@eslint-react/kit](../../../../README.md) / [RE](../README.md) / REGEXP\_STR
[@eslint-react/kit](../../../../README.md) / [RegExp](../README.md) / REGEXP\_STR

# Variable: REGEXP\_STR

Expand Down
2 changes: 1 addition & 1 deletion ...act/namespaces/RE/variables/SNAKE_CASE.md → ...namespaces/RegExp/variables/SNAKE_CASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

***

[@eslint-react/kit](../../../../README.md) / [RE](../README.md) / SNAKE\_CASE
[@eslint-react/kit](../../../../README.md) / [RegExp](../README.md) / SNAKE\_CASE

# Variable: SNAKE\_CASE

Expand Down
2 changes: 1 addition & 1 deletion ...t-react/namespaces/RE/variables/TS_EXT.md → ...act/namespaces/RegExp/variables/TS_EXT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

***

[@eslint-react/kit](../../../../README.md) / [RE](../README.md) / TS\_EXT
[@eslint-react/kit](../../../../README.md) / [RegExp](../README.md) / TS\_EXT

# Variable: TS\_EXT

Expand Down
11 changes: 0 additions & 11 deletions packages/utilities/kit/docs/@eslint-react/namespaces/Report/README.md
View file
Open in desktop

This file was deleted.

Loading
Loading