@aryaemami59/eslint-config 0.0.4 → 0.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aryaemami59/eslint-config",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "ESLint configuration for TypeScript projects",
   "keywords": [
     "eslint",
@@ -55,34 +55,44 @@
     "src"
   ],
   "scripts": {
-    "build": "yarn clean && tsup",
-    "check-exports": "attw --pack",
-    "check-package-json": "publint --strict .",
-    "clean": "rimraf dist",
-    "prepack": "yarn build"
+    "build": "yarn run clean && tsdown --config-loader='unrun' --config=\"${INIT_CWD}/tsdown.config.mts\"",
+    "check-exports": "attw --pack ${INIT_CWD}",
+    "check-package-json": "publint --strict ${INIT_CWD}",
+    "clean": "rimraf ${INIT_CWD}/dist/ ${INIT_CWD}/.rolldown/",
+    "format-check": "yarn run -T format-check",
+    "format": "yarn run -T format",
+    "lint-fix": "yarn run -T lint-fix",
+    "lint": "yarn run -T lint",
+    "prepack": "yarn run build",
+    "typecheck": "tsc -p ${INIT_CWD}/tsconfig.json"
   },
   "dependencies": {
-    "@eslint/js": "^9.15.0",
-    "@typescript-eslint/utils": "^8.14.0",
-    "eslint-config-prettier": "^9.1.0",
-    "globals": "^15.12.0",
-    "typescript-eslint": "^8.14.0"
+    "@eslint/js": "^10",
+    "@typescript-eslint/utils": "^8.54.0",
+    "eslint-config-prettier": "^10.1.8",
+    "globals": "^17.3.0",
+    "typescript-eslint": "^8.54.0"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.17.0",
-    "@aryaemami59/tsconfig": "^0.0.4",
-    "@types/eslint-config-prettier": "^6.11.3",
-    "eslint": "^9.15.0",
-    "publint": "^0.2.12",
-    "rimraf": "^6.0.1",
-    "tsup": "^8.3.5",
-    "typescript": "^5.6.3"
+    "@arethetypeswrong/cli": "^0.18.2",
+    "@aryaemami59/tsconfig": "workspace:^",
+    "@eslint/core": "^1.1.0",
+    "@types/node": "^25.2.1",
+    "eslint": "^10.0.0",
+    "publint": "^0.3.17",
+    "rimraf": "^6.1.2",
+    "tsdown": "^0.20.3",
+    "typescript": "^5.9.3"
   },
   "peerDependencies": {
-    "eslint": ">=8.56.0",
+    "@eslint/core": "*",
+    "eslint": ">=9",
     "typescript": "*"
   },
   "peerDependenciesMeta": {
+    "@eslint/core": {
+      "optional": true
+    },
     "eslint": {
       "optional": true
     },
@@ -93,5 +103,8 @@
   "publishConfig": {
     "access": "public",
     "provenance": true
+  },
+  "optionalDependencies": {
+    "@eslint/core": "*"
   }
-}
+}

package/src/disabledRules.ts

@@ -0,0 +1,56 @@
+import type { Linter } from 'eslint'
+
+/**
+ * An object comprised of ESLint rules to disable.
+ * These rules are disabled in {@linkcode flatESLintConfig}.
+ *
+ * @since 0.0.3
+ * @public
+ */
+export 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,
+    },
+  ],
+
+  // TODO: Remove this once https://github.com/typescript-eslint/typescript-eslint/issues/11952 is resolved.
+  '@typescript-eslint/consistent-generic-constructors': [0],
+
+  '@typescript-eslint/no-unused-vars': [
+    0,
+    {
+      args: 'after-used',
+      // Not included in default options
+      argsIgnorePattern: '^_',
+      caughtErrors: 'all',
+      // Not included in default options
+      caughtErrorsIgnorePattern: '^_',
+      // Not included in default options
+      destructuredArrayIgnorePattern: '^_',
+      ignoreClassWithStaticInitBlock: false,
+      ignoreRestSiblings: false,
+      reportUsedIgnorePattern: false,
+      vars: 'all',
+      // Not included in default options
+      varsIgnorePattern: '^_',
+    },
+  ],
+  'no-undef': [
+    0,
+    {
+      typeof: false,
+    },
+  ],
+} as const satisfies Linter.RulesRecord satisfies Record<
+  keyof Linter.RulesRecord,
+  [
+    ruleSeverity: Extract<Linter.Severity, 0>,
+    ...ruleOptions: readonly unknown[],
+  ]
+>

package/src/external.ts

@@ -0,0 +1,13 @@
+import js from '@eslint/js'
+import prettierConfig from 'eslint-config-prettier/flat'
+import globalIdentifiers from 'globals'
+export { config, configs, parser, plugin } from 'typescript-eslint'
+export type {
+  Config,
+  ConfigArray,
+  ConfigWithExtends,
+  FlatConfig,
+  InfiniteDepthConfigWithExtends,
+} from 'typescript-eslint'
+export { js, prettierConfig }
+export const { browser, node, nodeBuiltin, vitest } = globalIdentifiers

package/src/globalIgnores.ts

@@ -0,0 +1,32 @@
+import type { Config } from 'eslint/config'
+import { packageJsonName } from './packageJsonName.js'
+
+/**
+ * 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
+ */
+export const globalIgnores = {
+  ignores: [
+    '**/__snapshots__/',
+    '**/.docusaurus/',
+    '**/.expo/',
+    '**/.next/',
+    '**/.playwright/',
+    '**/.temp/',
+    '**/.tmp/',
+    '**/.turbo/',
+    '**/.wrangler/',
+    '**/.yalc/',
+    '**/.yarn/',
+    '**/*.snap',
+    '**/build/',
+    '**/coverage/',
+    '**/dist/',
+    '**/temp/',
+  ],
+  name: `${packageJsonName}/global-ignores`,
+} as const satisfies Config

package/src/globals.ts

@@ -0,0 +1,55 @@
+import type { Linter } from 'eslint'
+import { browser, node, nodeBuiltin, vitest } from './external.js'
+
+/**
+ * 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
+ */
+export 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',
+} as const satisfies Linter.Globals satisfies Record<
+  keyof typeof vitest,
+  Extract<Linter.GlobalConf, 'writable'>
+>
+
+/**
+ * An object that specifies which global
+ * variables are available during linting.
+ *
+ * @since 0.0.3
+ * @public
+ */
+export const globals =
+  /* @__PURE__ */
+  Object.assign(
+    {
+      ...browser,
+      ...node,
+      ...nodeBuiltin,
+    } as const satisfies Linter.Globals,
+
+    {
+      ...vitest,
+      ...vitestGlobals,
+    } as const satisfies Linter.Globals,
+  ) satisfies Linter.Globals

package/src/index.ts

@@ -1,379 +1,20 @@
-import js from '@eslint/js'
-import type { TSESLint } from '@typescript-eslint/utils'
-import type { Linter } from 'eslint'
-import prettierConfig from 'eslint-config-prettier'
-import globalIdentifiers from 'globals'
-import type { ConfigWithExtends } from 'typescript-eslint'
-import { config, configs, parser } from 'typescript-eslint'
-
-const { browser, node, nodeBuiltin } = globalIdentifiers
-
-/**
- * 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
- */
-export const globalIgnores = {
-  name: '@aryaemami59/global-ignores',
-  ignores: [
-    '**/dist/',
-    '**/.yalc/',
-    '**/build/',
-    '**/lib/',
-    '**/temp/',
-    '**/.yarn/',
-    '**/coverage/',
-  ],
-} as const satisfies Linter.Config
-
-/**
- * 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
- */
-export const vitestGlobals = {
-  suite: 'writable',
-  test: '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',
-} as const satisfies Linter.Globals
-
-/**
- * An object that specifies which global
- * variables are available during linting.
- *
- * @since 0.0.3
- * @public
- */
-export const globals: typeof vitestGlobals &
-  typeof browser &
-  typeof node &
-  typeof nodeBuiltin = /* @__PURE__ */ Object.assign(
-  vitestGlobals,
-  browser,
-  node,
-  nodeBuiltin,
-) satisfies Linter.Globals
-
-/**
- * An object comprised of ESLint rules to disable.
- * These rules are disabled in {@linkcode flatESLintConfig}.
- *
- * @since 0.0.3
- * @public
- */
-export const rulesToDisable = {
-  'no-undef': [0],
-  '@typescript-eslint/no-unused-vars': [
-    0,
-    {
-      vars: 'all',
-      args: 'after-used',
-      caughtErrors: 'all',
-      ignoreRestSiblings: false,
-      reportUsedIgnorePattern: false,
-    },
-  ],
-  '@typescript-eslint/ban-ts-comment': [
-    0,
-    [
-      {
-        'ts-expect-error': 'allow-with-description',
-        'ts-ignore': true,
-        'ts-nocheck': true,
-        'ts-check': false,
-        minimumDescriptionLength: 3,
-      },
-    ],
-  ],
-} as const satisfies Linter.RulesRecord
-
-/**
- * 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
- */
-export const flatESLintConfig: TSESLint.FlatConfig.Config[] =
-  /* @__PURE__ */ config(
-    // `ignores` must be first.
-    // config with just `ignores` is the replacement for `.eslintignore`
-    globalIgnores,
-    { name: '@aryaemami59/javascript', ...js.configs.recommended },
-    ...configs.recommended,
-    ...configs.stylistic,
-    { name: '@aryaemami59/prettier-config', ...prettierConfig },
-    {
-      name: '@aryaemami59/main',
-      languageOptions: {
-        globals,
-        parser,
-        parserOptions: {
-          projectService: {
-            allowDefaultProject: ['.*.js', '.*.mjs', '.*.cjs'],
-            defaultProject: './tsconfig.json',
-          },
-          ecmaVersion: 'latest',
-        },
-      },
-      rules: {
-        '@typescript-eslint/consistent-type-imports': [
-          2,
-          {
-            prefer: 'type-imports',
-            fixStyle: 'separate-type-imports',
-            disallowTypeAnnotations: true,
-          },
-        ],
-        '@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,
-          {
-            ignoreCase: false,
-            ignoreDeclarationSort: true,
-            ignoreMemberSort: false,
-            memberSyntaxSortOrder: ['none', 'all', 'multiple', 'single'],
-            allowSeparatedGroups: true,
-          },
-        ],
-        '@typescript-eslint/unified-signatures': [2],
-        '@typescript-eslint/dot-notation': [
-          2,
-          {
-            // Related issue: https://github.com/typescript-eslint/typescript-eslint/issues/10338
-            // Base ESLint default options
-            allowKeywords: true,
-            allowPattern: '',
-            // TypeScript ESLint default options
-            allowPrivateClassPropertyAccess: false,
-            allowProtectedClassPropertyAccess: false,
-            allowIndexSignaturePropertyAccess: false,
-          },
-        ],
-        '@typescript-eslint/no-unnecessary-type-parameters': [2],
-        '@typescript-eslint/no-invalid-void-type': [2],
-        '@typescript-eslint/no-confusing-void-expression': [2],
-        '@typescript-eslint/no-duplicate-type-constituents': [2],
-        '@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],
-        '@typescript-eslint/prefer-nullish-coalescing': [2],
-        '@typescript-eslint/no-inferrable-types': [2],
-        '@typescript-eslint/no-empty-function': [
-          2,
-          {
-            // Related issue: https://github.com/typescript-eslint/typescript-eslint/issues/10338
-            // Base ESLint default options
-            allow: [],
-          },
-        ],
-        '@typescript-eslint/no-unused-expressions': [
-          2,
-          {
-            // Related issue: https://github.com/typescript-eslint/typescript-eslint/issues/10338
-            // Base ESLint default options
-            allowShortCircuit: false,
-            allowTernary: false,
-            allowTaggedTemplates: false,
-            enforceForJSX: false,
-          },
-        ],
-        'object-shorthand': [2],
-        ...rulesToDisable,
-      },
-      linterOptions: { reportUnusedDisableDirectives: 2 },
-    },
-    {
-      name: '@aryaemami59/commonjs',
-      files: ['**/*.c[jt]s'],
-      languageOptions: { sourceType: 'commonjs' },
-      rules: {
-        '@typescript-eslint/no-require-imports': [
-          0,
-          [{ allow: [], allowAsImport: false }],
-        ],
-      },
-    },
-  )
-
-/**
- * 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
- */
-export const createESLintConfig = (
-  additionalOverrides: ConfigWithExtends[] = [],
-): TSESLint.FlatConfig.Config[] =>
-  /* @__PURE__ */ config(...flatESLintConfig, ...additionalOverrides)
+export { disabledRules } from './disabledRules.js'
+export {
+  config,
+  configs,
+  js,
+  parser,
+  plugin,
+  prettierConfig,
+} from './external.js'
+export type {
+  Config,
+  ConfigArray,
+  ConfigWithExtends,
+  FlatConfig,
+  InfiniteDepthConfigWithExtends,
+} from './external.js'
+export { globalIgnores } from './globalIgnores.js'
+export { globals, vitestGlobals } from './globals.js'
+export { flatESLintConfig } from './shareableConfigs.js'
+export { createESLintConfig } from './utils.js'

package/src/packageJsonName.ts

@@ -0,0 +1,11 @@
+import packageJson from '../package.json' with { type: 'json' }
+
+/**
+ * This is used because if we import the package name from the
+ * `package.json` file, it will be bundled into the final output,
+ * which is not desired.
+ *
+ * @since 0.0.5
+ * @internal
+ */
+export const packageJsonName = packageJson.name