@aryaemami59/eslint-config 0.0.4 → 0.0.5

package/src/utils.ts

@@ -0,0 +1,93 @@
+import type { TSESLint } from '@typescript-eslint/utils'
+import type { ConfigWithExtends } from './external.js'
+import { config } from './external.js'
+import { flatESLintConfig } from './shareableConfigs.js'
+
+/**
+ * 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)