@fabdeh/eslint-config 0.1.3 → 0.2.1

package/README.md

@@ -9,7 +9,7 @@
 - Designed to work with TypeScript, JSX, etc. Out-of-box.
 - Opinionated, but [very customizable](#customization)
 - [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new), compose easily!
-- Automatic [Angular](#angular), [NGRX](#ngrx), [TailwindCSS](#tailwindcc), [Jest](#jest), [Vitest](#vitest) support when the corresponding dependency is detected.
+- Automatic [Angular](#angular), [NGRX](#ngrx), [TailwindCSS](#tailwindcc), [Vitest](#vitest) support when the corresponding dependency is detected.
 <!--- - Optional [formatters](#formatters) support for formatting CSS, HTML, XML, etc. --->
 - **Style principle**: Minimal for reading, stable for diff, consistent
   - Sorted imports, dangling commas
@@ -121,8 +121,7 @@ export default createConfig({
   angular: true,
   ngrx: true,
 
-  // Disable jest and vitest
-  jest: false,
+  // Disable vitest
   vitest: false,
 
   // `.eslintignore` is no longer supported in Flat config, use `ignores` instead

package/dist/index.d.mts

@@ -140,15 +140,6 @@ interface VendoredPrettierOptionsRequired {
  * A type that can be awaited. Promise<T> or T.
  */
 type Awaitable<T> = Promise<T> | T;
-/**
- * Options for determining if the code is running in an editor environment.
- */
-interface IsInEditorOptions {
-    /**
-     * Optional property that allows specifying if the code is running in an editor environment.
-     */
-    isInEditor?: boolean;
-}
 /**
  * Interface representing options for overriding default ESLint rules.
  */
@@ -196,7 +187,7 @@ interface StylisticOptions {
  */
 interface TypeScriptParserOptions {
     /**
-     * Optional parser options to be used by the TypeScript parser.
+     * Additional parser options for TypeScript.
      */
     parserOptions?: TSESLint.FlatConfig.ParserOptions;
 }
@@ -316,7 +307,7 @@ interface CreateConfigOptions {
      *
      * @default auto-detected
      */
-    typescript?: OverridesOptions & TypeScriptParserOptions;
+    typescript?: boolean | (OverridesOptions & TypeScriptParserOptions);
     /**
      * Enable stylistic rules.
      *
@@ -343,13 +334,7 @@ interface CreateConfigOptions {
      */
     ngrx?: NgrxOptions | boolean;
     /**
-     * Options for the jest linting rules. This option is mutually exclusive with vitest.
-     *
-     * @default auto-detect based on dependencies.
-     */
-    jest?: boolean | (OverridesOptions & TestingOptions);
-    /**
-     * Options for the vitest linting rules. This option is mutually exclusive with jest.
+     * Options for the vitest linting rules
      *
      * @default auto-detect based on dependencies.
      */
@@ -397,12 +382,6 @@ interface CreateConfigOptions {
      * @default false
      */
     formatters?: FormattersOptions | boolean;
-    /**
-     * Control to disable some rules in editors.
-     *
-     * @default auto-detect based on the process.env
-     */
-    isInEditor?: boolean;
 }
 
 /**
@@ -453,30 +432,15 @@ declare function imports(options?: StylisticOptions): ConfigArray;
  * handling based on the environment (editor or not).
  *
  * @param options - Configuration options for the JavaScript setup.
- * @param options.isInEditor - Indicates if the configuration is being used in an editor.
  * @param options.overrides - Additional rule overrides.
  * @param options.allowAngularDecorator - Allows specific Angular decorators to be used without new-cap errors.
  * @returns A configuration array for ESLint.
  * @example
  * ```typescript
- * const config = javascript({ isInEditor: true, allowAngularDecorator: true });
+ * const config = javascript({ allowAngularDecorator: true });
  * ```
  */
-declare function javascript(options?: IsInEditorOptions & OverridesOptions & {
-    allowAngularDecorator?: boolean;
-}): ConfigArray;
-
-/**
- * Generates an ESLint configuration for Jest testing environments.
- *
- * @param options - Configuration options for the Jest setup.
- * @param options.overrides - Custom rule overrides to apply.
- * @param options.useJestDom - Whether to include `@testing-library/jest-dom` plugin. Defaults to checking if the package exists.
- * @param options.useTestingLibrary - Whether to include `@testing-library/angular` plugin. Defaults to checking if the package exists.
- * @param options.stylistic - Whether to include stylistic rules. Defaults to `true`.
- * @returns A promise that resolves to a `ConfigArray` containing the ESLint configuration.
- */
-declare function jest(options?: OverridesOptions & StylisticOptions & TestingOptions): Promise<ConfigArray>;
+declare function javascript(options?: OverridesOptions): ConfigArray;
 
 /**
  * Generates a configuration array for JSDoc rules.
@@ -684,10 +648,9 @@ declare function yaml(options?: FilesOptions & OverridesOptions & StylisticOptio
  * @param options - Configuration options that extend `ConfigWithExtends` and `CreateConfigOptions`.
  * @param userConfigs - Additional user configurations that can be awaited.
  * @returns A promise that resolves to a `ConfigArray`.
- * @throws Will throw an error if both `jest` and `vitest` are enabled.
  * @example
  * ```typescript
- * const config = await createConfig({ jest: true, typescript: { parserOptions: { project: './tsconfig.json' } } });
+ * const config = await createConfig({ vitest: true, typescript: { parserOptions: { project: './tsconfig.json' } } });
  * ```
  */
 declare function createConfig(options?: ConfigWithExtends & CreateConfigOptions, ...userConfigs: Awaitable<ConfigWithExtends | ConfigWithExtends[]>[]): Promise<ConfigArray>;
@@ -713,26 +676,6 @@ declare const GLOB_HTML = "**/*.htm?(l)";
  */
 declare const GLOB_TESTS: string[];
 
-/**
- * Determines if the current environment is an editor environment.
- *
- * This function checks various environment variables to determine if the code
- * is running within a known editor environment such as VSCode, IntelliJ, JetBrains,
- * Vim, or NeoVim. It also ensures that the code is not running in a CI environment
- * or within git hooks.
- *
- * @returns `true` if the code is running in an editor environment, otherwise `false`.
- */
-declare function isInEditorEnv(): boolean;
-/**
- * Converts a value to an array. If the value is already an array, it returns the value as is.
- * Otherwise, it wraps the value in an array.
- *
- * @template T - The type of the value.
- * @param value - The value to convert to an array.
- * @returns The value converted to an array.
- */
-declare function toArray<T>(value: T | T[]): T[];
 /**
  * A utility function to handle the default export of a module.
  *
@@ -786,5 +729,14 @@ declare function ensurePackages(packages: (string | undefined)[]): Promise<void>
  * @returns The name of the nearest package.json
  */
 declare function findNearestPackageJsonName(directoryPath?: string): Promise<string>;
+type ResolvedOptions<T> = T extends boolean ? never : NonNullable<T>;
+/**
+ * Returns the object representation of the configuration or an empty object if it is a boolean.
+ *
+ * @param options - The {@link CreateConfigOptions} object to extract the sub-options from.
+ * @param key - The property name.
+ * @returns An object representing the required options.
+ */
+declare function resolveSubOptions<K extends keyof CreateConfigOptions>(options: CreateConfigOptions, key: K): ResolvedOptions<CreateConfigOptions[K]>;
 
-export { type AngularOptions, type Awaitable, type CreateConfigOptions, type FilesOptions, type FormattersOptions, GLOB_HTML, GLOB_JS, GLOB_SRC, GLOB_TESTS, GLOB_TS, type IsInEditorOptions, type NgrxOperators, type NgrxOptions, type OverridesOptions, STYLISTIC_CONFIG_DEFAULT, type StylisticConfig, type StylisticOptions, type TestingOptions, type TypeScriptParserOptions, type UnicornOptions, angular, comments, createConfig, ensurePackages, findNearestPackageJsonName, getWorkspaceRoot, ignores, imports, interopDefault, isInEditorEnv, isPackageInScope, javascript, jest, jsdoc, jsonc, markdown, ngrx, perfectionist, sortPackageJson, sortTsConfig, stylistic, tailwindcss, toArray, toml, typescript, unicorn, vitest, yaml };
+export { type AngularOptions, type Awaitable, type CreateConfigOptions, type FilesOptions, type FormattersOptions, GLOB_HTML, GLOB_JS, GLOB_SRC, GLOB_TESTS, GLOB_TS, type NgrxOperators, type NgrxOptions, type OverridesOptions, type ResolvedOptions, STYLISTIC_CONFIG_DEFAULT, type StylisticConfig, type StylisticOptions, type TestingOptions, type TypeScriptParserOptions, type UnicornOptions, angular, comments, createConfig, ensurePackages, findNearestPackageJsonName, getWorkspaceRoot, ignores, imports, interopDefault, isPackageInScope, javascript, jsdoc, jsonc, markdown, ngrx, perfectionist, resolveSubOptions, sortPackageJson, sortTsConfig, stylistic, tailwindcss, toml, typescript, unicorn, vitest, yaml };