release: 1.5.31-beta.0

Rel1cx · Rel1cx · commit c79d87031a15 · 2024-07-23T01:45:58.000+08:00
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-1.5.31-next.0
+1.5.31-beta.0
diff --git a/eslint.config.d.ts b/eslint.config.d.ts
@@ -2,5 +2,4 @@ declare module "@eslint/js";
 declare module "eslint-plugin-eslint-comments";
 declare module "eslint-plugin-eslint-plugin";
 declare module "eslint-plugin-perfectionist";
-declare module "eslint-plugin-perfectionist/configs/recommended-natural";
 declare module "eslint-plugin-unicorn";
diff --git a/eslint.config.mts b/eslint.config.mts
@@ -7,7 +7,6 @@ import eslintPluginPlugin from "eslint-plugin-eslint-plugin";
 import importPlugin from "eslint-plugin-import-x";
 import jsdocPlugin from "eslint-plugin-jsdoc";
 import perfectionist from "eslint-plugin-perfectionist";
-import perfectionistNatural from "eslint-plugin-perfectionist/configs/recommended-natural";
 import simpleImportSortPlugin from "eslint-plugin-simple-import-sort";
 import unicornPlugin from "eslint-plugin-unicorn";
 import vitest from "eslint-plugin-vitest";
@@ -38,7 +37,6 @@ const config: FlatConfig[] = [
       ["eslint-plugin"]: eslintPluginPlugin,
       ["import-x"]: importPlugin,
       ["jsdoc"]: jsdocPlugin,
-      ["perfectionist"]: perfectionist,
       ["simple-import-sort"]: simpleImportSortPlugin,
       ["unicorn"]: unicornPlugin,
     },
@@ -47,7 +45,7 @@ const config: FlatConfig[] = [
   eslint.configs.recommended,
   ...tseslint.configs.strict,
   // ...tseslint.configs.strictTypeChecked,
-  perfectionistNatural,
+  perfectionist.configs["recommended-natural"],
   jsdocPlugin.configs["flat/recommended-typescript-error"],
   eslintPluginPlugin.configs["flat/all-type-checked"],
   // base config
@@ -158,7 +156,7 @@ const config: FlatConfig[] = [
         "warn",
         {
           type: "natural",
-          "custom-groups": {
+          customGroups: {
             id: ["_", "id", "key"],
             type: ["type", "kind"],
             meta: [
@@ -177,7 +175,7 @@ const config: FlatConfig[] = [
         "warn",
         {
           type: "natural",
-          "custom-groups": {
+          customGroups: {
             id: ["_", "id", "key"],
             type: ["type", "kind"],
             meta: [
@@ -190,7 +188,7 @@ const config: FlatConfig[] = [
           },
           groups: ["id", "type", "meta", "alias", "unknown"],
           order: "asc",
-          "partition-by-comment": "Part:**",
+          partitionByComment: "Part:**",
         },
       ],
       "perfectionist/sort-union-types": [
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/monorepo",
-  "version": "1.5.31-next.0",
+  "version": "1.5.31-beta.0",
   "private": true,
   "description": "A series of composable ESLint rules for libraries and frameworks that use React as a UI runtime.",
   "keywords": [
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/core",
-  "version": "1.5.31-next.0",
+  "version": "1.5.31-beta.0",
   "description": "ESLint React's ESLint utility module for static analysis of React core APIs and Patterns.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/plugins/eslint-plugin-react-debug/package.json b/packages/plugins/eslint-plugin-react-debug/package.json
@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-react-debug",
-  "version": "1.5.31-next.0",
+  "version": "1.5.31-beta.0",
   "description": "ESLint React's ESLint plugin for debugging related rules.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/plugins/eslint-plugin-react-dom/package.json b/packages/plugins/eslint-plugin-react-dom/package.json
@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-react-dom",
-  "version": "1.5.31-next.0",
+  "version": "1.5.31-beta.0",
   "description": "ESLint React's ESLint plugin for React DOM related rules.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/plugins/eslint-plugin-react-hooks-extra/package.json b/packages/plugins/eslint-plugin-react-hooks-extra/package.json
@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-react-hooks-extra",
-  "version": "1.5.31-next.0",
+  "version": "1.5.31-beta.0",
   "description": "ESLint React's ESLint plugin for React Hooks related rules.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/plugins/eslint-plugin-react-naming-convention/package.json b/packages/plugins/eslint-plugin-react-naming-convention/package.json
@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-react-naming-convention",
-  "version": "1.5.31-next.0",
+  "version": "1.5.31-beta.0",
   "description": "ESLint React's ESLint plugin for naming convention related rules.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/plugins/eslint-plugin-react-x/package.json b/packages/plugins/eslint-plugin-react-x/package.json
@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-react-x",
-  "version": "1.5.31-next.0",
+  "version": "1.5.31-beta.0",
   "description": "ESLint React's ESLint plugin for React related rules.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/plugins/eslint-plugin/package.json b/packages/plugins/eslint-plugin/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/eslint-plugin",
-  "version": "1.5.31-next.0",
+  "version": "1.5.31-beta.0",
   "description": "The main ESLint plugin of ESLint React. Contains all the rules and presets of ESLint React.",
   "keywords": [
     "eslint",
diff --git a/packages/shared/package.json b/packages/shared/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/shared",
-  "version": "1.5.31-next.0",
+  "version": "1.5.31-beta.0",
   "description": "ESLint React's Shared constants and functions.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/tools/docs/functions/asConst.md b/packages/tools/docs/functions/asConst.md
@@ -22,4 +22,6 @@ The value to infer.
 
 `T`
 
-The value with the type inferred.
+## Since
+
+0.0.1
diff --git a/packages/tools/docs/functions/entries.md b/packages/tools/docs/functions/entries.md
@@ -8,6 +8,8 @@
 
 > **entries**\<`T`\>(`value`): \{ \[K in string \| number \| symbol\]-?: \[K, T\[K\]\] \}\[keyof `T`\][]
 
+type-safe version of Object.entries
+
 ## Type Parameters
 
 • **T** *extends* [`LooseRecord`](../type-aliases/LooseRecord.md)\<`unknown`\>
@@ -22,4 +24,6 @@ The value to get the entries from.
 
 \{ \[K in string \| number \| symbol\]-?: \[K, T\[K\]\] \}\[keyof `T`\][]
 
-The entries of the value.
+## Since
+
+0.4.0
diff --git a/packages/tools/docs/functions/fromEntries.md b/packages/tools/docs/functions/fromEntries.md
@@ -8,6 +8,8 @@
 
 > **fromEntries**\<`T`\>(`entries`): [`FromEntries`](../type-aliases/FromEntries.md)\<`T`\>
 
+type-safe version of Object.fromEntries
+
 ## Type Parameters
 
 • **T** *extends* [`PropertyKey`, `unknown`][]
@@ -22,4 +24,6 @@ The entries to create the object from.
 
 [`FromEntries`](../type-aliases/FromEntries.md)\<`T`\>
 
-The object created from the entries.
+## Since
+
+0.4.0
diff --git a/packages/tools/docs/functions/keys.md b/packages/tools/docs/functions/keys.md
@@ -8,6 +8,8 @@
 
 > **keys**\<`T`\>(`value`): keyof `T`[]
 
+type-safe version of Object.keys
+
 ## Type Parameters
 
 • **T** *extends* [`LooseRecord`](../type-aliases/LooseRecord.md)\<`unknown`\>
@@ -22,4 +24,6 @@ The value to get the keys from.
 
 keyof `T`[]
 
-The keys of the value.
+## Since
+
+0.4.0
diff --git a/packages/tools/docs/functions/narrow.md b/packages/tools/docs/functions/narrow.md
@@ -8,6 +8,9 @@
 
 > **narrow**\<`TType`\>(`a`): [`Narrow`](../type-aliases/Narrow.md)\<`TType`\>
 
+Infers embedded primitive type of any type
+Same as `as const` but without setting the object as readonly and without needing the user to use it.
+
 ## Type Parameters
 
 • **TType**
@@ -22,4 +25,12 @@ Value to infer
 
 [`Narrow`](../type-aliases/Narrow.md)\<`TType`\>
 
-Value with embedded type inferred
+## Since
+
+0.0.1
+
+## Example
+
+```ts
+const result = narrow(['foo', 'bar', 1])
+```
diff --git a/packages/tools/docs/functions/values.md b/packages/tools/docs/functions/values.md
@@ -8,6 +8,8 @@
 
 > **values**\<`T`\>(`value`): `T`\[keyof `T`\][]
 
+type-safe version of Object.values
+
 ## Type Parameters
 
 • **T** *extends* [`LooseRecord`](../type-aliases/LooseRecord.md)\<`unknown`\>
@@ -22,4 +24,6 @@ The value to get the values from.
 
 `T`\[keyof `T`\][]
 
-The values of the value.
+## Since
+
+0.4.0
diff --git a/packages/tools/package.json b/packages/tools/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/tools",
-  "version": "1.5.31-next.0",
+  "version": "1.5.31-beta.0",
   "description": "ESLint React's std library and primitives.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/types/package.json b/packages/types/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/types",
-  "version": "1.5.31-next.0",
+  "version": "1.5.31-beta.0",
   "description": "ESLint React's type definitions.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/utilities/ast/package.json b/packages/utilities/ast/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/ast",
-  "version": "1.5.31-next.0",
+  "version": "1.5.31-beta.0",
   "description": "ESLint React's TSESTree AST utility module.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/utilities/jsx/package.json b/packages/utilities/jsx/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/jsx",
-  "version": "1.5.31-next.0",
+  "version": "1.5.31-beta.0",
   "description": "ESLint React's TSESTree AST utility module for static analysis of JSX.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/utilities/var/package.json b/packages/utilities/var/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/var",
-  "version": "1.5.31-next.0",
+  "version": "1.5.31-beta.0",
   "description": "TSESTree AST utility module for static analysis of variables",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/test/bundles.log b/test/bundles.log
@@ -27,16 +27,16 @@ test/bundles/utilities/var/dist/index.js 1.56 MiB
 test/bundles/utilities/var/dist/index.mjs 1.56 MiB
 
 Gzipped Bundled Size:
-test/bundles/core/test-bundle-core-1.0.0.tgz 885.41 KiB
-test/bundles/plugins/eslint-plugin-react-debug/test-bundle-eslint-plugin-react-debug-1.0.0.tgz 883.74 KiB
-test/bundles/plugins/eslint-plugin-react-dom/test-bundle-eslint-plugin-react-dom-1.0.0.tgz 885.63 KiB
-test/bundles/plugins/eslint-plugin-react-hooks-extra/test-bundle-eslint-plugin-react-hooks-extra-1.0.0.tgz 883.56 KiB
-test/bundles/plugins/eslint-plugin-react-naming-convention/test-bundle-eslint-plugin-react-naming-convention-1.0.0.tgz 890.58 KiB
+test/bundles/core/test-bundle-core-1.0.0.tgz 885.42 KiB
+test/bundles/plugins/eslint-plugin-react-debug/test-bundle-eslint-plugin-react-debug-1.0.0.tgz 883.75 KiB
+test/bundles/plugins/eslint-plugin-react-dom/test-bundle-eslint-plugin-react-dom-1.0.0.tgz 885.64 KiB
+test/bundles/plugins/eslint-plugin-react-hooks-extra/test-bundle-eslint-plugin-react-hooks-extra-1.0.0.tgz 883.57 KiB
+test/bundles/plugins/eslint-plugin-react-naming-convention/test-bundle-eslint-plugin-react-naming-convention-1.0.0.tgz 890.59 KiB
 test/bundles/plugins/eslint-plugin-react-x/test-bundle-eslint-plugin-react-x-1.0.0.tgz 3.03 MiB
 test/bundles/plugins/eslint-plugin/test-bundle-eslint-plugin-1.0.0.tgz 3.05 MiB
-test/bundles/shared/test-bundle-shared-1.0.0.tgz 824.32 KiB
+test/bundles/shared/test-bundle-shared-1.0.0.tgz 824.33 KiB
 test/bundles/tools/test-bundle-tools-1.0.0.tgz 29.92 KiB
 test/bundles/types/test-bundle-types-1.0.0.tgz 1.12 KiB
-test/bundles/utilities/ast/test-bundle-ast-1.0.0.tgz 868.76 KiB
+test/bundles/utilities/ast/test-bundle-ast-1.0.0.tgz 868.77 KiB
 test/bundles/utilities/jsx/test-bundle-jsx-1.0.0.tgz 869.74 KiB
 test/bundles/utilities/var/test-bundle-var-1.0.0.tgz 863.74 KiB

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@eslint-react/monorepo",`
`3`		`- "version": "1.5.31-next.0",`
	`3`	`+ "version": "1.5.31-beta.0",`
`4`	`4`	`"private": true,`
`5`	`5`	`"description": "A series of composable ESLint rules for libraries and frameworks that use React as a UI runtime.",`
`6`	`6`	`"keywords": [`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@eslint-react/core",`
`3`		`- "version": "1.5.31-next.0",`
	`3`	`+ "version": "1.5.31-beta.0",`
`4`	`4`	`"description": "ESLint React's ESLint utility module for static analysis of React core APIs and Patterns.",`
`5`	`5`	`"homepage": "https://github.com/rel1cx/eslint-react",`
`6`	`6`	`"bugs": {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "eslint-plugin-react-debug",`
`3`		`- "version": "1.5.31-next.0",`
	`3`	`+ "version": "1.5.31-beta.0",`
`4`	`4`	`"description": "ESLint React's ESLint plugin for debugging related rules.",`
`5`	`5`	`"homepage": "https://github.com/rel1cx/eslint-react",`
`6`	`6`	`"bugs": {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "eslint-plugin-react-dom",`
`3`		`- "version": "1.5.31-next.0",`
	`3`	`+ "version": "1.5.31-beta.0",`
`4`	`4`	`"description": "ESLint React's ESLint plugin for React DOM related rules.",`
`5`	`5`	`"homepage": "https://github.com/rel1cx/eslint-react",`
`6`	`6`	`"bugs": {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "eslint-plugin-react-hooks-extra",`
`3`		`- "version": "1.5.31-next.0",`
	`3`	`+ "version": "1.5.31-beta.0",`
`4`	`4`	`"description": "ESLint React's ESLint plugin for React Hooks related rules.",`
`5`	`5`	`"homepage": "https://github.com/rel1cx/eslint-react",`
`6`	`6`	`"bugs": {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "eslint-plugin-react-naming-convention",`
`3`		`- "version": "1.5.31-next.0",`
	`3`	`+ "version": "1.5.31-beta.0",`
`4`	`4`	`"description": "ESLint React's ESLint plugin for naming convention related rules.",`
`5`	`5`	`"homepage": "https://github.com/rel1cx/eslint-react",`
`6`	`6`	`"bugs": {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "eslint-plugin-react-x",`
`3`		`- "version": "1.5.31-next.0",`
	`3`	`+ "version": "1.5.31-beta.0",`
`4`	`4`	`"description": "ESLint React's ESLint plugin for React related rules.",`
`5`	`5`	`"homepage": "https://github.com/rel1cx/eslint-react",`
`6`	`6`	`"bugs": {`