@workleap/eslint-configs 1.0.1 → 1.1.0

package/src/by-project-type/defineTypescriptLibraryConfig.ts

@@ -1,17 +1,17 @@
 import { defineConfig, globalIgnores } from "eslint/config";
-import { coreConfig, type CoreConfigOptions, coreGlobalIgnores } from "../core.ts";
-import { jestConfig, type JestConfigOptions, jestGlobalIgnores } from "../jest.ts";
-import { jsonConfig, JsonConfigOptions, jsonGlobalIgnores } from "../json.ts";
-import { packageJsonConfig, type PackageJsonConfigOptions, packageJsonGlobalIgnores } from "../packageJson.ts";
+import { type CoreConfigOptions, coreGlobalIgnores, defineCoreConfig } from "../core.ts";
+import { defineJestConfig, type JestConfigOptions, jestGlobalIgnores } from "../jest.ts";
+import { defineJsonConfig, JsonConfigOptions, jsonGlobalIgnores } from "../json.ts";
+import { definePackageJsonConfig, type PackageJsonConfigOptions, packageJsonGlobalIgnores } from "../packageJson.ts";
 import { WorkleapPlugin } from "../plugins/workleapPlugin.ts";
-import { typescriptConfig, type TypescriptConfigOptions, typescriptGlobalIgnores } from "../typescript.ts";
-import { vitestConfig, type VitestConfigOptions, vitestGlobalIgnores } from "../vitest.ts";
-import { yamlConfig, type YamlConfigOptions, yamlGlobalIgnores } from "../yaml.ts";
+import { defineTypeScriptConfig, type TypeScriptConfigOptions, typescriptGlobalIgnores } from "../typescript.ts";
+import { defineVitestConfig, type VitestConfigOptions, vitestGlobalIgnores } from "../vitest.ts";
+import { defineYamlConfig, type YamlConfigOptions, yamlGlobalIgnores } from "../yaml.ts";
 
 export interface DefineTypeScriptLibraryConfigOptions {
     testFramework?: "vitest" | "jest";
     core?: CoreConfigOptions;
-    typescript?: TypescriptConfigOptions;
+    typescript?: TypeScriptConfigOptions;
     jest?: JestConfigOptions;
     json?: JsonConfigOptions;
     vitest?: VitestConfigOptions;
@@ -49,21 +49,21 @@ export function defineTypeScriptLibraryConfig(tsconfigRootDir: string, options:
             ...vitestGlobalIgnores,
             ...yamlGlobalIgnores
         ]),
-        ...coreConfig(core),
-        ...jestConfig({
+        ...defineCoreConfig(core),
+        ...defineJestConfig({
             ...jest,
             enabled: jest?.enabled ?? testFramework === "jest"
         }),
-        ...jsonConfig(json),
-        ...packageJsonConfig(packageJson),
-        ...typescriptConfig(tsconfigRootDir, typescript),
+        ...defineJsonConfig(json),
+        ...definePackageJsonConfig(packageJson),
+        ...defineTypeScriptConfig(tsconfigRootDir, typescript),
         // Temporary fix until the vitest plugin support defineConfig and the types are fixed.
-        ...(vitestConfig({
+        ...(defineVitestConfig({
             ...vitest,
             enabled: vitest?.enabled ?? testFramework === "vitest"
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         }) as any),
-        ...yamlConfig(yaml),
+        ...defineYamlConfig(yaml),
         {
             plugins: {
                 "@workleap": WorkleapPlugin

package/src/by-project-type/defineWebApplicationConfig.ts

@@ -1,47 +1,16 @@
 import { defineConfig, globalIgnores } from "eslint/config";
-import { coreConfig, type CoreConfigOptions, coreGlobalIgnores } from "../core.ts";
-import { jestConfig, type JestConfigOptions, jestGlobalIgnores } from "../jest.ts";
-import { jsonConfig, JsonConfigOptions, jsonGlobalIgnores } from "../json.ts";
-import { jsxAllyConfig, type JsxAllyConfigOptions, jsxAllyGlobalIgnores } from "../jsxAlly.ts";
-import { packageJsonConfig, type PackageJsonConfigOptions, packageJsonGlobalIgnores } from "../packageJson.ts";
+import { type CoreConfigOptions, coreGlobalIgnores, defineCoreConfig } from "../core.ts";
+import { defineJestConfig, type JestConfigOptions, jestGlobalIgnores } from "../jest.ts";
+import { defineJsonConfig, JsonConfigOptions, jsonGlobalIgnores } from "../json.ts";
+import { defineJsxAllyConfig, type JsxAllyConfigOptions, jsxAllyGlobalIgnores } from "../jsxAlly.ts";
+import { definePackageJsonConfig, type PackageJsonConfigOptions, packageJsonGlobalIgnores } from "../packageJson.ts";
 import { WorkleapPlugin } from "../plugins/workleapPlugin.ts";
-import { reactConfig, type ReactConfigOptions, reactGlobalIgnores } from "../react.ts";
-import { storybookConfig, type StorybookConfigOptions, storybookGlobalIgnores } from "../storybook.ts";
-import { testingLibraryConfig, type TestingLibraryConfigOptions, testingLibraryGlobalIgnores } from "../testingLibrary.ts";
-import { typescriptConfig, type TypescriptConfigOptions, typescriptGlobalIgnores } from "../typescript.ts";
-import { vitestConfig, type VitestConfigOptions, vitestGlobalIgnores } from "../vitest.ts";
-import { yamlConfig, type YamlConfigOptions, yamlGlobalIgnores } from "../yaml.ts";
-
-/*
-
-error  Parsing error: C:\Dev\workleap\wl-web-configs\samples\storybook\rsbuild\.storybook\main.ts was not found by the project service. Consider either including it in the tsconfig.json or including it in allowDefaultProject
-
--> It usually means that the project tsconfig.json file cannot find the specified file
--> Make sure to clear the ESLint cache after such an error because update the tsconfig.json file doesn't invalidate the ESLint cache
-
-*/
-
-/*
-
-import { defineConfig, globalIgnores } from "eslint/config";
-import { defineReactLibraryConfig } from  "@workleap/eslint-configs";
-
-export default defineConfig([
-    globalIgnores([
-        "/reports/**"
-    ]),
-    defineReactLibraryConfig(import.meta.dirname)
-]);
-
-*/
-
-/*
-
-The key insight was that ESLint 9's flat config system requires ignores to be specified in the configuration
-file itself for optimal performance, rather than relying on CLI flags (--ignore-pattern). The ignores array at the beginning of the
- config ensures files are filtered out during the file discovery phase, not after.
-
-*/
+import { defineReactConfig, type ReactConfigOptions, reactGlobalIgnores } from "../react.ts";
+import { defineStorybookConfig, type StorybookConfigOptions, storybookGlobalIgnores } from "../storybook.ts";
+import { defineTestingLibraryConfig, type TestingLibraryConfigOptions, testingLibraryGlobalIgnores } from "../testingLibrary.ts";
+import { defineTypeScriptConfig, type TypeScriptConfigOptions, typescriptGlobalIgnores } from "../typescript.ts";
+import { defineVitestConfig, type VitestConfigOptions, vitestGlobalIgnores } from "../vitest.ts";
+import { defineYamlConfig, type YamlConfigOptions, yamlGlobalIgnores } from "../yaml.ts";
 
 export interface DefineWebApplicationConfigOptions {
     testFramework?: "vitest" | "jest";
@@ -53,7 +22,7 @@ export interface DefineWebApplicationConfigOptions {
     react?: ReactConfigOptions;
     storybook?: StorybookConfigOptions;
     testingLibrary?: TestingLibraryConfigOptions;
-    typescript?: TypescriptConfigOptions;
+    typescript?: TypeScriptConfigOptions;
     vitest?: VitestConfigOptions;
     yaml?: YamlConfigOptions;
 }
@@ -96,25 +65,25 @@ export const defineWebApplicationConfig = (tsconfigRootDir: string, options: Def
             ...vitestGlobalIgnores,
             ...yamlGlobalIgnores
         ]),
-        ...coreConfig(core),
-        ...jestConfig({
+        ...defineCoreConfig(core),
+        ...defineJestConfig({
             ...jest,
             enabled: jest?.enabled ?? testFramework === "jest"
         }),
-        ...jsonConfig(json),
-        ...jsxAllyConfig(jsxAlly),
-        ...packageJsonConfig(packageJson),
-        ...reactConfig(react),
-        ...storybookConfig(storybook),
-        ...testingLibraryConfig(testingLibrary),
-        ...typescriptConfig(tsconfigRootDir, typescript),
+        ...defineJsonConfig(json),
+        ...defineJsxAllyConfig(jsxAlly),
+        ...definePackageJsonConfig(packageJson),
+        ...defineReactConfig(react),
+        ...defineStorybookConfig(storybook),
+        ...defineTestingLibraryConfig(testingLibrary),
+        ...defineTypeScriptConfig(tsconfigRootDir, typescript),
         // Temporary fix until the vitest plugin support defineConfig and the types are fixed.
-        ...(vitestConfig({
+        ...(defineVitestConfig({
             ...vitest,
             enabled: vitest?.enabled ?? testFramework === "vitest"
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         }) as any),
-        ...yamlConfig(yaml),
+        ...defineYamlConfig(yaml),
         {
             plugins: {
                 "@workleap": WorkleapPlugin

package/src/core.ts

@@ -10,7 +10,7 @@ export interface CoreConfigOptions {
 
 export const coreGlobalIgnores = [];
 
-export function coreConfig(options: CoreConfigOptions = {}) {
+export function defineCoreConfig(options: CoreConfigOptions = {}) {
     const {
         rules
     } = options;

package/src/index.ts

@@ -2,15 +2,15 @@ export { defineMonorepoWorkspaceConfig, type DefineMonorepoWorkspaceConfigOption
 export { defineReactLibraryConfig, type DefineReactLibraryConfigOptions } from "./by-project-type/defineReactLibraryConfig.ts";
 export { defineTypeScriptLibraryConfig, type DefineTypeScriptLibraryConfigOptions } from "./by-project-type/defineTypescriptLibraryConfig.ts";
 export { defineWebApplicationConfig, type DefineWebApplicationConfigOptions } from "./by-project-type/defineWebApplicationConfig.ts";
-export type { CoreConfigOptions } from "./core.ts";
-export type { JestConfigOptions } from "./jest.ts";
-export type { JsxAllyConfigOptions } from "./jsxAlly.ts";
-export type { PackageJsonConfigOptions } from "./packageJson.ts";
-export type { ReactConfigOptions } from "./react.ts";
-export type { StorybookConfigOptions } from "./storybook.ts";
-export type { TestingLibraryConfigOptions } from "./testingLibrary.ts";
+export { defineCoreConfig, type CoreConfigOptions } from "./core.ts";
+export { defineJestConfig, type JestConfigOptions } from "./jest.ts";
+export { defineJsxAllyConfig, type JsxAllyConfigOptions } from "./jsxAlly.ts";
+export { definePackageJsonConfig, type PackageJsonConfigOptions } from "./packageJson.ts";
+export { defineReactConfig, type ReactConfigOptions } from "./react.ts";
+export { defineStorybookConfig, type StorybookConfigOptions } from "./storybook.ts";
+export { defineTestingLibraryConfig, type TestingLibraryConfigOptions } from "./testingLibrary.ts";
 export type { ConfigWithExtends, ExtendsElement, InfiniteArray, SimpleExtendsElement } from "./types.ts";
-export type { TypescriptConfigOptions } from "./typescript.ts";
-export type { VitestConfigOptions } from "./vitest.ts";
-export type { YamlConfigOptions } from "./yaml.ts";
+export { defineTypeScriptConfig, type TypeScriptConfigOptions } from "./typescript.ts";
+export { defineVitestConfig, type VitestConfigOptions } from "./vitest.ts";
+export { defineYamlConfig, type YamlConfigOptions } from "./yaml.ts";
 

package/src/jest.ts

@@ -10,7 +10,7 @@ export interface JestConfigOptions {
 
 export const jestGlobalIgnores = [];
 
-export function jestConfig(options: JestConfigOptions = {}) {
+export function defineJestConfig(options: JestConfigOptions = {}) {
     const {
         enabled = false,
         rules = {}

package/src/json.ts

@@ -8,7 +8,7 @@ export interface JsonConfigOptions {
 
 export const jsonGlobalIgnores = [];
 
-export function jsonConfig(options: JsonConfigOptions = {}) {
+export function defineJsonConfig(options: JsonConfigOptions = {}) {
     const {
         rules = {}
     } = options;

package/src/jsxAlly.ts

@@ -8,7 +8,7 @@ export interface JsxAllyConfigOptions {
 
 export const jsxAllyGlobalIgnores = [];
 
-export function jsxAllyConfig(options: JsxAllyConfigOptions = {}) {
+export function defineJsxAllyConfig(options: JsxAllyConfigOptions = {}) {
     const {
         rules = {}
     } = options;

package/src/packageJson.ts

@@ -8,7 +8,7 @@ export interface PackageJsonConfigOptions {
 
 export const packageJsonGlobalIgnores = [];
 
-export function packageJsonConfig(options: PackageJsonConfigOptions = {}) {
+export function definePackageJsonConfig(options: PackageJsonConfigOptions = {}) {
     const {
         rules = {}
     } = options;

package/src/react.ts

@@ -11,7 +11,7 @@ export interface ReactConfigOptions {
 
 export const reactGlobalIgnores = [];
 
-export function reactConfig(options: ReactConfigOptions = {}) {
+export function defineReactConfig(options: ReactConfigOptions = {}) {
     const {
         rules = {},
         compiler = false

package/src/storybook.ts

@@ -12,7 +12,7 @@ export const storybookGlobalIgnores = [
     "storybook-static"
 ];
 
-export function storybookConfig(options: StorybookConfigOptions = {}) {
+export function defineStorybookConfig(options: StorybookConfigOptions = {}) {
     const {
         storiesRules = {},
         mainFileRules = {}

package/src/testingLibrary.ts

@@ -9,7 +9,7 @@ export interface TestingLibraryConfigOptions {
 
 export const testingLibraryGlobalIgnores = [];
 
-export function testingLibraryConfig(options: TestingLibraryConfigOptions = {}) {
+export function defineTestingLibraryConfig(options: TestingLibraryConfigOptions = {}) {
     const {
         reactRules = {},
         jsRules = {}

package/src/typescript.ts

@@ -4,13 +4,13 @@ import type { Linter } from "eslint";
 import tseslint from "typescript-eslint";
 import type { ConfigWithExtends } from "./types.ts";
 
-export interface TypescriptConfigOptions {
+export interface TypeScriptConfigOptions {
     rules?: Partial<Linter.RulesRecord>;
 }
 
 export const typescriptGlobalIgnores = [];
 
-export function typescriptConfig(tsconfigRootDir: string, options: TypescriptConfigOptions = {}) {
+export function defineTypeScriptConfig(tsconfigRootDir: string, options: TypeScriptConfigOptions = {}) {
     const {
         rules = {}
     } = options;

package/src/vitest.ts

@@ -9,7 +9,7 @@ export interface VitestConfigOptions {
 
 export const vitestGlobalIgnores = [];
 
-export function vitestConfig(options: VitestConfigOptions = {}) {
+export function defineVitestConfig(options: VitestConfigOptions = {}) {
     const {
         enabled = true,
         rules = {}

package/src/yaml.ts

@@ -10,7 +10,7 @@ export const yamlGlobalIgnores = [
     "pnpm-lock.yaml"
 ];
 
-export function yamlConfig(options: YamlConfigOptions = {}) {
+export function defineYamlConfig(options: YamlConfigOptions = {}) {
     const {
         rules = {}
     } = options;