feat: add experimental mode for extended file pruning

ali-master · ali-master · commit 86ab33999f71 · 2025-08-09T18:42:41.000+03:30
- Introduce `--experimental-default-files` option for aggressive pruning.
- Update CLI help and README with experimental usage examples.
- Modify `Pruner` class to handle experimental file lists.
- Enhance tests to cover experimental mode functionality.
diff --git a/README.md b/README.md
@@ -104,6 +104,7 @@ Options:
   -w, --workspace       Enable workspace/monorepo mode
   --workspace-root <dir> Specify workspace root (auto-detected if not provided)
   --no-root             Skip pruning root node_modules in workspace mode
+  --experimental-default-files Enable experimental extended file list for more aggressive pruning
   -h, --help            Show help
 
 Examples:
@@ -116,6 +117,10 @@ Workspace Examples:
   prune-mod --workspace                 # Auto-detect and prune all packages
   prune-mod -w --no-root               # Prune only package node_modules
   prune-mod -w --workspace-root /monorepo # Specify workspace root
+  
+Experimental Examples:
+  prune-mod --experimental-default-files    # Use extended file list
+  prune-mod -w --experimental-default-files # Combine with workspace mode
 ```
 
 ### Real-world examples
@@ -193,6 +198,30 @@ prune-mod safely removes these types of files:
 - Binary executables
 - Critical system files
 
+### Experimental Extended File List
+
+For even more aggressive space savings, prune-mod offers an experimental mode that removes additional safe files:
+
+```bash
+# Enable experimental extended file list
+prune-mod --experimental-default-files
+
+# Use with other options
+prune-mod --experimental-default-files --workspace --verbose
+```
+
+**Experimental mode adds 140+ additional file patterns** including:
+- Extended documentation files (CHANGELOG.md, CODE_OF_CONDUCT.md, SECURITY.md)
+- Advanced configuration files (webpack.config.*, rollup.config.*, vite.config.*)
+- Git and version control files (.gitignore, .gitkeep, .dockerignore)
+- CI/CD configurations (azure-pipelines.yml, .drone.yml, buildkite.yml)
+- Code quality tools (.codeclimate.yml, codecov.yml, sonar-project.properties)
+- Build outputs and caches (dist/, build/, .cache/, .next/, .nuxt/)
+- Source maps and minified files (*.map, *.min.js, *.min.css)
+- Environment and runtime files (.env.example, .nvmrc, .python-version)
+
+**Safety note:** Experimental mode is thoroughly tested but more aggressive. Always test with `--dry-run` first to ensure it meets your needs.
+
 ## Programming API
 
 Use prune-mod in your Node.js applications:
@@ -205,7 +234,10 @@ const pruner = new Pruner({
   verbose: true,
   dryRun: false,
   exceptions: ['*.config.*'], // Files to keep
-  globs: ['**/*.tmp']        // Files to remove
+  globs: ['**/*.tmp'],        // Files to remove
+  experimental: {
+    defaultFiles: true        // Enable extended file list
+  }
 });
 
 const stats = await pruner.prune();
@@ -254,6 +286,11 @@ interface PrunerOptions {
   workspace?: boolean;    // Enable workspace mode (default: false)
   workspaceRoot?: string; // Custom workspace root (auto-detected if not set)
   includeRoot?: boolean;  // Include root node_modules (default: true)
+  
+  // Experimental options
+  experimental?: {
+    defaultFiles?: boolean; // Enable extended file list (default: false)
+  };
 }
 ```
 
diff --git a/src/cli.ts b/src/cli.ts
@@ -51,6 +51,11 @@ const { values, positionals } = parseArgs({
       default: false,
       description: "Skip pruning the root node_modules in workspace mode",
     },
+    "experimental-default-files": {
+      type: "boolean",
+      default: false,
+      description: "Enable experimental extended file list for more aggressive pruning",
+    },
   },
   strict: false,
   allowPositionals: true,
@@ -64,14 +69,15 @@ Usage:
   prune-mod [options] [directory]
 
 Options:
-  -v, --verbose         Verbose log output
-  --exclude <glob>      Glob of files that should not be pruned (can be specified multiple times)
-  --include <glob>      Globs of files that should always be pruned (can be specified multiple times)
-  -d, --dry-run         Show what would be pruned without actually removing files
-  -w, --workspace       Enable workspace/monorepo mode to prune all packages
-  --workspace-root <dir> Specify the workspace root directory (auto-detected if not provided)
-  --no-root             Skip pruning the root node_modules in workspace mode
-  -h, --help            Show help
+  -v, --verbose                   Verbose log output
+  --exclude <glob>                Glob of files that should not be pruned (can be specified multiple times)
+  --include <glob>                Globs of files that should always be pruned (can be specified multiple times)
+  -d, --dry-run                   Show what would be pruned without actually removing files
+  -w, --workspace                 Enable workspace/monorepo mode to prune all packages
+  --workspace-root <dir>          Specify the workspace root directory (auto-detected if not provided)
+  --no-root                       Skip pruning the root node_modules in workspace mode
+  --experimental-default-files    Enable experimental extended file list for more aggressive pruning
+  -h, --help                      Show help
 
 Examples:
   prune-mod                    # Prune node_modules in current directory
@@ -83,6 +89,10 @@ Workspace/Monorepo Examples:
   prune-mod --workspace        # Auto-detect and prune all packages in workspace
   prune-mod -w --no-root       # Prune only package node_modules, skip root
   prune-mod -w --workspace-root /path/to/monorepo  # Specify workspace root
+  
+Experimental Examples:
+  prune-mod --experimental-default-files  # Use extended file list for more aggressive pruning
+  prune-mod -w --experimental-default-files  # Combine workspace mode with experimental files
 `);
 }
 
@@ -108,6 +118,9 @@ async function main() {
     workspace: Boolean(values.workspace),
     workspaceRoot: values["workspace-root"] as string | undefined,
     includeRoot: !Boolean(values["no-root"]),
+    experimental: {
+      defaultFiles: Boolean(values["experimental-default-files"]),
+    },
   });
 
   try {
diff --git a/src/constants.ts b/src/constants.ts
@@ -69,6 +69,182 @@ export const DefaultFiles = [
   "tslint.json",
 ] as const;
 
+export const ExperimentalDefaultFiles = [
+  // Documentation & Project Files
+  "CHANGELOG",
+  "CHANGELOG.md",
+  "CHANGELOG.txt",
+  "HISTORY",
+  "HISTORY.md",
+  "CONTRIBUTING",
+  "CONTRIBUTING.md",
+  "CONTRIBUTING.txt",
+  "README.md",
+  "README.txt",
+  "README.rst",
+  "CODE_OF_CONDUCT.md",
+  "SECURITY.md",
+  "SUPPORT.md",
+  "FUNDING.yml",
+
+  // Extended Configuration Files
+  ".eslintrc.yaml",
+  ".babelrc.js",
+  ".babelrc.json",
+  "babel.config.js",
+  "babel.config.json",
+  "jest.config.json",
+  "jest.config.ts",
+  ".prettierrc.yaml",
+  "tsconfig.build.json",
+
+  // Git & Version Control
+  ".gitignore",
+  ".gitkeep",
+  ".gitmodules",
+  ".bzrignore",
+  ".hgignore",
+  ".svnignore",
+  ".dockerignore",
+
+  // Container & Deployment
+  "Dockerfile",
+  "docker-compose.yml",
+  "docker-compose.yaml",
+  "Procfile",
+
+  // Runtime Version Files
+  ".nvmrc",
+  ".node-version",
+  ".ruby-version",
+  ".python-version",
+
+  // Other Language Files
+  "Rakefile",
+  "Gemfile",
+  "Gemfile.lock",
+  "requirements.txt",
+  "setup.py",
+  "pyproject.toml",
+  ".pylintrc",
+  ".flake8",
+  ".mypy.ini",
+  "tox.ini",
+  "pytest.ini",
+
+  // Git Hooks & Pre-commit
+  ".pre-commit-config.yaml",
+  ".commitlintrc",
+  ".commitlintrc.js",
+  ".commitlintrc.json",
+  ".huskyrc",
+  ".huskyrc.js",
+  ".huskyrc.json",
+  ".lintstagedrc",
+  ".lintstagedrc.js",
+  ".lintstagedrc.json",
+  "lint-staged.config.js",
+
+  // Documentation Tools
+  ".remarkrc",
+  ".remarkrc.js",
+  ".remarkrc.json",
+  ".markdownlint.json",
+  ".markdownlint.yaml",
+  ".markdownlint.yml",
+
+  // Build Tools
+  "rollup.config.js",
+  "rollup.config.ts",
+  "webpack.config.js",
+  "webpack.config.ts",
+  "vite.config.js",
+  "vite.config.ts",
+  "vitest.config.js",
+  "vitest.config.ts",
+
+  // Bundle Analysis & Performance
+  ".size-limit.json",
+  "size-limit.config.js",
+  ".size-snapshot.json",
+  "bundlesize.config.js",
+  ".bundlewatch.config.js",
+
+  // Testing Frameworks
+  "ava.config.js",
+  "ava.config.json",
+  ".taprc",
+  "tap-snapshots",
+
+  // Coverage Tools
+  ".c8rc",
+  ".c8rc.js",
+  ".c8rc.json",
+  ".nycrc",
+  ".nycrc.js",
+  ".nycrc.json",
+  "nyc.config.js",
+  ".istanbul.yml",
+
+  // Repository Management
+  ".github_changelog_generator",
+  ".dependabot.yml",
+  ".renovaterc",
+  ".renovaterc.js",
+  ".renovaterc.json",
+  "renovate.json",
+  ".greenkeeper.json",
+
+  // CI/CD Services
+  "codefresh.yml",
+  "shippable.yml",
+  "wercker.yml",
+  ".drone.yml",
+  "azure-pipelines.yml",
+  "buildkite.yml",
+
+  // Code Quality Services
+  ".codeclimate.yml",
+  ".scrutinizer.yml",
+  ".sonarqube.yml",
+  "sonar-project.properties",
+  ".bettercodehub.yml",
+  ".codacy.yml",
+  "codecov.yml",
+  ".codecov.yml",
+
+  // Framework/Library Build Outputs
+  ".storybook",
+  "storybook-static",
+  ".next",
+  ".nuxt",
+  ".cache",
+  ".parcel-cache",
+  "dist",
+  "build",
+  "lib",
+  "esm",
+  "umd",
+  "cjs",
+  "es",
+  "types",
+  "typings",
+
+  // Source Maps & Minified Files
+  "*.d.ts.map",
+  "*.js.map",
+  "*.css.map",
+  "*.min.js",
+  "*.min.css",
+
+  // Environment Files
+  ".env.example",
+  ".env.local",
+  ".env.development",
+  ".env.production",
+  ".env.test",
+] as const;
+
 export const DefaultDirectories = [
   "__tests__",
   "test",
diff --git a/src/prune.ts b/src/prune.ts
@@ -1,7 +1,12 @@
 import * as fs from "fs";
 import { logger } from "./logger";
 import { minimatch } from "minimatch";
-import { DefaultDirectories, DefaultExtensions, DefaultFiles } from "./constants";
+import {
+  DefaultDirectories,
+  DefaultExtensions,
+  DefaultFiles,
+  ExperimentalDefaultFiles,
+} from "./constants";
 import type { PrunerOptions, Stats } from "./types";
 import { WorkspaceDetector, type WorkspaceInfo, WorkspaceType } from "./workspace";
 import {
@@ -46,7 +51,19 @@ export class Pruner {
     this.excepts = options.exceptions || [];
     this.globs = options.globs || [];
     this.dirs = new Set(options.directories || DefaultDirectories);
-    this.files = new Set(options.files || DefaultFiles);
+
+    // Handle experimental default files
+    let defaultFiles = [...DefaultFiles] as string[];
+    if (options.experimental?.defaultFiles) {
+      defaultFiles = [...DefaultFiles, ...ExperimentalDefaultFiles] as string[];
+      if (this.verbose) {
+        logger.info(
+          `Experimental mode: Using extended file list with ${ExperimentalDefaultFiles.length} additional files`,
+        );
+      }
+    }
+    this.files = new Set(options.files || defaultFiles);
+
     this.workspace = options.workspace || false;
     this.workspaceRoot = options.workspaceRoot;
     this.includeRoot = options.includeRoot !== false; // Default to true
diff --git a/src/types.ts b/src/types.ts
@@ -18,4 +18,7 @@ export interface PrunerOptions {
   workspace?: boolean;
   workspaceRoot?: string;
   includeRoot?: boolean;
+  experimental?: {
+    defaultFiles?: boolean;
+  };
 }
diff --git a/tests/prune.spec.ts b/tests/prune.spec.ts

Original file line number	Diff line number	Diff line change
`@@ -18,4 +18,7 @@ export interface PrunerOptions {`
`18`	`18`	`workspace?: boolean;`
`19`	`19`	`workspaceRoot?: string;`
`20`	`20`	`includeRoot?: boolean;`
	`21`	`+ experimental?: {`
	`22`	`+ defaultFiles?: boolean;`
	`23`	`+ };`
`21`	`24`	`}`