@cleeviox/knip 0.1.0 → 0.1.2

package/README.md

@@ -20,41 +20,51 @@ bun add --dev @cleeviox/knip knip
 
 ## Usage
 
-### Monorepo Root
+All configurations are created with `defineConfig(base, overrides?)`. It performs a shallow merge of the base and overrides, while **appending** the `ignore`, `ignoreDependencies`, and `project` arrays rather than overwriting them.
 
-For a monorepo, create a `knip.ts` file in the repository root:
+### Monorepo Root
 
 ```ts
-import { monorepoRootConfig } from '@cleeviox/knip';
-import type { KnipConfig } from 'knip';
-
-/**
- * @filename: knip.ts
- */
-export default {
-  ...monorepoRootConfig,
-} satisfies KnipConfig;
+import { defineConfig, baseMonorepoRootConfig } from '@cleeviox/knip';
+
+export default defineConfig(baseMonorepoRootConfig);
 ```
 
 ### Next.js Projects
 
-For a Next.js project, create a `knip.ts` file in your project root:
+```ts
+import { defineConfig, baseNextjsConfig } from '@cleeviox/knip';
+
+export default defineConfig(baseNextjsConfig);
+```
+
+To extend a base config, pass overrides as the second argument:
 
 ```ts
-import { nextjsConfig } from '@cleeviox/knip';
-import type { KnipConfig } from 'knip';
-
-/**
- * @filename: knip.ts
- */
-export default {
-  ...nextjsConfig,
-} satisfies KnipConfig;
+import { defineConfig, baseNextjsConfig } from '@cleeviox/knip';
+
+export default defineConfig(baseNextjsConfig, {
+  ignoreDependencies: ['my-extra-dep'],
+  ignore: ['src/generated/**'],
+});
+```
+
+You can also compose a fully custom config without a base:
+
+```ts
+import { defineConfig } from '@cleeviox/knip';
+
+export default defineConfig({
+  project: ['src/**/*.ts'],
+  ignoreDependencies: ['some-dep'],
+});
 ```
 
-## Available Configurations
+## Available Exports
 
 | Export | Description |
 |--------|-------------|
-| `monorepoRootConfig` | Configuration for monorepo roots with workspace support |
-| `nextjsConfig` | Configuration for Next.js projects |
+| `defineConfig` | Factory function — merges a base config with optional overrides, appending array fields |
+| `baseNextjsConfig` | Base config for Next.js projects |
+| `baseMonorepoRootConfig` | Base config for monorepo roots with workspace support |
+| `KnipConfigObject` | TypeScript type for a knip configuration object |

package/dist/define-config.d.ts

@@ -0,0 +1,2 @@
+import type { KnipConfigObject } from './types/index.js';
+export declare function defineConfig(base: KnipConfigObject, overrides?: KnipConfigObject): KnipConfigObject;

package/dist/define-config.js

@@ -0,0 +1,10 @@
+export function defineConfig(base, overrides) {
+    return {
+        ...base,
+        ...overrides,
+        ignore: [...(base.ignore ?? []), ...(overrides?.ignore ?? [])],
+        ignoreDependencies: [...(base.ignoreDependencies ?? []), ...(overrides?.ignoreDependencies ?? [])],
+        project: [...(base.project ?? []), ...(overrides?.project ?? [])],
+    };
+}
+//# sourceMappingURL=define-config.js.map

package/dist/define-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"define-config.js","sourceRoot":"","sources":["../src/define-config.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,YAAY,CAAC,IAAsB,EAAE,SAA4B;IAC/E,OAAO;QACL,GAAG,IAAI;QACP,GAAG,SAAS;QACZ,MAAM,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,SAAS,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC;QAC9D,kBAAkB,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,kBAAkB,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,SAAS,EAAE,kBAAkB,IAAI,EAAE,CAAC,CAAC;QAClG,OAAO,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,SAAS,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC;KAClE,CAAC;AACJ,CAAC"}

package/dist/index.d.ts

@@ -1,2 +1,4 @@
-export { monorepoRootConfig } from './monorepo-root.js';
-export { nextjsConfig } from './nextjs.js';
+export { defineConfig } from './define-config.js';
+export { baseMonorepoRootConfig } from './monorepo-root/index.js';
+export { baseNextjsConfig } from './nextjs/index.js';
+export type { KnipConfigObject } from './types/index.js';

package/dist/index.js

@@ -1,4 +1,4 @@
-// biome-ignore lint/performance/noBarrelFile: TODO - This should be overridden in biome.jsonc file of this workspace.
-export { monorepoRootConfig } from './monorepo-root.js';
-export { nextjsConfig } from './nextjs.js';
+export { defineConfig } from './define-config.js';
+export { baseMonorepoRootConfig } from './monorepo-root/index.js';
+export { baseNextjsConfig } from './nextjs/index.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,sHAAsH;AACtH,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/monorepo-root/index.d.ts

@@ -0,0 +1 @@
+export { baseMonorepoRootConfig } from './monorepo-root.js';

package/dist/monorepo-root/index.js

@@ -0,0 +1,2 @@
+export { baseMonorepoRootConfig } from './monorepo-root.js';
+//# sourceMappingURL=index.js.map

package/dist/monorepo-root/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/monorepo-root/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/{monorepo-root.d.ts → monorepo-root/monorepo-root.d.ts}

@@ -1,4 +1,4 @@
-export declare const monorepoRootConfig: {
+export declare const baseMonorepoRootConfig: {
     workspaces: {
         '.': {
             entry: string;

package/dist/{monorepo-root.js → monorepo-root/monorepo-root.js}

@@ -1,12 +1,12 @@
-export const monorepoRootConfig = {
+export const baseMonorepoRootConfig = {
     workspaces: {
         '.': {
             entry: 'scripts/*.js',
             project: 'scripts/**/*.js',
         },
         'packages/*': {
-            entry: '{index,cli}.ts',
-            project: '**/*.ts',
+            entry: 'src/{index,cli}.ts',
+            project: 'src/*.{ts,tsx}',
         },
     },
 };

package/dist/monorepo-root/monorepo-root.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"monorepo-root.js","sourceRoot":"","sources":["../../src/monorepo-root/monorepo-root.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,UAAU,EAAE;QACV,GAAG,EAAE;YACH,KAAK,EAAE,cAAc;YACrB,OAAO,EAAE,iBAAiB;SAC3B;QACD,YAAY,EAAE;YACZ,KAAK,EAAE,oBAAoB;YAC3B,OAAO,EAAE,gBAAgB;SAC1B;KACF;CACyB,CAAC"}

package/dist/nextjs/index.d.ts

@@ -0,0 +1 @@
+export { baseNextjsConfig } from './nextjs.js';

package/dist/nextjs/index.js

@@ -0,0 +1,2 @@
+export { baseNextjsConfig } from './nextjs.js';
+//# sourceMappingURL=index.js.map

package/dist/nextjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/nextjs/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC"}

package/dist/{nextjs.d.ts → nextjs/nextjs.d.ts}

@@ -1,4 +1,4 @@
-export declare const nextjsConfig: {
+export declare const baseNextjsConfig: {
     ignore: string[];
     ignoreDependencies: string[];
     ignoreExportsUsedInFile: true;

package/dist/{nextjs.js → nextjs/nextjs.js}

@@ -1,4 +1,4 @@
-export const nextjsConfig = {
+export const baseNextjsConfig = {
     ignore: ['src/assets/components/icons/**'],
     ignoreDependencies: ['@changesets/cli', 'orval', 'postcss', 'tailwindcss', '@cleeviox/knip'],
     ignoreExportsUsedInFile: true,

package/dist/nextjs/nextjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nextjs.js","sourceRoot":"","sources":["../../src/nextjs/nextjs.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,MAAM,EAAE,CAAC,gCAAgC,CAAC;IAC1C,kBAAkB,EAAE,CAAC,iBAAiB,EAAE,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,gBAAgB,CAAC;IAC5F,uBAAuB,EAAE,IAAI;IAC7B,IAAI,EAAE;QACJ,KAAK,EAAE,CAAC,qBAAqB,EAAE,uBAAuB,EAAE,wBAAwB,EAAE,sBAAsB,CAAC;KAC1G;IACD,OAAO,EAAE,CAAC,mBAAmB,EAAE,qBAAqB,CAAC;CAC3B,CAAC"}

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+import type { KnipConfig } from 'knip';
+export type KnipConfigObject = Exclude<KnipConfig, (...args: never[]) => unknown>;

package/dist/types/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":""}

package/package.json

@@ -4,6 +4,7 @@
   },
   "description": "Knip configuration used on CleevioX projects",
   "devDependencies": {
+    "@types/bun": "^1.3.9",
     "knip": "^5.85.0"
   },
   "exports": {
@@ -33,16 +34,19 @@
   "scripts": {
     "build": "tsc --build tsconfig.build.json",
     "check": "biome check --write .",
-    "clean": "del .turbo tsconfig.tsbuildinfo tsconfig.build.tsbuildinfo dist node_modules",
+    "clean": "del .turbo tsconfig.tsbuildinfo tsconfig.build.tsbuildinfo dist coverage node_modules",
     "fix": "run-s biome:check:fix ts",
     "format": "biome format .",
     "format:fix": "biome format --write .",
     "lint": "biome lint .",
     "lint:fix": "biome lint --write .",
     "prebuild": "del dist tsconfig.build.tsbuildinfo",
+    "test": "bun test",
+    "test:cov": "bun test --coverage --coverage-reporter=lcov",
+    "test:watch": "bun test --watch",
     "ts": "tsc --build tsconfig.json"
   },
   "sideEffects": false,
   "type": "module",
-  "version": "0.1.0"
+  "version": "0.1.2"
 }

package/dist/monorepo-root.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"monorepo-root.js","sourceRoot":"","sources":["../src/monorepo-root.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,UAAU,EAAE;QACV,GAAG,EAAE;YACH,KAAK,EAAE,cAAc;YACrB,OAAO,EAAE,iBAAiB;SAC3B;QACD,YAAY,EAAE;YACZ,KAAK,EAAE,gBAAgB;YACvB,OAAO,EAAE,SAAS;SACnB;KACF;CACmB,CAAC"}

package/dist/nextjs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"nextjs.js","sourceRoot":"","sources":["../src/nextjs.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,MAAM,EAAE,CAAC,gCAAgC,CAAC;IAC1C,kBAAkB,EAAE,CAAC,iBAAiB,EAAE,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,gBAAgB,CAAC;IAC5F,uBAAuB,EAAE,IAAI;IAC7B,IAAI,EAAE;QACJ,KAAK,EAAE,CAAC,qBAAqB,EAAE,uBAAuB,EAAE,wBAAwB,EAAE,sBAAsB,CAAC;KAC1G;IACD,OAAO,EAAE,CAAC,mBAAmB,EAAE,qBAAqB,CAAC;CACjC,CAAC"}