@miskamyasa/eslint-config 0.0.0-stage → 2.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Denis Zaitsev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,110 @@
-# Temporary Holding Version
+# @miskamyasa/eslint-config
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Opinionated ESLint config for React + TypeScript projects.
+
+## What's included
+
+### JS/TS
+
+- ESLint recommended rules
+- TypeScript strict type checking (`typescript-eslint` recommended + strictTypeChecked + stylisticTypeChecked)
+- React rules (`@eslint-react/eslint-plugin` recommended-typescript + `react-hooks`)
+- Import ordering and validation (`eslint-plugin-import-x` + `eslint-plugin-unused-imports`)
+- Stylistic formatting (`@stylistic/eslint-plugin` with double quotes, no semicolons, 2-space indent, stroustrup brace style)
+- CommonJS overrides for `.js`/`.cjs` files
+
+### Data files (enabled by default)
+
+- JSON/JSONC/JSON5 linting (`eslint-plugin-jsonc`)
+
+## Requirements
+
+- Node.js >= 22
+- ESLint >= 9
+- TypeScript >= 5
+
+## Install
+
+```sh
+pnpm add -D @miskamyasa/eslint-config eslint typescript
+```
+
+## Usage
+
+Create `eslint.config.ts` in your project root:
+
+```ts
+import createConfig from "@miskamyasa/eslint-config"
+
+export default createConfig({
+  tsconfigRootDir: import.meta.dirname,
+})
+```
+
+> ESLint 10 requires `jiti` for TypeScript config files: `pnpm add -D jiti`
+
+## Options
+
+| Option | Type | Default | Description |
+|---|---|---|---|
+| `tsconfigRootDir` | `string` | `process.cwd()` | Root directory for TypeScript project service |
+| `ignores` | `string[]` | `[]` | Additional glob patterns to ignore |
+| `jsonc` | `boolean` | `true` | Enable JSON/JSONC/JSON5 linting |
+
+### Disabling configs
+
+```ts
+export default createConfig({
+  tsconfigRootDir: import.meta.dirname,
+  jsonc: false,
+})
+```
+
+## Overrides
+
+Pass additional ESLint config objects after the options to override or extend rules:
+
+```ts
+import createConfig from "@miskamyasa/eslint-config"
+
+export default createConfig(
+  {tsconfigRootDir: import.meta.dirname},
+  {
+    rules: {
+      "no-console": "off",
+    },
+  },
+)
+```
+
+## Named exports
+
+Individual config functions are available for advanced composition:
+
+```ts
+import {
+  typescript,
+  stylistic,
+  imports,
+  react,
+  javascript,
+  jsonc,
+} from "@miskamyasa/eslint-config"
+```
+
+## Key style decisions
+
+- Double quotes
+- No semicolons
+- 2-space indentation
+- Stroustrup brace style
+- No curly spacing (`{a}` not `{ a }`)
+- Max line length: 120 (warning)
+- Unix line endings
+- Default exports disallowed (`import-x/no-default-export`)
+- Imports sorted alphabetically with React first
+- Unused imports auto-removed
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,45 @@
+import { createTypeScriptImportResolver } from "eslint-import-resolver-typescript";
+import { Linter } from "eslint";
+declare function createImportsConfig(): Linter.Config[];
+export declare function javascript(): Linter.Config[];
+export declare function jsonc(): Linter.Config[];
+export declare function react(): Linter.Config[];
+export declare function stylistic(): Linter.Config[];
+export declare function typescript(options: {
+  tsconfigRootDir: string;
+}): Linter.Config[];
+export type ConfigItem = Linter.Config;
+export type OptionsConfig = {
+  tsconfigRootDir?: string;
+  ignores?: string[];
+  jsonc?: boolean;
+};
+/**
+ * Construct an array of ESLint flat config items.
+ *
+ * @param options - The options for generating the ESLint configurations.
+ * @param userConfigs - Additional user configurations to be appended.
+ * @returns The composed ESLint configurations.
+ *
+ * @example
+ * ```js
+ * // eslint.config.js
+ * import createConfig from "@miskamyasa/eslint-config"
+ *
+ * export default createConfig({
+ *   tsconfigRootDir: import.meta.dirname,
+ * })
+ * ```
+ */
+export declare function createConfig(options?: OptionsConfig, ...userConfigs: Linter.Config[]): Linter.Config[];
+export declare const GLOB_JS = "**/*.?([cm])js";
+export declare const GLOB_JSX = "**/*.jsx";
+export declare const GLOB_CJS = "**/*.cjs";
+export declare const GLOB_TS = "**/*.?([cm])ts";
+export declare const GLOB_TSX = "**/*.tsx";
+export declare const GLOB_SRC: string[];
+export declare const GLOB_JSON = "**/*.json";
+export declare const GLOB_JSONC = "**/*.jsonc";
+export declare const GLOB_JSON5 = "**/*.json5";
+export declare const GLOB_EXCLUDE: string[];
+export { createConfig as default, createTypeScriptImportResolver, createImportsConfig as imports };

package/dist/index.js

@@ -0,0 +1,440 @@
+import { createTypeScriptImportResolver, createTypeScriptImportResolver as createTypeScriptImportResolver$1 } from "eslint-import-resolver-typescript";
+import { flatConfigs } from "eslint-plugin-import-x";
+import unusedImports from "eslint-plugin-unused-imports";
+import jsoncPlugin from "eslint-plugin-jsonc";
+import * as jsoncParser from "jsonc-eslint-parser";
+import reactPlugin from "@eslint-react/eslint-plugin";
+import reactHooksPlugin from "eslint-plugin-react-hooks";
+import stylisticPlugin from "@stylistic/eslint-plugin";
+import { configs, parser } from "typescript-eslint";
+import eslint from "@eslint/js";
+// src/globs.ts
+const GLOB_JS = "**/*.?([cm])js";
+const GLOB_JSX = "**/*.jsx";
+const GLOB_CJS = "**/*.cjs";
+const GLOB_TS = "**/*.?([cm])ts";
+const GLOB_TSX = "**/*.tsx";
+const GLOB_SRC = [
+	GLOB_JS,
+	GLOB_JSX,
+	GLOB_TS,
+	GLOB_TSX
+];
+const GLOB_JSON = "**/*.json";
+const GLOB_JSONC = "**/*.jsonc";
+const GLOB_JSON5 = "**/*.json5";
+const GLOB_EXCLUDE = [
+	"**/node_modules",
+	"**/dist",
+	"**/package-lock.json",
+	"**/yarn.lock",
+	"**/pnpm-lock.yaml",
+	"**/bun.lockb"
+];
+// src/configs/imports.ts
+function createImportsConfig() {
+	return [
+		{
+			name: "miskamyasa/imports/setup",
+			plugins: {
+				...flatConfigs.recommended.plugins,
+				"unused-imports": unusedImports
+			}
+		},
+		{
+			name: "miskamyasa/imports/recommended-rules",
+			files: GLOB_SRC,
+			rules: flatConfigs.recommended.rules
+		},
+		{
+			name: "miskamyasa/imports/react",
+			files: GLOB_SRC,
+			settings: flatConfigs.react.settings,
+			languageOptions: flatConfigs.react.languageOptions
+		},
+		{
+			name: "miskamyasa/imports/typescript",
+			files: GLOB_SRC,
+			settings: { "import-x/resolver-next": [createTypeScriptImportResolver$1()] }
+		},
+		{
+			name: "miskamyasa/imports/rules",
+			files: GLOB_SRC,
+			rules: {
+				"import-x/namespace": "off",
+				"import-x/newline-after-import": ["error", { count: 1 }],
+				"import-x/named": "off",
+				"import-x/no-cycle": ["error", {
+					ignoreExternal: true,
+					maxDepth: 10
+				}],
+				"import-x/no-duplicates": "error",
+				"import-x/no-useless-path-segments": "error",
+				"import-x/no-anonymous-default-export": "error",
+				"import-x/no-default-export": "error",
+				"import-x/order": ["error", {
+					alphabetize: {
+						caseInsensitive: true,
+						order: "asc"
+					},
+					groups: [
+						"builtin",
+						"external",
+						"internal",
+						"parent",
+						"sibling"
+					],
+					"newlines-between": "always",
+					pathGroups: [{
+						group: "external",
+						pattern: "react+(|-native)",
+						position: "before"
+					}],
+					pathGroupsExcludedImportTypes: ["react", "react-native"]
+				}],
+				"import-x/no-absolute-path": "error",
+				"unused-imports/no-unused-imports": "error",
+				"unused-imports/no-unused-vars": ["error", {
+					vars: "all",
+					varsIgnorePattern: "^_",
+					args: "after-used",
+					argsIgnorePattern: "^_"
+				}]
+			}
+		}
+	];
+}
+// src/configs/javascript.ts
+function javascript() {
+	return [{
+		name: "miskamyasa/javascript/overrides",
+		files: ["**/*.js", GLOB_CJS],
+		languageOptions: { globals: {
+			require: "readonly",
+			module: "readonly",
+			__dirname: "readonly"
+		} },
+		rules: {
+			"@typescript-eslint/explicit-function-return-type": "off",
+			"@typescript-eslint/no-require-imports": "off",
+			"@typescript-eslint/no-var-requires": "off"
+		}
+	}];
+}
+// src/configs/jsonc.ts
+const JSON_FILES = [
+	GLOB_JSON,
+	GLOB_JSONC,
+	GLOB_JSON5
+];
+function jsonc() {
+	const preset = jsoncPlugin.configs["flat/recommended-with-jsonc"];
+	return [
+		{
+			name: "miskamyasa/jsonc/setup",
+			plugins: preset[0].plugins
+		},
+		{
+			...preset[1],
+			name: "miskamyasa/jsonc/parser-overrides"
+		},
+		{
+			name: "miskamyasa/jsonc/recommended-rules",
+			files: JSON_FILES,
+			rules: preset[2].rules
+		},
+		{
+			name: "miskamyasa/jsonc/stylistic-rules",
+			files: JSON_FILES,
+			languageOptions: { parser: jsoncParser },
+			rules: {
+				"jsonc/indent": ["error", 2],
+				"jsonc/key-spacing": "error",
+				"jsonc/array-bracket-spacing": ["error", "never"],
+				"jsonc/sort-keys": "off"
+			}
+		},
+		{
+			name: "miskamyasa/jsonc/json-rules",
+			files: [GLOB_JSON],
+			languageOptions: { parser: jsoncParser },
+			rules: { "jsonc/comma-dangle": ["error", "never"] }
+		}
+	];
+}
+// src/configs/react.ts
+function react() {
+	const preset = reactPlugin.configs["recommended-typescript"];
+	return [
+		{
+			name: "miskamyasa/react/setup",
+			plugins: {
+				...preset.plugins,
+				"react-hooks": reactHooksPlugin
+			},
+			settings: preset.settings
+		},
+		{
+			name: "miskamyasa/react/rules",
+			files: GLOB_SRC,
+			rules: preset.rules
+		},
+		{
+			name: "miskamyasa/react/hooks-rules",
+			files: GLOB_SRC,
+			rules: {
+				"react-hooks/rules-of-hooks": "error",
+				"react-hooks/exhaustive-deps": "error"
+			}
+		}
+	];
+}
+// src/configs/stylistic.ts
+const JSX_SORT_PROPS_DEPRECATION_WARNING = "[@stylistic/eslint-plugin]: You are using deprecated rule(\"jsx-sort-props\")";
+const jsxSortPropsRule = stylisticPlugin.rules["jsx-sort-props"];
+const patchedStylisticPlugin = {
+	...stylisticPlugin,
+	rules: {
+		...stylisticPlugin.rules,
+		"jsx-sort-props": {
+			...jsxSortPropsRule,
+			create(context) {
+				const warn = console.warn;
+				console.warn = (...args) => {
+					if (typeof args[0] === "string" && args[0].startsWith(JSX_SORT_PROPS_DEPRECATION_WARNING)) return;
+					warn(...args);
+				};
+				try {
+					return jsxSortPropsRule.create(context);
+				} finally {
+					console.warn = warn;
+				}
+			}
+		}
+	}
+};
+function stylistic() {
+	return [
+		{
+			name: "miskamyasa/stylistic/setup",
+			plugins: { "@stylistic": patchedStylisticPlugin }
+		},
+		{
+			name: "miskamyasa/stylistic/disable-legacy",
+			files: GLOB_SRC,
+			rules: stylisticPlugin.configs["disable-legacy"].rules
+		},
+		{
+			name: "miskamyasa/stylistic/rules",
+			files: GLOB_SRC,
+			rules: {
+				"@stylistic/block-spacing": ["error", "never"],
+				"@stylistic/comma-dangle": ["error", "always-multiline"],
+				"@stylistic/indent": ["error", 2],
+				"@stylistic/jsx-closing-bracket-location": ["error", {
+					"nonEmpty": "after-props",
+					"selfClosing": "after-props"
+				}],
+				"@stylistic/jsx-curly-spacing": ["error", {
+					"attributes": { "allowMultiline": false },
+					"children": true,
+					"when": "never"
+				}],
+				"@stylistic/jsx-first-prop-new-line": ["error", "multiline-multiprop"],
+				"@stylistic/jsx-indent-props": ["error", 2],
+				"@stylistic/jsx-max-props-per-line": ["error", { "maximum": 1 }],
+				"@stylistic/jsx-sort-props": ["error", {
+					"callbacksLast": true,
+					"ignoreCase": true,
+					"noSortAlphabetically": false,
+					"reservedFirst": true,
+					"shorthandFirst": true,
+					"shorthandLast": false
+				}],
+				"@stylistic/jsx-tag-spacing": ["error", {
+					"afterOpening": "never",
+					"beforeClosing": "allow",
+					"beforeSelfClosing": "allow",
+					"closingSlash": "never"
+				}],
+				"@stylistic/jsx-wrap-multilines": ["error", {
+					"arrow": "parens",
+					"assignment": "parens",
+					"condition": "ignore",
+					"declaration": "parens",
+					"logical": "ignore",
+					"prop": "ignore",
+					"return": "parens"
+				}],
+				"@stylistic/key-spacing": ["error", {
+					"afterColon": true,
+					"mode": "strict"
+				}],
+				"@stylistic/keyword-spacing": ["error", {
+					"after": true,
+					"before": true
+				}],
+				"@stylistic/linebreak-style": ["error", "unix"],
+				"@stylistic/max-len": ["warn", { "code": 120 }],
+				"@stylistic/no-multiple-empty-lines": ["error", {
+					"max": 1,
+					"maxEOF": 0,
+					"maxBOF": 0
+				}],
+				"no-multi-spaces": "error",
+				"@stylistic/object-curly-newline": ["error", {
+					"consistent": true,
+					"multiline": true
+				}],
+				"@stylistic/object-curly-spacing": ["error", "never"],
+				"@stylistic/object-property-newline": ["error", { "allowAllPropertiesOnSameLine": true }],
+				"@stylistic/operator-linebreak": [
+					"error",
+					"before",
+					{ "overrides": { "=": "after" } }
+				],
+				"@stylistic/quotes": [
+					"error",
+					"double",
+					{ "avoidEscape": true }
+				],
+				"@stylistic/semi": ["error", "never"],
+				"@stylistic/space-before-blocks": ["error", "always"],
+				"@stylistic/space-infix-ops": "error",
+				"@stylistic/switch-colon-spacing": ["error", {
+					"after": true,
+					"before": false
+				}],
+				"@stylistic/type-annotation-spacing": "error",
+				"@stylistic/member-delimiter-style": ["error", {
+					"multilineDetection": "brackets",
+					"multiline": {
+						"delimiter": "comma",
+						"requireLast": true
+					},
+					"singleline": {
+						"delimiter": "comma",
+						"requireLast": false
+					},
+					"overrides": { "interface": {
+						"multiline": { "delimiter": "none" },
+						"singleline": { "delimiter": "comma" }
+					} }
+				}],
+				"comma-spacing": ["error", {
+					"before": false,
+					"after": true
+				}],
+				"no-console": ["warn", { allow: ["warn", "error"] }],
+				"brace-style": [
+					"error",
+					"stroustrup",
+					{ "allowSingleLine": false }
+				],
+				"curly": ["error", "all"],
+				"no-use-before-define": "error",
+				"no-restricted-syntax": ["error", {
+					"selector": ["SwitchStatement:has(SwitchCase > BlockStatement.consequent)", "> SwitchCase:has(> *.consequent[type!='BlockStatement'])"].join(" "),
+					"message": "Switch cases must consistently use braces when any case uses braces"
+				}]
+			}
+		}
+	];
+}
+// src/configs/typescript.ts
+function typescript(options) {
+	const recommended = configs.recommended;
+	const strictTypeChecked = configs.strictTypeChecked;
+	const stylisticTypeChecked = configs.stylisticTypeChecked;
+	return [
+		{
+			name: "miskamyasa/typescript/setup",
+			plugins: recommended[0].plugins,
+			languageOptions: { parser }
+		},
+		{
+			...recommended[1],
+			name: "miskamyasa/typescript/eslint-recommended"
+		},
+		{
+			name: "miskamyasa/typescript/recommended-rules",
+			files: GLOB_SRC,
+			rules: recommended[2].rules
+		},
+		{
+			name: "miskamyasa/typescript/strict-type-checked-rules",
+			files: GLOB_SRC,
+			rules: strictTypeChecked[2].rules
+		},
+		{
+			name: "miskamyasa/typescript/stylistic-type-checked-rules",
+			files: GLOB_SRC,
+			rules: stylisticTypeChecked[2].rules
+		},
+		{
+			name: "miskamyasa/typescript/language-options",
+			files: GLOB_SRC,
+			languageOptions: { parserOptions: {
+				projectService: true,
+				tsconfigRootDir: options.tsconfigRootDir
+			} }
+		},
+		{
+			name: "miskamyasa/typescript/rules",
+			files: GLOB_SRC,
+			rules: {
+				"@typescript-eslint/consistent-type-definitions": ["error", "type"],
+				"@typescript-eslint/no-unused-vars": "off",
+				"@typescript-eslint/restrict-template-expressions": ["error", {
+					allowNumber: true,
+					allowBoolean: false,
+					allowAny: false,
+					allowNullish: false,
+					allowRegExp: false
+				}],
+				"@typescript-eslint/no-misused-promises": ["error", { checksVoidReturn: { attributes: false } }],
+				"@typescript-eslint/switch-exhaustiveness-check": ["error", { allowDefaultCaseForExhaustiveSwitch: false }]
+			}
+		}
+	];
+}
+// src/factory.ts
+/**
+* Construct an array of ESLint flat config items.
+*
+* @param options - The options for generating the ESLint configurations.
+* @param userConfigs - Additional user configurations to be appended.
+* @returns The composed ESLint configurations.
+*
+* @example
+* ```js
+* // eslint.config.js
+* import createConfig from "@miskamyasa/eslint-config"
+*
+* export default createConfig({
+*   tsconfigRootDir: import.meta.dirname,
+* })
+* ```
+*/
+function createConfig(options = {}, ...userConfigs) {
+	const { tsconfigRootDir = process.cwd(), ignores = [], jsonc: enableJsonc = true } = options;
+	return [
+		{
+			name: "miskamyasa/ignores",
+			ignores: [...GLOB_EXCLUDE, ...ignores]
+		},
+		{
+			name: "miskamyasa/eslint/recommended",
+			files: GLOB_SRC,
+			rules: eslint.configs.recommended.rules
+		},
+		...typescript({ tsconfigRootDir }),
+		...createImportsConfig(),
+		...react(),
+		...stylistic(),
+		...enableJsonc ? jsonc() : [],
+		...javascript(),
+		...userConfigs
+	];
+}
+export { GLOB_CJS, GLOB_EXCLUDE, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_SRC, GLOB_TS, GLOB_TSX, createConfig, createConfig as default, createTypeScriptImportResolver, createImportsConfig as imports, javascript, jsonc, react, stylistic, typescript };

package/package.json

@@ -1,6 +1,70 @@
 {
+  "author": "Denis <MiskaMyasa> Zaitsev",
+  "bugs": {
+    "url": "https://github.com/Miskamyasa/eslint-config/issues"
+  },
+  "dependencies": {
+    "@eslint-react/eslint-plugin": "5.28.8",
+    "@eslint/js": "10.0.1",
+    "@stylistic/eslint-plugin": "5.10.0",
+    "eslint-import-resolver-typescript": "4.4.5",
+    "eslint-plugin-import-x": "4.17.1",
+    "eslint-plugin-jsonc": "3.4.2",
+    "eslint-plugin-react-hooks": "7.1.1",
+    "eslint-plugin-unused-imports": "4.4.1",
+    "jsonc-eslint-parser": "3.3.0",
+    "typescript-eslint": "8.72.0"
+  },
+  "description": "Opinionated ESLint config for React + TypeScript projects",
+  "devDependencies": {
+    "@types/node": "26.6.5",
+    "eslint": "^10.13.0",
+    "jiti": "2.7.0",
+    "tsdown": "0.23.2",
+    "typescript": "6.0.3"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "homepage": "https://github.com/Miskamyasa/eslint-config",
+  "keywords": [
+    "eslint",
+    "eslint-config",
+    "typescript",
+    "react",
+    "stylistic"
+  ],
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
   "name": "@miskamyasa/eslint-config",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "packageManager": "pnpm@12.11.2",
+  "peerDependencies": {
+    "eslint": ">=10.0.0",
+    "typescript": ">=5.0.0 && <7.0.0"
+  },
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://github.com/Miskamyasa/eslint-config.git"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "lint": "eslint .",
+    "prepublishOnly": "pnpm run build",
+    "typecheck": "tsc --noEmit"
+  },
+  "sideEffects": false,
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "version": "2.0.1"
+}