@aryaemami59/eslint-config 0.0.5 → 0.0.7

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/disabledRules.ts","../src/globalIgnores.ts","../src/globals.ts","../src/shareableConfigs.ts","../src/utils.ts"],"mappings":";;;;;;;;;;;;;;cASa,aAAA;EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAb;cCEa,aAAA;EAAA,SAoBc,OAAA;EAAA,SAAA,IAAA;AAAA;;;;;;;;;;ADtB3B;cEEa,aAAA;EAAA;;;;;;;;;;;;;;;;;;;;;;;;;cA8BA,OAAA;EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AFhCb;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACEA;;;;;;;cEsCa,gBAAA;EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AHxCb;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACEA;;;;;;;;ACAA;;;;;;;;;;;;;;;;;;;;;;;AA8BA;;;;;;;;;;;;;;;;;;;cE+Ca,kBAAA,GACX,mBAAA,GAAqB,UAAA,QAAkB,YAAA,MACtC,MAAA"}

package/dist/index.js

@@ -1,297 +1,315 @@
-// src/disabledRules.ts
-var disabledRules = {
-  "no-undef": [0, { typeof: false }],
-  "@typescript-eslint/no-unused-vars": [
-    0,
-    {
-      args: "all",
-      argsIgnorePattern: "^_",
-      caughtErrors: "all",
-      caughtErrorsIgnorePattern: "^_",
-      destructuredArrayIgnorePattern: "^_",
-      varsIgnorePattern: "^_",
-      ignoreRestSiblings: true
-    }
-  ],
-  "@typescript-eslint/ban-ts-comment": [
-    0,
-    {
-      "ts-expect-error": "allow-with-description",
-      "ts-ignore": true,
-      "ts-nocheck": true,
-      "ts-check": false,
-      minimumDescriptionLength: 3
-    }
-  ]
-};
-
-// src/external.ts
 import js from "@eslint/js";
 import prettierConfig from "eslint-config-prettier/flat";
+import globalIdentifiers from "globals";
+import { defineConfig } from "eslint/config";
 import { config, configs, parser, plugin } from "typescript-eslint";
 
-// src/packageName.ts
-var packageName = "@aryaemami59/eslint-config";
+//#region src/disabledRules.ts
+/**
+* An object comprised of ESLint rules to disable.
+* These rules are disabled in {@linkcode flatESLintConfig}.
+*
+* @since 0.0.3
+* @public
+*/
+const disabledRules = {
+	"@typescript-eslint/ban-ts-comment": [0, {
+		minimumDescriptionLength: 3,
+		"ts-check": false,
+		"ts-expect-error": "allow-with-description",
+		"ts-ignore": true,
+		"ts-nocheck": true
+	}],
+	"@typescript-eslint/consistent-generic-constructors": [0],
+	"@typescript-eslint/no-unused-vars": [0, {
+		args: "after-used",
+		argsIgnorePattern: "^_",
+		caughtErrors: "all",
+		caughtErrorsIgnorePattern: "^_",
+		destructuredArrayIgnorePattern: "^_",
+		ignoreClassWithStaticInitBlock: false,
+		ignoreRestSiblings: false,
+		reportUsedIgnorePattern: false,
+		vars: "all",
+		varsIgnorePattern: "^_"
+	}],
+	"no-undef": [0, { typeof: false }]
+};
+
+//#endregion
+//#region src/external.ts
+const { browser, node, nodeBuiltin, vitest } = globalIdentifiers;
 
-// src/globalIgnores.ts
-var globalIgnores = {
-  name: `${packageName}/global-ignores`,
-  ignores: [
-    "**/dist/",
-    "**/build/",
-    "**/lib/",
-    "**/coverage/",
-    "**/__snapshots__/",
-    "**/temp/",
-    "**/.temp/",
-    "**/.tmp/",
-    "**/.yalc/",
-    "**/.yarn/",
-    "**/.docusaurus/",
-    "**/.next/",
-    "**/.expo/",
-    "**/*.snap"
-  ]
+//#endregion
+//#region package.json
+var name = "@aryaemami59/eslint-config";
+
+//#endregion
+//#region src/globalIgnores.ts
+/**
+* An object representing
+* {@link https://eslint.org/docs/latest/use/configure/ignore#ignoring-files | **global ignore patterns**}
+* for ESLint configuration.
+*
+* @since 0.0.3
+* @public
+*/
+const globalIgnores = {
+	ignores: [
+		"**/__snapshots__/",
+		"**/.docusaurus/",
+		"**/.expo/",
+		"**/.next/",
+		"**/.playwright/",
+		"**/.temp/",
+		"**/.tmp/",
+		"**/.turbo/",
+		"**/.wrangler/",
+		"**/.yalc/",
+		"**/.yarn/",
+		"**/*.snap",
+		"**/build/",
+		"**/coverage/",
+		"**/dist/",
+		"**/temp/"
+	],
+	name: `${name}/global-ignores`
 };
 
-// src/globals.ts
-import globalIdentifiers from "globals";
-var { browser, node, nodeBuiltin, vitest } = globalIdentifiers;
-var vitestGlobals = {
-  suite: "writable",
-  test: "writable",
-  chai: "writable",
-  describe: "writable",
-  it: "writable",
-  expectTypeOf: "writable",
-  assertType: "writable",
-  expect: "writable",
-  assert: "writable",
-  vitest: "writable",
-  vi: "writable",
-  beforeAll: "writable",
-  afterAll: "writable",
-  beforeEach: "writable",
-  afterEach: "writable",
-  onTestFailed: "writable",
-  onTestFinished: "writable"
+//#endregion
+//#region src/globals.ts
+/**
+* An object representing the
+* {@link https://vitest.dev/config/#globals | globals} provided by
+* {@link https://vitest.dev | **Vitest**} for use in testing.
+*
+* @since 0.0.3
+* @public
+*/
+const vitestGlobals = {
+	afterAll: "writable",
+	afterEach: "writable",
+	assert: "writable",
+	assertType: "writable",
+	beforeAll: "writable",
+	beforeEach: "writable",
+	chai: "writable",
+	describe: "writable",
+	expect: "writable",
+	expectTypeOf: "writable",
+	it: "writable",
+	onTestFailed: "writable",
+	onTestFinished: "writable",
+	suite: "writable",
+	test: "writable",
+	vi: "writable",
+	vitest: "writable"
 };
-var globals = /* @__PURE__ */ Object.assign(
-  {
-    ...browser,
-    ...node,
-    ...nodeBuiltin
-  },
-  {
-    ...vitest,
-    ...vitestGlobals
-  }
-);
+/**
+* An object that specifies which global
+* variables are available during linting.
+*
+* @since 0.0.3
+* @public
+*/
+const globals = /* @__PURE__ */ Object.assign({
+	...browser,
+	...node,
+	...nodeBuiltin
+}, {
+	...vitest,
+	...vitestGlobals
+});
 
-// src/shareableConfigs.ts
-var flatESLintConfig = /* @__PURE__ */ config(
-  // `ignores` must be first.
-  // config with just `ignores` is the replacement for `.eslintignore`
-  globalIgnores,
-  {
-    name: `${js.meta.name}/recommended`,
-    ...js.configs.recommended
-  },
-  configs.recommended,
-  configs.stylistic,
-  {
-    name: `${packageName}/defaults/overrides`,
-    languageOptions: {
-      globals,
-      parserOptions: {
-        ecmaVersion: "latest",
-        projectService: true
-      }
-    },
-    rules: {
-      "@typescript-eslint/consistent-type-imports": [
-        2,
-        {
-          disallowTypeAnnotations: true,
-          fixStyle: "separate-type-imports",
-          prefer: "type-imports"
-        }
-      ],
-      "@typescript-eslint/consistent-type-exports": [
-        2,
-        { fixMixedExportsWithInlineTypeSpecifier: false }
-      ],
-      "@typescript-eslint/no-explicit-any": [
-        2,
-        {
-          fixToUnknown: false,
-          ignoreRestArgs: false
-        }
-      ],
-      "@typescript-eslint/no-empty-object-type": [
-        2,
-        {
-          allowInterfaces: "never",
-          allowObjectTypes: "never"
-        }
-      ],
-      "@typescript-eslint/no-restricted-types": [
-        2,
-        {
-          types: {
-            "{}": {
-              message: `
-- If you want to represent an empty object, use \`type EmptyObject = Record<string, never>\`.
-- If you want to represent an object literal, use either \`type AnyObject = Record<string, any>\` or \`object\`.
-- If you want to represent any non-nullish value, use \`type AnyNonNullishValue = NonNullable<unknown>\`.`,
-              suggest: [
-                "AnyNonNullishValue",
-                "EmptyObject",
-                "AnyObject",
-                "object",
-                "Record<string, never>",
-                "Record<string, any>",
-                "NonNullable<unknown>"
-              ]
-            }
-          }
-        }
-      ],
-      "@typescript-eslint/no-namespace": [
-        2,
-        {
-          allowDeclarations: false,
-          allowDefinitionFiles: true
-        }
-      ],
-      "@typescript-eslint/consistent-type-definitions": [2, "type"],
-      "sort-imports": [
-        2,
-        {
-          allowSeparatedGroups: true,
-          ignoreCase: false,
-          ignoreDeclarationSort: true,
-          ignoreMemberSort: false,
-          memberSyntaxSortOrder: ["none", "all", "multiple", "single"]
-        }
-      ],
-      "@typescript-eslint/unified-signatures": [
-        2,
-        {
-          ignoreDifferentlyNamedParameters: false,
-          ignoreOverloadsWithDifferentJSDoc: false
-        }
-      ],
-      "@typescript-eslint/no-unnecessary-type-parameters": [2],
-      "@typescript-eslint/no-invalid-void-type": [
-        2,
-        {
-          allowAsThisParameter: false,
-          allowInGenericTypeArguments: true
-        }
-      ],
-      "@typescript-eslint/no-confusing-void-expression": [
-        2,
-        {
-          ignoreArrowShorthand: false,
-          ignoreVoidOperator: false,
-          ignoreVoidReturningFunctions: false
-        }
-      ],
-      "@typescript-eslint/no-duplicate-type-constituents": [
-        2,
-        {
-          ignoreIntersections: false,
-          ignoreUnions: false
-        }
-      ],
-      "@typescript-eslint/require-await": [2],
-      "@typescript-eslint/no-redundant-type-constituents": [2],
-      "@typescript-eslint/no-unnecessary-type-arguments": [2],
-      "@typescript-eslint/no-unnecessary-type-assertion": [
-        2,
-        { typesToIgnore: [] }
-      ],
-      "@typescript-eslint/prefer-nullish-coalescing": [
-        2,
-        {
-          allowRuleToRunWithoutStrictNullChecksIKnowWhatIAmDoing: false,
-          ignoreBooleanCoercion: false,
-          ignoreConditionalTests: true,
-          ignoreIfStatements: false,
-          ignoreMixedLogicalExpressions: false,
-          ignorePrimitives: {
-            bigint: false,
-            boolean: false,
-            number: false,
-            string: false
-          },
-          ignoreTernaryTests: false
-        }
-      ],
-      "@typescript-eslint/no-inferrable-types": [
-        2,
-        {
-          ignoreParameters: false,
-          ignoreProperties: false
-        }
-      ],
-      "@typescript-eslint/no-require-imports": [
-        2,
-        {
-          allow: [],
-          allowAsImport: true
-        }
-      ],
-      "object-shorthand": [
-        2,
-        "always",
-        {
-          avoidExplicitReturnArrows: true,
-          avoidQuotes: true,
-          ignoreConstructors: true,
-          methodsIgnorePattern: ""
-        }
-      ],
-      ...disabledRules
-    },
-    linterOptions: {
-      reportUnusedDisableDirectives: 2
-    }
-  },
-  {
-    name: `${packageName}/commonjs-files`,
-    files: ["**/*.cjs"],
-    languageOptions: {
-      sourceType: "commonjs"
-    },
-    rules: {
-      "@typescript-eslint/no-require-imports": [
-        0,
-        {
-          allow: [],
-          allowAsImport: false
-        }
-      ]
-    }
-  },
-  prettierConfig
-);
+//#endregion
+//#region src/shareableConfigs.ts
+/**
+* Flat ESLint configuration tailored for projects using TypeScript.
+*
+* @example
+* <caption>#### __ECMAScript Modules (ESM) usage inside a file like `eslint.config.mts` or `eslint.config.mjs`__</caption>
+*
+* ```ts
+* import { flatESLintConfig } from '@aryaemami59/eslint-config'
+*
+* export default flatESLintConfig
+* ```
+*
+* @example
+* <caption>#### __CommonJS (CJS) usage inside a file like `eslint.config.cts` or `eslint.config.cjs` (using `require`)__</caption>
+*
+* ```ts
+* const { flatESLintConfig } = require('@aryaemami59/eslint-config')
+*
+* module.exports = flatESLintConfig
+* ```
+*
+* @example
+* <caption>#### __CommonJS (CJS) usage inside a file like `eslint.config.cjs` or `eslint.config.cts` (using dynamic import)__</caption>
+*
+* ```ts
+* module.exports = (async () =>
+*   (await import('@aryaemami59/eslint-config')).flatESLintConfig)()
+* ```
+*
+* @example
+* <caption>#### __CommonJS (CJS) usage inside a file like `eslint.config.cts` (using import and export assignment)__</caption>
+*
+* ```ts
+* import eslintConfigModule = require('@aryaemami59/eslint-config')
+* import flatESLintConfig = eslintConfigModule.flatESLintConfig
+*
+* export = flatESLintConfig
+* ```
+*
+* @since 0.0.3
+* @public
+*/
+const flatESLintConfig = [
+	globalIgnores,
+	{
+		name: `${js.meta.name}/recommended`,
+		...js.configs.recommended
+	},
+	{
+		languageOptions: {
+			globals,
+			parserOptions: {
+				ecmaVersion: "latest",
+				projectService: true
+			}
+		},
+		linterOptions: {
+			reportUnusedDisableDirectives: 2,
+			reportUnusedInlineConfigs: 2
+		},
+		name: `${name}/defaults/overrides`,
+		rules: {
+			"object-shorthand": [
+				2,
+				"always",
+				{
+					avoidExplicitReturnArrows: true,
+					avoidQuotes: true,
+					ignoreConstructors: true,
+					methodsIgnorePattern: ""
+				}
+			],
+			"sort-imports": [2, {
+				allowSeparatedGroups: true,
+				ignoreCase: false,
+				ignoreDeclarationSort: true,
+				ignoreMemberSort: false,
+				memberSyntaxSortOrder: [
+					"none",
+					"all",
+					"multiple",
+					"single"
+				]
+			}],
+			...disabledRules
+		}
+	},
+	{
+		files: ["**/*.cjs"],
+		languageOptions: { sourceType: "commonjs" },
+		name: `${name}/commonjs-files`,
+		rules: { "@typescript-eslint/no-require-imports": [0, {
+			allow: [],
+			allowAsImport: false
+		}] }
+	},
+	prettierConfig
+];
 
-// src/utils.ts
-var createESLintConfig = (additionalOverrides = []) => /* @__PURE__ */ config(...flatESLintConfig, ...additionalOverrides);
-export {
-  config,
-  configs,
-  createESLintConfig,
-  disabledRules,
-  flatESLintConfig,
-  globalIgnores,
-  globals,
-  js,
-  parser,
-  plugin,
-  prettierConfig,
-  vitestGlobals
-};
+//#endregion
+//#region src/utils.ts
+/**
+* A function that returns {@linkcode flatESLintConfig}
+* along with optional additional overrides.
+* It's made mainly to provide intellisense and eliminate
+* the need for manual type annotations using JSDoc comments.
+*
+* @param [additionalOverrides=[]] - **Optional** additional overrides to apply to the configuration.
+* @returns An augmented version of the default {@linkcode flatESLintConfig}, incorporating any provided overrides.
+*
+* @example
+* <caption>#### __ECMAScript Modules (ESM) usage inside a file like `eslint.config.mts` or `eslint.config.mjs`__</caption>
+*
+* ```ts
+* import { createESLintConfig } from '@aryaemami59/eslint-config'
+*
+* export default createESLintConfig([
+*   {
+*     rules: {
+*       'no-console': [0],
+*     },
+*   },
+*   {
+*     // ...Other additional overrides
+*   },
+* ])
+* ```
+*
+* @example
+* <caption>#### __CommonJS (CJS) usage inside a file like `eslint.config.cts` or `eslint.config.cjs` (using `require`)__</caption>
+*
+* ```ts
+* const { createESLintConfig } = require('@aryaemami59/eslint-config')
+*
+* module.exports = createESLintConfig([
+*   {
+*     rules: {
+*       'no-console': [0],
+*     },
+*   },
+*   {
+*     // ...Other additional overrides
+*   },
+* ])
+* ```
+*
+* @example
+* <caption>#### __CommonJS (CJS) usage inside a file like `eslint.config.cts` or `eslint.config.cjs` (using dynamic import)__</caption>
+*
+* ```ts
+* module.exports = (async () =>
+*   (await import('@aryaemami59/eslint-config')).createESLintConfig([
+*     {
+*       rules: {
+*         'no-console': [0],
+*       },
+*     },
+*     {
+*       // ...Other additional overrides
+*     },
+*   ]))()
+* ```
+*
+* @example
+* <caption>#### __CommonJS (CJS) usage inside a file like `eslint.config.cts` (using import and export assignment)__</caption>
+*
+* ```ts
+* import eslintConfigModule = require('@aryaemami59/eslint-config')
+* import createESLintConfig = eslintConfigModule.createESLintConfig
+*
+* export = createESLintConfig([
+*   {
+*     rules: {
+*       'no-console': [0],
+*     },
+*   },
+*   {
+*     // ...Other additional overrides
+*   },
+* ])
+* ```
+*
+* @since 0.0.3
+* @public
+*/
+const createESLintConfig = (additionalOverrides = []) => /* @__PURE__ */ defineConfig(...flatESLintConfig, ...additionalOverrides);
+
+//#endregion
+export { config, configs, createESLintConfig, defineConfig, disabledRules, flatESLintConfig, globalIgnores, globals, js, parser, plugin, prettierConfig, vitestGlobals };
 //# sourceMappingURL=index.js.map