@xsynaptic/eslint-config 3.3.1 → 3.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Alexander Synaptic
+
+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

@@ -0,0 +1,3 @@
+# ESLint Config
+
+This is a shared ESLint config for use with several Astro projects. It is not intended for public consumption.

package/dist/index.d.mts

@@ -1,9 +1,11 @@
-import { Config, ConfigWithExtendsArray } from "@eslint/config-helpers";
+import { Config, ConfigWithExtends, ConfigWithExtendsArray } from "@eslint/config-helpers";
 
 //#region src/index.d.ts
+declare function getWebComponentConfig(files: Array<string>): ConfigWithExtends;
 declare function getConfig(customConfig?: ConfigWithExtendsArray, options?: {
-  customGlobals?: Record<string, "readonly" | "writeable">;
-  parserOptions?: NonNullable<Config["languageOptions"]>["parserOptions"];
+  customGlobals?: Record<string, 'readonly' | 'writeable'>;
+  parserOptions?: NonNullable<Config['languageOptions']>['parserOptions'];
 }): ConfigWithExtendsArray;
 //#endregion
-export { getConfig };
+export { getConfig, getWebComponentConfig };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -1 +1,99 @@
-import{defineConfig as e}from"@eslint/config-helpers";import t from"@eslint/js";import n from"eslint-plugin-perfectionist";import r from"eslint-plugin-unicorn";import i from"globals";import a from"typescript-eslint";function o(o,s){let c=s?.customGlobals??{};return e(t.configs.recommended,...a.configs.strictTypeChecked,...a.configs.stylisticTypeChecked,{languageOptions:{globals:{...i.builtin,...i.nodeBuiltin,...c},parser:a.parser,parserOptions:s?.parserOptions??{projectService:!0}},plugins:{"@typescript-eslint":a.plugin},rules:{"@typescript-eslint/array-type":[`warn`,{default:`generic`}],"@typescript-eslint/no-non-null-assertion":`off`,"@typescript-eslint/no-unused-vars":[`error`,{argsIgnorePattern:`^_`,caughtErrorsIgnorePattern:`^_`,destructuredArrayIgnorePattern:`^_`,ignoreRestSiblings:!0,varsIgnorePattern:`^_`}],"@typescript-eslint/consistent-type-imports":[`error`,{fixStyle:`separate-type-imports`,prefer:`type-imports`}],"@typescript-eslint/prefer-nullish-coalescing":`off`,"no-restricted-syntax":[`error`,{message:"Separate type imports into their own `import type` statement.",selector:`ImportDeclaration[importKind="value"] ImportSpecifier[importKind="type"]`}]}},r.configs.recommended,{rules:{"unicorn/filename-case":`warn`,"unicorn/no-array-callback-reference":`off`,"unicorn/prevent-abbreviations":`off`}},{plugins:{perfectionist:n},rules:{"perfectionist/sort-classes":`off`,"perfectionist/sort-imports":[`error`,{type:`natural`,order:`asc`,internalPattern:[`^~/.*`,`^@/.*`,`^#.*`]}],"perfectionist/sort-interfaces":`off`,"perfectionist/sort-jsx-props":`off`,"perfectionist/sort-maps":`off`,"perfectionist/sort-modules":`off`,"perfectionist/sort-objects":`off`,"perfectionist/sort-object-types":`off`,"perfectionist/sort-sets":`off`,"perfectionist/sort-switch-case":`off`,"perfectionist/sort-union-types":`off`}},...o??[])}export{o as getConfig};
+import { defineConfig } from "@eslint/config-helpers";
+import eslint from "@eslint/js";
+import perfectionist from "eslint-plugin-perfectionist";
+import unicornPlugin from "eslint-plugin-unicorn";
+import { configs } from "eslint-plugin-wc";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+//#region src/index.ts
+function getWebComponentConfig(files) {
+	const bestPractice = configs["flat/best-practice"];
+	return {
+		...bestPractice,
+		files,
+		rules: {
+			...bestPractice?.rules,
+			"wc/define-tag-after-class-definition": "error",
+			"wc/guard-define-call": "error",
+			"wc/max-elements-per-file": "error",
+			"wc/no-child-traversal-in-connectedcallback": "off",
+			"wc/no-constructor": "error",
+			"wc/no-exports-with-element": "error",
+			"wc/no-method-prefixed-with-on": "error"
+		}
+	};
+}
+function getConfig(customConfig, options) {
+	const customGlobals = options?.customGlobals ?? {};
+	return defineConfig(...[
+		eslint.configs.recommended,
+		...tseslint.configs.strictTypeChecked,
+		...tseslint.configs.stylisticTypeChecked,
+		{
+			languageOptions: {
+				globals: {
+					...globals.builtin,
+					...globals.nodeBuiltin,
+					...customGlobals
+				},
+				parser: tseslint.parser,
+				parserOptions: options?.parserOptions ?? { projectService: true }
+			},
+			plugins: { "@typescript-eslint": tseslint.plugin },
+			rules: {
+				"@typescript-eslint/array-type": ["warn", { default: "generic" }],
+				"@typescript-eslint/no-non-null-assertion": "off",
+				"@typescript-eslint/no-unused-vars": ["error", {
+					argsIgnorePattern: "^_",
+					caughtErrorsIgnorePattern: "^_",
+					destructuredArrayIgnorePattern: "^_",
+					ignoreRestSiblings: true,
+					varsIgnorePattern: "^_"
+				}],
+				"@typescript-eslint/consistent-type-imports": ["error", {
+					fixStyle: "separate-type-imports",
+					prefer: "type-imports"
+				}],
+				"@typescript-eslint/prefer-nullish-coalescing": "off",
+				"no-restricted-syntax": ["error", {
+					message: "Separate type imports into their own `import type` statement.",
+					selector: "ImportDeclaration[importKind=\"value\"] ImportSpecifier[importKind=\"type\"]"
+				}]
+			}
+		},
+		unicornPlugin.configs.recommended,
+		{ rules: {
+			"unicorn/filename-case": "warn",
+			"unicorn/no-array-callback-reference": "off",
+			"unicorn/prevent-abbreviations": "off"
+		} },
+		{
+			plugins: { perfectionist },
+			rules: {
+				"perfectionist/sort-classes": "off",
+				"perfectionist/sort-imports": ["error", {
+					type: "natural",
+					order: "asc",
+					internalPattern: [
+						"^~/.*",
+						"^@/.*",
+						"^#.*"
+					]
+				}],
+				"perfectionist/sort-interfaces": "off",
+				"perfectionist/sort-jsx-props": "off",
+				"perfectionist/sort-maps": "off",
+				"perfectionist/sort-modules": "off",
+				"perfectionist/sort-objects": "off",
+				"perfectionist/sort-object-types": "off",
+				"perfectionist/sort-sets": "off",
+				"perfectionist/sort-switch-case": "off",
+				"perfectionist/sort-union-types": "off"
+			}
+		}
+	], ...customConfig ?? []);
+}
+//#endregion
+export { getConfig, getWebComponentConfig };
+
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":["webComponentConfigs"],"sources":["../src/index.ts"],"sourcesContent":["import type { Config, ConfigWithExtends, ConfigWithExtendsArray } from '@eslint/config-helpers';\n\nimport { defineConfig } from '@eslint/config-helpers';\nimport eslint from '@eslint/js';\nimport perfectionist from 'eslint-plugin-perfectionist';\nimport unicornPlugin from 'eslint-plugin-unicorn';\nimport { configs as webComponentConfigs } from 'eslint-plugin-wc';\nimport globals from 'globals';\nimport tseslint from 'typescript-eslint';\n\n// Opt-in rules for authoring native web components\nexport function getWebComponentConfig(files: Array<string>): ConfigWithExtends {\n\tconst bestPractice = webComponentConfigs['flat/best-practice'];\n\n\treturn {\n\t\t...bestPractice,\n\t\tfiles,\n\t\trules: {\n\t\t\t...bestPractice?.rules,\n\t\t\t'wc/define-tag-after-class-definition': 'error',\n\t\t\t'wc/guard-define-call': 'error',\n\t\t\t'wc/max-elements-per-file': 'error',\n\t\t\t'wc/no-child-traversal-in-connectedcallback': 'off',\n\t\t\t'wc/no-constructor': 'error',\n\t\t\t'wc/no-exports-with-element': 'error',\n\t\t\t'wc/no-method-prefixed-with-on': 'error',\n\t\t},\n\t};\n}\n\nexport function getConfig(\n\tcustomConfig?: ConfigWithExtendsArray,\n\toptions?: {\n\t\tcustomGlobals?: Record<string, 'readonly' | 'writeable'>;\n\t\tparserOptions?: NonNullable<Config['languageOptions']>['parserOptions'];\n\t},\n): ConfigWithExtendsArray {\n\tconst customGlobals = options?.customGlobals ?? {};\n\n\tconst baseConfig = [\n\t\teslint.configs.recommended,\n\t\t...tseslint.configs.strictTypeChecked,\n\t\t...tseslint.configs.stylisticTypeChecked,\n\t\t{\n\t\t\tlanguageOptions: {\n\t\t\t\tglobals: {\n\t\t\t\t\t...globals.builtin,\n\t\t\t\t\t...globals.nodeBuiltin,\n\t\t\t\t\t...customGlobals,\n\t\t\t\t},\n\t\t\t\tparser: tseslint.parser,\n\t\t\t\tparserOptions: options?.parserOptions ?? {\n\t\t\t\t\tprojectService: true,\n\t\t\t\t},\n\t\t\t},\n\t\t\tplugins: {\n\t\t\t\t'@typescript-eslint': tseslint.plugin,\n\t\t\t},\n\t\t\trules: {\n\t\t\t\t'@typescript-eslint/array-type': ['warn', { default: 'generic' }],\n\t\t\t\t'@typescript-eslint/no-non-null-assertion': 'off',\n\t\t\t\t'@typescript-eslint/no-unused-vars': [\n\t\t\t\t\t'error',\n\t\t\t\t\t{\n\t\t\t\t\t\targsIgnorePattern: '^_',\n\t\t\t\t\t\tcaughtErrorsIgnorePattern: '^_',\n\t\t\t\t\t\tdestructuredArrayIgnorePattern: '^_',\n\t\t\t\t\t\tignoreRestSiblings: true,\n\t\t\t\t\t\tvarsIgnorePattern: '^_',\n\t\t\t\t\t},\n\t\t\t\t],\n\t\t\t\t'@typescript-eslint/consistent-type-imports': [\n\t\t\t\t\t'error',\n\t\t\t\t\t{ fixStyle: 'separate-type-imports', prefer: 'type-imports' },\n\t\t\t\t],\n\t\t\t\t'@typescript-eslint/prefer-nullish-coalescing': 'off',\n\t\t\t\t'no-restricted-syntax': [\n\t\t\t\t\t'error',\n\t\t\t\t\t{\n\t\t\t\t\t\tmessage: 'Separate type imports into their own `import type` statement.',\n\t\t\t\t\t\tselector: 'ImportDeclaration[importKind=\"value\"] ImportSpecifier[importKind=\"type\"]',\n\t\t\t\t\t},\n\t\t\t\t],\n\t\t\t},\n\t\t},\n\t\tunicornPlugin.configs.recommended,\n\t\t{\n\t\t\trules: {\n\t\t\t\t'unicorn/filename-case': 'warn',\n\t\t\t\t'unicorn/no-array-callback-reference': 'off', // I prefer this pattern for filtering/sorting content\n\t\t\t\t'unicorn/prevent-abbreviations': 'off', // I *like* abbreviations!\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tplugins: {\n\t\t\t\tperfectionist,\n\t\t\t},\n\t\t\trules: {\n\t\t\t\t'perfectionist/sort-classes': 'off',\n\t\t\t\t'perfectionist/sort-imports': [\n\t\t\t\t\t'error',\n\t\t\t\t\t{\n\t\t\t\t\t\ttype: 'natural',\n\t\t\t\t\t\torder: 'asc',\n\t\t\t\t\t\tinternalPattern: ['^~/.*', '^@/.*', '^#.*'],\n\t\t\t\t\t},\n\t\t\t\t],\n\t\t\t\t'perfectionist/sort-interfaces': 'off',\n\t\t\t\t'perfectionist/sort-jsx-props': 'off',\n\t\t\t\t'perfectionist/sort-maps': 'off',\n\t\t\t\t'perfectionist/sort-modules': 'off',\n\t\t\t\t'perfectionist/sort-objects': 'off',\n\t\t\t\t'perfectionist/sort-object-types': 'off',\n\t\t\t\t'perfectionist/sort-sets': 'off',\n\t\t\t\t'perfectionist/sort-switch-case': 'off',\n\t\t\t\t'perfectionist/sort-union-types': 'off',\n\t\t\t},\n\t\t},\n\t] satisfies Array<ConfigWithExtends>;\n\n\treturn defineConfig(...baseConfig, ...(customConfig ?? []));\n}\n"],"mappings":";;;;;;;;AAWA,SAAgB,sBAAsB,OAAyC;CAC9E,MAAM,eAAeA,QAAoB;CAEzC,OAAO;EACN,GAAG;EACH;EACA,OAAO;GACN,GAAG,cAAc;GACjB,wCAAwC;GACxC,wBAAwB;GACxB,4BAA4B;GAC5B,8CAA8C;GAC9C,qBAAqB;GACrB,8BAA8B;GAC9B,iCAAiC;EAClC;CACD;AACD;AAEA,SAAgB,UACf,cACA,SAIyB;CACzB,MAAM,gBAAgB,SAAS,iBAAiB,CAAC;CAmFjD,OAAO,aAAa,GAAG;EAhFtB,OAAO,QAAQ;EACf,GAAG,SAAS,QAAQ;EACpB,GAAG,SAAS,QAAQ;EACpB;GACC,iBAAiB;IAChB,SAAS;KACR,GAAG,QAAQ;KACX,GAAG,QAAQ;KACX,GAAG;IACJ;IACA,QAAQ,SAAS;IACjB,eAAe,SAAS,iBAAiB,EACxC,gBAAgB,KACjB;GACD;GACA,SAAS,EACR,sBAAsB,SAAS,OAChC;GACA,OAAO;IACN,iCAAiC,CAAC,QAAQ,EAAE,SAAS,UAAU,CAAC;IAChE,4CAA4C;IAC5C,qCAAqC,CACpC,SACA;KACC,mBAAmB;KACnB,2BAA2B;KAC3B,gCAAgC;KAChC,oBAAoB;KACpB,mBAAmB;IACpB,CACD;IACA,8CAA8C,CAC7C,SACA;KAAE,UAAU;KAAyB,QAAQ;IAAe,CAC7D;IACA,gDAAgD;IAChD,wBAAwB,CACvB,SACA;KACC,SAAS;KACT,UAAU;IACX,CACD;GACD;EACD;EACA,cAAc,QAAQ;EACtB,EACC,OAAO;GACN,yBAAyB;GACzB,uCAAuC;GACvC,iCAAiC;EAClC,EACD;EACA;GACC,SAAS,EACR,cACD;GACA,OAAO;IACN,8BAA8B;IAC9B,8BAA8B,CAC7B,SACA;KACC,MAAM;KACN,OAAO;KACP,iBAAiB;MAAC;MAAS;MAAS;KAAM;IAC3C,CACD;IACA,iCAAiC;IACjC,gCAAgC;IAChC,2BAA2B;IAC3B,8BAA8B;IAC9B,8BAA8B;IAC9B,mCAAmC;IACnC,2BAA2B;IAC3B,kCAAkC;IAClC,kCAAkC;GACnC;EACD;CAG+B,GAAG,GAAI,gBAAgB,CAAC,CAAE;AAC3D"}

package/package.json

@@ -1,41 +1,48 @@
 {
-	"name": "@xsynaptic/eslint-config",
-	"version": "3.3.1",
-	"description": "A common ESLint config factory for TypeScript projects",
-	"type": "module",
-	"license": "MIT",
-	"main": "./dist/index.mjs",
-	"exports": {
-		".": {
-			"types": "./dist/index.d.mts",
-			"import": "./dist/index.mjs"
-		}
-	},
-	"files": [
-		"dist",
-		"src"
-	],
-	"scripts": {
-		"build": "tsdown",
-		"build-tsc": "tsc --build",
-		"prepublishOnly": "pnpm build",
-		"check": "prettier --check . && tsc --noEmit && eslint",
-		"format": "prettier --write . && tsc --noEmit && eslint --fix"
-	},
-	"dependencies": {
-		"@eslint/config-helpers": "^0.5.5",
-		"@eslint/js": "^9.39.4",
-		"eslint-plugin-perfectionist": "^5.9.0",
-		"eslint-plugin-unicorn": "^64.0.0",
-		"globals": "^17.6.0",
-		"typescript-eslint": "^8.59.1"
-	},
-	"devDependencies": {
-		"eslint": "^9.39.4",
-		"jiti": "^2.6.1",
-		"prettier": "^3.8.3",
-		"tsdown": "^0.21.10",
-		"typescript": "^6.0.3"
-	},
-	"packageManager": "pnpm@10.25.0+sha512.5e82639027af37cf832061bcc6d639c219634488e0f2baebe785028a793de7b525ffcd3f7ff574f5e9860654e098fe852ba8ac5dd5cefe1767d23a020a92f501"
-}
+  "name": "@xsynaptic/eslint-config",
+  "version": "3.4.0",
+  "description": "An ESLint config factory for TypeScript projects",
+  "type": "module",
+  "license": "MIT",
+  "author": "Alexander Synaptic <x@synapticism.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/xsynaptic/astro-lab.git",
+    "directory": "packages/eslint-config"
+  },
+  "homepage": "https://github.com/xsynaptic/astro-lab/tree/main/packages/eslint-config#readme",
+  "bugs": {
+    "url": "https://github.com/xsynaptic/astro-lab/issues"
+  },
+  "keywords": [
+    "eslint",
+    "eslint-config",
+    "typescript"
+  ],
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "dependencies": {
+    "@eslint/config-helpers": "^0.6.0",
+    "@eslint/js": "^9.39.4",
+    "eslint-plugin-perfectionist": "^5.9.0",
+    "eslint-plugin-unicorn": "^64.0.0",
+    "eslint-plugin-wc": "^3.1.0",
+    "globals": "^17.6.0",
+    "typescript-eslint": "^8.59.3"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "check-types": "tsc --noEmit"
+  }
+}

package/readme.md

@@ -1,3 +0,0 @@
-# ESLint Config
-
-This is a shared ESLint config for use with several TypeScript projects. It is not intended for public consumption.

package/src/index.ts

@@ -1,101 +0,0 @@
-import type { Config, ConfigWithExtends, ConfigWithExtendsArray } from "@eslint/config-helpers";
-
-import { defineConfig } from "@eslint/config-helpers";
-import eslint from "@eslint/js";
-import perfectionist from "eslint-plugin-perfectionist";
-import unicornPlugin from "eslint-plugin-unicorn";
-import globals from "globals";
-import tseslint from "typescript-eslint";
-
-export function getConfig(
-	customConfig?: ConfigWithExtendsArray,
-	options?: {
-		customGlobals?: Record<string, "readonly" | "writeable">;
-		parserOptions?: NonNullable<Config["languageOptions"]>["parserOptions"];
-	},
-): ConfigWithExtendsArray {
-	const customGlobals = options?.customGlobals ?? {};
-
-	const baseConfig = [
-		eslint.configs.recommended,
-		...tseslint.configs.strictTypeChecked,
-		...tseslint.configs.stylisticTypeChecked,
-		{
-			languageOptions: {
-				globals: {
-					...globals.builtin,
-					...globals.nodeBuiltin,
-					...customGlobals,
-				},
-				parser: tseslint.parser,
-				parserOptions: options?.parserOptions ?? {
-					projectService: true,
-				},
-			},
-			plugins: {
-				"@typescript-eslint": tseslint.plugin,
-			},
-			rules: {
-				"@typescript-eslint/array-type": ["warn", { default: "generic" }],
-				"@typescript-eslint/no-non-null-assertion": "off",
-				"@typescript-eslint/no-unused-vars": [
-					"error",
-					{
-						argsIgnorePattern: "^_",
-						caughtErrorsIgnorePattern: "^_",
-						destructuredArrayIgnorePattern: "^_",
-						ignoreRestSiblings: true,
-						varsIgnorePattern: "^_",
-					},
-				],
-				"@typescript-eslint/consistent-type-imports": [
-					"error",
-					{ fixStyle: "separate-type-imports", prefer: "type-imports" },
-				],
-				"@typescript-eslint/prefer-nullish-coalescing": "off",
-				"no-restricted-syntax": [
-					"error",
-					{
-						message: "Separate type imports into their own `import type` statement.",
-						selector: 'ImportDeclaration[importKind="value"] ImportSpecifier[importKind="type"]',
-					},
-				],
-			},
-		},
-		unicornPlugin.configs.recommended,
-		{
-			rules: {
-				"unicorn/filename-case": "warn",
-				"unicorn/no-array-callback-reference": "off", // I prefer this pattern for filtering/sorting content
-				"unicorn/prevent-abbreviations": "off", // I *like* abbreviations!
-			},
-		},
-		{
-			plugins: {
-				perfectionist,
-			},
-			rules: {
-				"perfectionist/sort-classes": "off",
-				"perfectionist/sort-imports": [
-					"error",
-					{
-						type: "natural",
-						order: "asc",
-						internalPattern: ["^~/.*", "^@/.*", "^#.*"],
-					},
-				],
-				"perfectionist/sort-interfaces": "off",
-				"perfectionist/sort-jsx-props": "off",
-				"perfectionist/sort-maps": "off",
-				"perfectionist/sort-modules": "off",
-				"perfectionist/sort-objects": "off",
-				"perfectionist/sort-object-types": "off",
-				"perfectionist/sort-sets": "off",
-				"perfectionist/sort-switch-case": "off",
-				"perfectionist/sort-union-types": "off",
-			},
-		},
-	] satisfies Array<ConfigWithExtends>;
-
-	return defineConfig(...baseConfig, ...(customConfig ?? []));
-}