@ankhorage/devtools 1.0.2 → 1.0.4

package/README.md

@@ -1,11 +1,13 @@
 # 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
+- Bundled tool binaries for ESLint, Prettier, and Knip
 - Strict TypeScript rules without compromise
 - One source of truth for tooling
 
@@ -14,6 +16,8 @@ Shared ESLint and Prettier configuration for modern TypeScript projects.
 - Flat ESLint config (latest standard)
 - Preconfigured plugin ecosystem
 - Prettier integration
+- Shared Knip config factory
+- `ankhorage-eslint`, `ankhorage-prettier`, and `ankhorage-knip` binaries
 - Monorepo-friendly
 
 ## Installation
@@ -22,22 +26,105 @@ Shared ESLint and Prettier configuration for modern TypeScript projects.
 bun add -D @ankhorage/devtools
 ```
 
+The package owns the ESLint, Prettier, and Knip toolchain. Consuming repos should not install `eslint`, `prettier`, or `knip` directly unless they intentionally need a different version from the shared Ankhorage toolchain.
+
 ## Usage
 
+### Scripts
+
+Use the devtools-owned binaries in package scripts:
+
+```json
+{
+  "scripts": {
+    "lint": "ankhorage-eslint . --max-warnings=0",
+    "lint:fix": "ankhorage-eslint . --fix --max-warnings=0",
+    "format": "ankhorage-prettier --write .",
+    "format:check": "ankhorage-prettier --check .",
+    "knip": "ankhorage-knip"
+  }
+}
+```
+
 ### ESLint
 
+Create an `eslint.config.js` file:
+
 ```js
-import config from '@ankhorage/devtools/eslint';
+import { createConfig } from '@ankhorage/devtools/eslint';
 
-export default config();
+export default createConfig({
+  files: ['src/**/*.{ts,tsx}'],
+  project: ['./tsconfig.json'],
+  tsconfigRootDir: import.meta.dirname,
+});
 ```
 
 ### Prettier
 
-```json
-{
-  "extends": "@ankhorage/devtools/prettier"
-}
+Create a Prettier config file:
+
+```js
+export { default } from '@ankhorage/devtools/prettier';
+```
+
+CommonJS repos can use:
+
+```js
+module.exports = require('@ankhorage/devtools/prettier');
+```
+
+### Knip
+
+Create a repo-local `knip.config.ts` file:
+
+```ts
+import { createKnipConfig } from '@ankhorage/devtools/knip';
+
+export default createKnipConfig();
+```
+
+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/**'],
+  ignoreBinaries: ['custom-tool'],
+  ignoreFiles: ['examples/fixture.ts'],
+});
+```
+
+The shared config intentionally keeps defaults narrow so Knip can use its own zero-config package discovery. Prefer explicit `entry`, `project`, `ignoreBinaries`, `ignoreDependencies`, or `ignoreFiles` over broad ignores.
+
+### CI
+
+Run the scripts in CI after dependencies are installed:
+
+```yaml
+- name: Run lint
+  run: bun run lint
+
+- name: Run format check
+  run: bun run format:check
+
+- 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
@@ -45,10 +132,11 @@ export default config();
 - 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
@@ -60,8 +148,9 @@ This package centralizes tooling so all projects stay aligned.
 
 Includes:
 
-- ESLint configuration
-- Prettier configuration
+- ESLint configuration and binary wrapper
+- Prettier configuration and binary wrapper
+- Knip configuration and binary wrapper
 
 Excludes:
 

package/dist/eslint-cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/eslint-cli.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+import { runPackageBin } from './internal/runPackageBin.js';
+runPackageBin('eslint', 'eslint');

package/dist/internal/runPackageBin.d.ts

@@ -0,0 +1 @@
+export declare function runPackageBin(packageName: string, binName: string): void;

package/dist/internal/runPackageBin.js

@@ -0,0 +1,47 @@
+import { spawn } from 'node:child_process';
+import { readFileSync } from 'node:fs';
+import { createRequire } from 'node:module';
+import { dirname, resolve } from 'node:path';
+const require = createRequire(import.meta.url);
+function isRecord(value) {
+    return typeof value === 'object' && value !== null;
+}
+function readPackageBinPath(packageName, binName) {
+    const packageJsonPath = require.resolve(`${packageName}/package.json`);
+    const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf8'));
+    if (!isRecord(packageJson)) {
+        throw new Error(`Package metadata for ${packageName} is not an object.`);
+    }
+    const { bin } = packageJson;
+    let relativeBinPath;
+    if (typeof bin === 'string') {
+        relativeBinPath = bin;
+    }
+    else if (isRecord(bin)) {
+        const namedBin = bin[binName];
+        if (typeof namedBin === 'string') {
+            relativeBinPath = namedBin;
+        }
+    }
+    if (relativeBinPath === undefined) {
+        throw new Error(`Package ${packageName} does not expose a ${binName} binary.`);
+    }
+    return resolve(dirname(packageJsonPath), relativeBinPath);
+}
+export function runPackageBin(packageName, binName) {
+    const binPath = readPackageBinPath(packageName, binName);
+    const child = spawn(process.execPath, [binPath, ...process.argv.slice(2)], {
+        stdio: 'inherit',
+    });
+    child.on('error', (error) => {
+        console.error(error);
+        process.exit(1);
+    });
+    child.on('exit', (code, signal) => {
+        if (signal !== null) {
+            console.error(`${binName} exited with signal ${signal}.`);
+            process.exit(1);
+        }
+        process.exit(code ?? 1);
+    });
+}

package/dist/knip-cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/knip-cli.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+import { runPackageBin } from './internal/runPackageBin.js';
+runPackageBin('knip', 'knip');

package/dist/knip.d.ts

@@ -0,0 +1,13 @@
+import type { KnipConfig } from 'knip';
+export interface DevtoolsKnipWorkspaceConfigOptions {
+    entry?: string[];
+    project?: string[];
+    ignore?: string[];
+    ignoreBinaries?: 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,13 @@
+export function createKnipConfig(options = {}) {
+    return {
+        ...(options.entry === undefined ? {} : { entry: options.entry }),
+        ...(options.project === undefined ? {} : { project: options.project }),
+        ...(options.ignore === undefined ? {} : { ignore: options.ignore }),
+        ...(options.ignoreBinaries === undefined ? {} : { ignoreBinaries: options.ignoreBinaries }),
+        ...(options.ignoreDependencies === undefined
+            ? {}
+            : { ignoreDependencies: options.ignoreDependencies }),
+        ...(options.ignoreFiles === undefined ? {} : { ignoreFiles: options.ignoreFiles }),
+        ...(options.workspaces === undefined ? {} : { workspaces: options.workspaces }),
+    };
+}

package/dist/prettier-cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/prettier-cli.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+import { runPackageBin } from './internal/runPackageBin.js';
+runPackageBin('prettier', 'prettier');

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.4",
   "description": "Shared Lint and Format Configuration for Ankhorage",
   "homepage": "https://github.com/ankhorage/devtools#readme",
   "bugs": {
@@ -14,11 +14,30 @@
   "publishConfig": {
     "access": "public"
   },
+  "keywords": [
+    "typescript",
+    "eslint",
+    "prettier",
+    "knip",
+    "linting",
+    "formatting",
+    "static-analysis",
+    "developer-tools"
+  ],
+  "bin": {
+    "ankhorage-eslint": "./dist/eslint-cli.js",
+    "ankhorage-knip": "./dist/knip-cli.js",
+    "ankhorage-prettier": "./dist/prettier-cli.js"
+  },
   "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,7 +50,9 @@
   ],
   "scripts": {
     "build": "tsc && cp src/prettier.cjs dist/prettier.cjs",
+    "knip": "knip",
     "lint": "eslint .",
+    "lint:fix": "eslint . --fix --max-warnings=0",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
     "test": "bun test",
@@ -45,6 +66,7 @@
     "eslint-plugin-prettier": "^5.5.5",
     "eslint-plugin-simple-import-sort": "^12.1.1",
     "eslint-plugin-unused-imports": "^4.4.1",
+    "knip": "^6.12.2",
     "prettier": "^3.8.1",
     "typescript-eslint": "^8.24.0"
   },