fallow 0.1.0 → 0.1.4

package/README.md

@@ -0,0 +1,73 @@
+# fallow
+
+Find dead code in JavaScript and TypeScript projects. Written in Rust.
+
+[![CI](https://github.com/BartWaardenburg/fallow/actions/workflows/ci.yml/badge.svg)](https://github.com/BartWaardenburg/fallow/actions/workflows/ci.yml)
+[![npm](https://img.shields.io/npm/v/fallow.svg)](https://www.npmjs.com/package/fallow)
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/bartwaardenburg/fallow/blob/main/LICENSE)
+
+Fallow detects unused files, exports, dependencies, types, enum members, and class members across your codebase. It is a drop-in alternative to [knip](https://knip.dev) that runs **25-50x faster** on real-world projects by using the [Oxc](https://oxc.rs) parser instead of the TypeScript compiler.
+
+## Installation
+
+```bash
+npm install -g fallow
+```
+
+## Usage
+
+```bash
+# Analyze your project
+fallow check
+
+# Watch mode
+fallow watch
+
+# Auto-fix unused exports and dependencies
+fallow fix --dry-run
+fallow fix
+
+# JSON output for CI
+fallow check --format json
+```
+
+## What it finds
+
+1. **Unused files** - files not imported anywhere
+2. **Unused exports** - exported symbols nobody imports
+3. **Unused types** - exported type aliases and interfaces
+4. **Unused dependencies** - packages in package.json not imported
+5. **Unused devDependencies** - dev packages not referenced
+6. **Unused enum members** - enum variants never accessed
+7. **Unused class members** - methods/properties never used
+8. **Unresolved imports** - imports that don't resolve to a file
+9. **Unlisted dependencies** - imported packages not in package.json
+10. **Duplicate exports** - same symbol exported from multiple files
+
+## Framework support
+
+Auto-detects and configures entry points for: Next.js, Vite, Vitest, Jest, Storybook, Remix, Astro, Nuxt, Angular, Playwright, Prisma, ESLint, TypeScript, Webpack, Tailwind, GraphQL Codegen, React Router.
+
+## Configuration
+
+Create a `fallow.toml` in your project root:
+
+```toml
+[entry]
+patterns = ["src/index.ts", "src/main.ts"]
+
+[ignore]
+files = ["**/*.test.ts", "**/*.spec.ts"]
+exports = ["src/public-api.ts"]
+dependencies = ["@types/*"]
+```
+
+Or generate one: `fallow init`
+
+## Documentation
+
+Full documentation at [github.com/bartwaardenburg/fallow](https://github.com/bartwaardenburg/fallow).
+
+## License
+
+MIT

package/bin/fallow

@@ -4,26 +4,33 @@ const { execFileSync } = require('child_process');
 const { join } = require('path');
 const { existsSync } = require('fs');
 
-const PLATFORMS = {
-  'darwin-arm64': '@nicholasgasior/fallow-darwin-arm64',
-  'darwin-x64': '@nicholasgasior/fallow-darwin-x64',
-  'linux-x64': '@nicholasgasior/fallow-linux-x64-gnu',
-  'linux-arm64': '@nicholasgasior/fallow-linux-arm64-gnu',
-  'win32-x64': '@nicholasgasior/fallow-win32-x64-msvc',
-};
+function getPlatformPackage() {
+  const platform = process.platform;
+  const arch = process.arch;
 
-const platformKey = `${process.platform}-${process.arch}`;
-const pkg = PLATFORMS[platformKey];
+  if (platform === 'win32' && arch === 'x64') {
+    return '@fallow-cli/win32-x64-msvc';
+  }
+  if (platform === 'darwin') {
+    return `@fallow-cli/darwin-${arch}`;
+  }
+  if (platform === 'linux') {
+    const { familySync } = require('detect-libc');
+    const libc = familySync() === 'musl' ? 'musl' : 'gnu';
+    return `@fallow-cli/linux-${arch}-${libc}`;
+  }
+
+  return null;
+}
+
+const pkg = getPlatformPackage();
 
 if (!pkg) {
-  console.error(`Unsupported platform: ${platformKey}`);
-  console.error(`Supported platforms: ${Object.keys(PLATFORMS).join(', ')}`);
+  console.error(`Unsupported platform: ${process.platform}-${process.arch}`);
   process.exit(1);
 }
 
 let binaryPath;
-
-// Try to find the binary in node_modules
 try {
   const pkgDir = require.resolve(`${pkg}/package.json`);
   const binaryName = process.platform === 'win32' ? 'fallow.exe' : 'fallow';

package/package.json

@@ -1,11 +1,15 @@
 {
   "name": "fallow",
-  "version": "0.1.0",
+  "version": "0.1.4",
   "description": "Find unused files, exports, and dependencies in JavaScript/TypeScript projects",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/nicholasgasior/fallow"
+    "url": "git+https://github.com/BartWaardenburg/fallow.git"
+  },
+  "homepage": "https://github.com/BartWaardenburg/fallow",
+  "bugs": {
+    "url": "https://github.com/BartWaardenburg/fallow/issues"
   },
   "keywords": [
     "dead-code",
@@ -17,21 +21,30 @@
     "typescript",
     "javascript"
   ],
+  "engines": {
+    "node": ">=16"
+  },
   "bin": {
     "fallow": "bin/fallow"
   },
   "files": [
     "bin",
-    "scripts"
+    "scripts",
+    "README.md"
   ],
   "scripts": {
     "postinstall": "node scripts/postinstall.js"
   },
+  "dependencies": {
+    "detect-libc": "^2.0.0"
+  },
   "optionalDependencies": {
-    "@nicholasgasior/fallow-darwin-arm64": "0.1.0",
-    "@nicholasgasior/fallow-darwin-x64": "0.1.0",
-    "@nicholasgasior/fallow-linux-x64-gnu": "0.1.0",
-    "@nicholasgasior/fallow-linux-arm64-gnu": "0.1.0",
-    "@nicholasgasior/fallow-win32-x64-msvc": "0.1.0"
+    "@fallow-cli/darwin-arm64": "0.1.4",
+    "@fallow-cli/darwin-x64": "0.1.4",
+    "@fallow-cli/linux-x64-gnu": "0.1.4",
+    "@fallow-cli/linux-arm64-gnu": "0.1.4",
+    "@fallow-cli/linux-x64-musl": "0.1.4",
+    "@fallow-cli/linux-arm64-musl": "0.1.4",
+    "@fallow-cli/win32-x64-msvc": "0.1.4"
   }
 }

package/scripts/postinstall.js

@@ -1,19 +1,33 @@
 // Verify the correct platform-specific package was installed
-const PLATFORMS = {
-  'darwin-arm64': '@nicholasgasior/fallow-darwin-arm64',
-  'darwin-x64': '@nicholasgasior/fallow-darwin-x64',
-  'linux-x64': '@nicholasgasior/fallow-linux-x64-gnu',
-  'linux-arm64': '@nicholasgasior/fallow-linux-arm64-gnu',
-  'win32-x64': '@nicholasgasior/fallow-win32-x64-msvc',
-};
+function getPlatformPackage() {
+  const platform = process.platform;
+  const arch = process.arch;
 
-const platformKey = `${process.platform}-${process.arch}`;
-const pkg = PLATFORMS[platformKey];
+  if (platform === 'win32' && arch === 'x64') {
+    return '@fallow-cli/win32-x64-msvc';
+  }
+  if (platform === 'darwin') {
+    return `@fallow-cli/darwin-${arch}`;
+  }
+  if (platform === 'linux') {
+    try {
+      const { familySync } = require('detect-libc');
+      const libc = familySync() === 'musl' ? 'musl' : 'gnu';
+      return `@fallow-cli/linux-${arch}-${libc}`;
+    } catch {
+      return `@fallow-cli/linux-${arch}-gnu`;
+    }
+  }
+
+  return null;
+}
+
+const pkg = getPlatformPackage();
 
 if (!pkg) {
   console.warn(
-    `fallow: No prebuilt binary for ${platformKey}. ` +
-    `You can build from source: https://github.com/nicholasgasior/fallow`
+    `fallow: No prebuilt binary for ${process.platform}-${process.arch}. ` +
+    `You can build from source: https://github.com/bartwaardenburg/fallow`
   );
   process.exit(0);
 }
@@ -24,6 +38,6 @@ try {
   console.warn(
     `fallow: Platform package ${pkg} not installed. ` +
     `This may happen if you used --no-optional. ` +
-    `Run 'npm install ${pkg}' to fix.`
+    `Run 'npm install' to fix.`
   );
 }