@apify/oxlint-config 0.2.1 → 0.2.3

package/README.md

@@ -16,23 +16,35 @@ If you want type-aware rules (`typescript/no-floating-promises`, `typescript/awa
 npm install --save-dev oxlint-tsgolint
 ```
 
-Add an `oxlint.config.ts` (or `.js`/`.mjs`) at your project root and spread the preset into it:
+Add an `oxlint.config.ts` (or `.js`/`.mjs`) at your project root and call the package's `defineConfig` with any project-local additions:
 
 ```ts
-import { defineConfig } from 'oxlint';
-import sharedConfig from '@apify/oxlint-config';
+import { defineConfig } from '@apify/oxlint-config';
 
 export default defineConfig({
-    ...sharedConfig,
     // local plugin additions, e.g. for React projects:
-    plugins: [...sharedConfig.plugins, 'react'],
+    plugins: ['react'],
     overrides: [
-        ...sharedConfig.overrides,
         // local overrides
     ],
 });
 ```
 
+`defineConfig` merges your config on top of the Apify preset (arrays concatenated, objects shallow-merged with consumer winning) and returns a typed `OxlintConfig` that's safe to default-export under `composite` / `--isolatedDeclarations` TypeScript projects.
+
+If you'd rather spread the preset manually, the raw config is still the package's default export:
+
+```ts
+import { defineConfig } from 'oxlint';
+import sharedConfig from '@apify/oxlint-config';
+
+export default defineConfig({
+    ...sharedConfig,
+    plugins: [...sharedConfig.plugins, 'react'],
+    overrides: [...sharedConfig.overrides, /* local */],
+});
+```
+
 Run lint:
 
 ```bash
@@ -43,7 +55,7 @@ npx oxlint --type-aware
 
 The shared config provides:
 
-- **Plugins** — `typescript`, `import`, `unicorn`, `jest`, `promise` (Rust-side, no install required). React plugins are intentionally **not** included; consumers add `'react'` to `plugins` if their project uses React. (Note: oxlint's `react` plugin already covers React Hooks rules; there's no separate `react-hooks` plugin.)
+- **Plugins** — `typescript`, `import`, `unicorn`, `jest`, `vitest`, `promise` (Rust-side, no install required). Both `jest` and `vitest` are enabled because vitest's API is jest-compatible — most of the test best-practices we care about live in the `jest/*` rules and apply equally to vitest tests. The `vitest` plugin adds a few framework-specific rules (e.g. `vitest/hoisted-apis-on-top`, `vitest/no-conditional-tests`) on top. React plugins are intentionally **not** included; consumers add `'react'` to `plugins` if their project uses React. (Note: oxlint's `react` plugin already covers React Hooks rules; there's no separate `react-hooks` plugin.)
 - **Rules** — the Apify house rules: `typescript/consistent-type-imports`, `typescript/no-floating-promises`, `unicorn/prefer-node-protocol`, `import/no-default-export`, `unicorn/no-await-in-promise-methods`, plus the curated `off` list of TypeScript strict rules we don't want.
 - **Overrides** — relaxed rules for test files, vite/jest/vitest config files, story files, and integration test directories.
 
@@ -55,7 +67,6 @@ The shared config does **not** declare `jsPlugins` (the JS-side plugins like `es
 
 ```ts
 export default defineConfig({
-    ...sharedConfig,
     jsPlugins: [
         { name: 'storybook', specifier: 'eslint-plugin-storybook' },
         { name: 'playwright', specifier: 'eslint-plugin-playwright' },
@@ -65,13 +76,11 @@ export default defineConfig({
 
 ## Overriding rules
 
-Spread the preset and add your own `rules` block — yours win over the preset:
+Add a `rules` block — your entries win over the preset:
 
 ```ts
 export default defineConfig({
-    ...sharedConfig,
     rules: {
-        ...sharedConfig.rules,
         'no-console': 'off',
     },
 });

package/index.d.ts

@@ -3,13 +3,7 @@ import type { OxlintConfig } from 'oxlint';
 /**
  * Narrow {@link OxlintConfig} so the keys this preset always populates
  * (`plugins`, `overrides`, `rules`, `env`) are non-optional. That lets
- * consumers spread them directly without a non-null assertion:
- *
- *     export default defineConfig({
- *         ...sharedConfig,
- *         plugins: [...sharedConfig.plugins, 'react'],
- *         overrides: [...sharedConfig.overrides, { ... }],
- *     });
+ * consumers spread them directly without a non-null assertion.
  */
 export type ApifyOxlintConfig = OxlintConfig & {
     plugins: NonNullable<OxlintConfig['plugins']>;
@@ -18,5 +12,25 @@ export type ApifyOxlintConfig = OxlintConfig & {
     env: NonNullable<OxlintConfig['env']>;
 };
 
+/**
+ * Wraps oxlint's `defineConfig` to merge a project-local config on top of
+ * the Apify preset. Arrays (`plugins`, `overrides`) are concatenated;
+ * objects (`rules`, `env`) are shallow-merged with the consumer winning;
+ * everything else (`ignorePatterns`, `jsPlugins`, `categories`, …) is
+ * passed through unchanged.
+ *
+ * Returns `OxlintConfig` (not the narrower `ApifyOxlintConfig`), which is
+ * re-exported from oxlint, so default-exporting the result is safe under
+ * `composite` / `--isolatedDeclarations` TypeScript projects.
+ *
+ *     import { defineConfig } from '@apify/oxlint-config';
+ *
+ *     export default defineConfig({
+ *         plugins: ['react'],
+ *         overrides: [{ files: [...], rules: {...} }],
+ *     });
+ */
+export function defineConfig(overrides?: Partial<OxlintConfig>): OxlintConfig;
+
 declare const config: ApifyOxlintConfig;
 export default config;

package/index.js

@@ -1,22 +1,24 @@
+import { defineConfig as oxlintDefineConfig } from 'oxlint';
+
 /**
  * Shared oxlint preset for Apify projects.
  *
- * Spread it into your `oxlint.config.{ts,js,mjs}`:
+ * Most consumers should call {@link defineConfig} below — it merges the
+ * preset with project-local additions and returns a typed `OxlintConfig`,
+ * which avoids declaration-emit issues in `composite` TS projects:
  *
- *     import { defineConfig } from 'oxlint';
- *     import sharedConfig from '@apify/oxlint-config';
+ *     import { defineConfig } from '@apify/oxlint-config';
  *
  *     export default defineConfig({
- *         ...sharedConfig,
- *         plugins: [...sharedConfig.plugins, 'react'],
- *         overrides: [
- *             ...sharedConfig.overrides,
- *             // local overrides go here
- *         ],
+ *         plugins: ['react'],
+ *         overrides: [{ files: [...], rules: {...} }],
  *     });
+ *
+ * The raw preset is still exported as the default if you want to spread
+ * manually.
  */
-export default {
-    plugins: ['typescript', 'import', 'unicorn', 'jest', 'promise'],
+const sharedConfig = {
+    plugins: ['typescript', 'import', 'unicorn', 'jest', 'vitest', 'promise'],
     env: {
         node: true,
         browser: true,
@@ -146,6 +148,8 @@ export default {
                 'jest/no-conditional-expect': 'error',
                 'jest/no-focused-tests': 'error',
                 'jest/valid-expect': 'off',
+                'vitest/hoisted-apis-on-top': 'error',
+                'vitest/no-conditional-tests': 'error',
                 'import/no-default-export': 'off',
             },
         },
@@ -167,3 +171,32 @@ export default {
         },
     ],
 };
+
+export default sharedConfig;
+
+/**
+ * Wraps oxlint's `defineConfig` to merge a project-local config on top of
+ * the Apify preset. Arrays (`plugins`, `overrides`) are concatenated;
+ * objects (`rules`, `env`) are shallow-merged with the consumer winning;
+ * everything else (`ignorePatterns`, `jsPlugins`, `categories`, …) is
+ * passed through unchanged.
+ *
+ * @param {Partial<import('oxlint').OxlintConfig>} [overrides]
+ * @returns {import('oxlint').OxlintConfig}
+ */
+export function defineConfig(overrides = {}) {
+    return oxlintDefineConfig({
+        ...sharedConfig,
+        ...overrides,
+        plugins: overrides.plugins
+            ? [...sharedConfig.plugins, ...overrides.plugins]
+            : sharedConfig.plugins,
+        overrides: overrides.overrides
+            ? [...sharedConfig.overrides, ...overrides.overrides]
+            : sharedConfig.overrides,
+        rules: overrides.rules
+            ? { ...sharedConfig.rules, ...overrides.rules }
+            : sharedConfig.rules,
+        env: overrides.env ? { ...sharedConfig.env, ...overrides.env } : sharedConfig.env,
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@apify/oxlint-config",
-    "version": "0.2.1",
+    "version": "0.2.3",
     "description": "Apify oxlint preset to be shared between projects.",
     "repository": {
         "url": "https://github.com/apify/apify-oxlint-config"
@@ -22,7 +22,7 @@
         "test": "echo \"No tests specified\" && exit 0"
     },
     "peerDependencies": {
-        "oxlint": ">=1.60.0"
+        "oxlint": "^1.61.0"
     },
     "author": "Apify team <info@apify.com>",
     "license": "Apache-2.0"