@ankhorage/devtools 1.0.2 → 1.0.3

package/README.md

@@ -1,11 +1,12 @@
 # devtools
 
-Shared ESLint and Prettier configuration for modern TypeScript projects.
+Shared ESLint, Prettier, and Knip configuration for modern TypeScript projects.
 
 ## What you get
 
 - Consistent linting across repos
 - Zero-config Prettier setup
+- Shared Knip static-analysis defaults
 - Strict TypeScript rules without compromise
 - One source of truth for tooling
 
@@ -14,6 +15,7 @@ Shared ESLint and Prettier configuration for modern TypeScript projects.
 - Flat ESLint config (latest standard)
 - Preconfigured plugin ecosystem
 - Prettier integration
+- Shared Knip config factory
 - Monorepo-friendly
 
 ## Installation
@@ -22,6 +24,12 @@ Shared ESLint and Prettier configuration for modern TypeScript projects.
 bun add -D @ankhorage/devtools
 ```
 
+Install the tools used by your local scripts as development dependencies:
+
+```bash
+bun add -D eslint prettier knip
+```
+
 ## Usage
 
 ### ESLint
@@ -40,15 +48,71 @@ export default config();
 }
 ```
 
+### Knip
+
+Create a repo-local `knip.config.ts` file:
+
+```ts
+import { createKnipConfig } from '@ankhorage/devtools/knip';
+
+export default createKnipConfig();
+```
+
+Add a package script:
+
+```json
+{
+  "scripts": {
+    "knip": "knip"
+  }
+}
+```
+
+Repos can add narrow repo-specific patterns when needed:
+
+```ts
+import { createKnipConfig } from '@ankhorage/devtools/knip';
+
+export default createKnipConfig({
+  entry: ['scripts/release.ts'],
+  project: ['scripts/**/*.ts'],
+  ignore: ['fixtures/**'],
+});
+```
+
+The shared config intentionally keeps defaults narrow so Knip does not fail on unmatched optional paths. Prefer explicit `entry`, `project`, or Knip plugin configuration over broad ignores when tool config files are reported as unused.
+
+### CI
+
+Run Knip in CI after dependencies are installed:
+
+```yaml
+- name: Run Knip
+  run: bun run knip
+```
+
+For workflows that support optional scripts, use the same guard style as the other devtools checks:
+
+```yaml
+- name: Run Knip
+  run: |
+    if node -e "const p=require('./package.json'); process.exit(p.scripts?.knip ? 0 : 1)"; then
+      bun run knip
+    else
+      echo "No knip script found; skipping."
+    fi
+```
+
 ## Use Cases
 
 - Monorepos with shared standards
 - Teams that want strict, predictable linting
 - Projects avoiding duplicated config
+- Repos that need consistent unused-file, unused-export, and dependency checks
 
 ## Why this exists
 
-Maintaining ESLint + Prettier configs across multiple repositories leads to:
+Maintaining ESLint, Prettier, and Knip configs across multiple repositories leads to:
 
 - duplication
 - inconsistency
@@ -62,6 +126,7 @@ Includes:
 
 - ESLint configuration
 - Prettier configuration
+- Knip configuration
 
 Excludes:
 

package/dist/knip.d.ts

@@ -0,0 +1,12 @@
+import type { KnipConfig } from 'knip';
+export interface DevtoolsKnipWorkspaceConfigOptions {
+    entry?: string[];
+    project?: string[];
+    ignore?: string[];
+    ignoreDependencies?: (string | RegExp)[];
+    ignoreFiles?: string[];
+}
+export interface DevtoolsKnipConfigOptions extends DevtoolsKnipWorkspaceConfigOptions {
+    workspaces?: Record<string, DevtoolsKnipWorkspaceConfigOptions>;
+}
+export declare function createKnipConfig(options?: DevtoolsKnipConfigOptions): KnipConfig;

package/dist/knip.js

@@ -0,0 +1,12 @@
+export function createKnipConfig(options = {}) {
+    return {
+        ...(options.entry === undefined ? {} : { entry: options.entry }),
+        ...(options.project === undefined ? {} : { project: options.project }),
+        ...(options.ignore === undefined ? {} : { ignore: options.ignore }),
+        ...(options.ignoreDependencies === undefined
+            ? {}
+            : { ignoreDependencies: options.ignoreDependencies }),
+        ...(options.ignoreFiles === undefined ? {} : { ignoreFiles: options.ignoreFiles }),
+        ...(options.workspaces === undefined ? {} : { workspaces: options.workspaces }),
+    };
+}

package/dist/types.d.ts

@@ -1,7 +1,7 @@
 import type tseslint from 'typescript-eslint';
-export type FlatConfig = ReturnType<typeof tseslint.config>;
+type FlatConfig = ReturnType<typeof tseslint.config>;
 export type FlatConfigItem = FlatConfig[number];
-export interface RestrictedImport {
+interface RestrictedImport {
     name: string;
     message: string;
 }
@@ -15,3 +15,4 @@ export interface DevtoolsConfigOptions {
     overrides?: FlatConfigItem[];
     includePrettier?: boolean;
 }
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ankhorage/devtools",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Shared Lint and Format Configuration for Ankhorage",
   "homepage": "https://github.com/ankhorage/devtools#readme",
   "bugs": {
@@ -14,11 +14,25 @@
   "publishConfig": {
     "access": "public"
   },
+  "keywords": [
+    "typescript",
+    "eslint",
+    "prettier",
+    "knip",
+    "linting",
+    "formatting",
+    "static-analysis",
+    "developer-tools"
+  ],
   "exports": {
     "./eslint": {
       "types": "./dist/eslint.d.ts",
       "import": "./dist/eslint.js"
     },
+    "./knip": {
+      "types": "./dist/knip.d.ts",
+      "import": "./dist/knip.js"
+    },
     "./prettier": {
       "require": "./dist/prettier.cjs"
     }
@@ -31,6 +45,7 @@
   ],
   "scripts": {
     "build": "tsc && cp src/prettier.cjs dist/prettier.cjs",
+    "knip": "knip",
     "lint": "eslint .",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
@@ -52,6 +67,7 @@
     "@changesets/cli": "^2.30.0",
     "@types/bun": "^1.3.13",
     "@types/node": "^25.2.3",
+    "knip": "^6.12.2",
     "typescript": "^5.9.3"
   },
   "packageManager": "bun@1.3.13"