@homer0/oxlint-config 1.0.3 → 2.0.0

package/src/types.ts

@@ -1,10 +1,28 @@
-import type { ExtensionFragmentName, TestConvention } from './consts.js';
+import type globals from 'globals';
+import type { ExtensionFragmentName, TestConvention, ConfigEnv } from './consts.js';
 
-export type { ExtensionFragmentName } from './consts.js';
+export type RuleSettings = Record<string, unknown>;
+
+export type DangleRuleOptions = {
+  allow?: string[];
+  allowAfterThis?: boolean;
+  allowAfterSuper?: boolean;
+  enforceInMethodNames?: boolean;
+};
 
-export type ConfigName = 'browser' | 'node';
+export type DangleRuleSettings = [unknown, DangleRuleOptions?];
 
-export type RuleSettings = Record<string, unknown>;
+/** Controls whether a named global can be reassigned. */
+export type GlobalVarMode = 'readonly' | 'writable' | 'off';
+
+/** Adds named globals and `$`-prefixed global groups from the `globals` package. */
+export type GlobalVars = Partial<{
+  [K in keyof typeof globals as `$${K}`]: true;
+}> & {
+  [key: string]: true | GlobalVarMode;
+};
+
+export type ResolvedGlobalVars = Record<string, boolean | string>;
 
 /** Adds native Oxlint rules to a generated fragment without replacing its policy. */
 export type ConfigFragment = {
@@ -17,40 +35,52 @@ export type ExtensionFragments = Partial<Record<ExtensionFragmentName, ConfigFra
 /** Selects a test framework-specific native rule policy. */
 export type TestFramework = 'vitest';
 
+type TestConfigBaseOptions = {
+  env?: ConfigEnv;
+  framework?: TestFramework;
+  ts?: boolean;
+};
+
 /**
  * Narrows a test override and optionally selects its environment, framework, and
  * TypeScript policy.
  */
-export type TestConfigOptions = {
-  configs?: ConfigName[];
-  framework?: TestFramework;
+export type TestConfigOptions = TestConfigBaseOptions & {
   /** Uses a built-in convention or custom glob(s). */
   files?: TestConvention | (string & {}) | string[];
-  ts?: boolean;
 };
 
 /** Selects both conventions, one built-in convention, or a custom test override. */
 export type TestsOption = boolean | TestConvention | TestConfigOptions;
 
-export type CreateConfigOptions = {
-  configs: ConfigName[];
+type CreateConfigBaseOptions = {
+  env: ConfigEnv;
+  allowedDangleNames?: string[];
   extensions?: ExtensionFragments;
+  globals?: GlobalVars;
   ignores?: string[];
-  /** Enables the native subset of JSDoc policy. */
   jsdoc?: boolean;
-  tests?: TestsOption;
-  /** Defaults to `true`. */
   ts?: boolean;
-  /**
-   * Enables Oxlint's root-only type-aware mode. Requires oxlint-tsgolint and TypeScript
-   * 7+.
-   */
-  typeAware?: boolean;
 };
 
-export type CreateReactConfigOptions = CreateConfigOptions;
+export type TestConfigOverrideOptions = TestConfigBaseOptions & {
+  files: string | string[];
+};
+
+export type ConfigOverrideOptions = {
+  files: string | string[];
+  rules?: RuleSettings;
+  tests?: TestConfigOverrideOptions;
+} & Partial<CreateConfigBaseOptions>;
 
-export type CreateNextjsConfigOptions = Omit<CreateConfigOptions, 'configs' | 'ts'>;
+export type CreateConfigOptions = CreateConfigBaseOptions & {
+  tests?: TestsOption;
+  overrides?: RuleSettings | Array<ConfigOverrideOptions | RuleSettings>;
+  /** Enables Oxlint's root-only type-aware mode. Requires oxlint-tsgolint and TS 7+ */
+  typeAware?: boolean;
+};
+
+export type CreateNextjsConfigOptions = Omit<CreateConfigOptions, 'env' | 'ts'>;
 
 export type CreateConfigSettings = CreateConfigOptions & {
   nextjs?: boolean;
@@ -58,27 +88,28 @@ export type CreateConfigSettings = CreateConfigOptions & {
 };
 
 export type ResolveTestConfigOptions = {
-  tests: TestsOption | undefined;
-  productionConfig: ConfigName;
+  tests: Exclude<TestsOption, false>;
+  productionEnv: ConfigEnv;
   productionTs: boolean;
 };
 
 export type ResolvedTestConfig = {
-  configs: ConfigName[];
+  env: ConfigEnv;
   files: string[];
   framework?: TestFramework;
   ts: boolean;
 };
 
 export type GeneratedConfigOverride = {
+  excludeFiles?: string[];
   files: string[];
-  globals: Record<string, boolean | string>;
+  globals: ResolvedGlobalVars;
   rules: RuleSettings;
 };
 
 /** Native Oxlint configuration generated by this package's factories. */
 export type GeneratedConfig = {
-  globals: Record<string, boolean | string>;
+  globals: ResolvedGlobalVars;
   ignorePatterns?: string[];
   options?: {
     typeAware: true;
@@ -89,27 +120,43 @@ export type GeneratedConfig = {
 };
 
 export type CreateTestOverrideOptions = {
+  parentEnv: ConfigEnv;
   testConfig: ResolvedTestConfig;
+  allowedDangleNames?: string[];
+  extraRules?: RuleSettings[];
   extensions?: ExtensionFragments;
+  globals?: GlobalVars | ResolvedGlobalVars;
 };
 
-export type ResolveConfigComponentsOptions = CreateConfigSettings & {
+export type ResolveConfigComponentsOptions = Omit<CreateConfigSettings, 'globals'> & {
   testConfig?: ResolvedTestConfig;
   baseFragment?: ConfigFragment;
   baseExtensionFragment?: ConfigFragment;
+  globals?: GlobalVars | ResolvedGlobalVars;
 };
 
 export type ResolveTestConfigComponentsOptions = {
-  config: ConfigName;
+  env: ConfigEnv;
   testConfig?: ResolvedTestConfig;
   tests?: TestsOption;
   ts?: boolean;
 };
 
+export type ResolveTestConfigComponentsResult = {
+  doingTestsSetup: boolean;
+  testConfig?: ResolvedTestConfig;
+};
+
 export type ResolveConfigComponentsResult = {
-  config: ConfigName;
+  env: ConfigEnv;
+  globals: ResolvedGlobalVars;
   testConfig?: ResolvedTestConfig;
   fragments: ConfigFragment[];
   plugins: string[];
-  configGlobals?: Record<string, boolean | string>;
+  configGlobals?: ResolvedGlobalVars;
+};
+
+export type ResolveGlobalsOptions = {
+  globals?: GlobalVars | ResolvedGlobalVars;
+  doingTestsSetup?: boolean;
 };