@jpp-toolkit/plugin-clean 0.0.11

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Julien Papini
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.mts

@@ -0,0 +1,25 @@
+import { Command } from "@jpp-toolkit/core";
+import * as _oclif_core_interfaces0 from "@oclif/core/interfaces";
+
+//#region src/clean-command.d.ts
+declare class CleanCommand extends Command {
+  static summary: string;
+  static flags: {
+    'dry-run': _oclif_core_interfaces0.BooleanFlag<boolean>;
+    reset: _oclif_core_interfaces0.BooleanFlag<boolean>;
+    root: _oclif_core_interfaces0.BooleanFlag<boolean>;
+  };
+  static examples: {
+    description: string;
+    command: string;
+  }[];
+  run(): Promise<void>;
+}
+//#endregion
+//#region src/index.d.ts
+declare const commands: {
+  clean: typeof CleanCommand;
+};
+//#endregion
+export { commands };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -0,0 +1,88 @@
+import path from "node:path";
+import { Command } from "@jpp-toolkit/core";
+import { findProjectRoot } from "@jpp-toolkit/utils";
+import { Flags } from "@oclif/core";
+import { execa } from "execa";
+import { rimraf } from "rimraf";
+
+//#region src/clean-command.ts
+const RESET_PATTERNS = ["!old", "!tmp"];
+const CLEAN_PATTERNS = [
+	...RESET_PATTERNS,
+	"!node_modules",
+	"!node_modules/**",
+	"**/node_modules/.cache",
+	"!**/hooks/_",
+	"!**/hooks/_/**",
+	"!.env"
+];
+var CleanCommand = class CleanCommand extends Command {
+	static summary = "Remove build artifacts and temporary files from the project.";
+	static flags = {
+		"dry-run": Flags.boolean({
+			char: "d",
+			description: "Perform a dry run without deleting files.",
+			default: false
+		}),
+		"reset": Flags.boolean({
+			char: "r",
+			description: "Reset the project to a clean state.",
+			default: false
+		}),
+		"root": Flags.boolean({
+			char: "R",
+			description: "Clean from the project root directory.",
+			default: false
+		})
+	};
+	static examples = [
+		{
+			description: "Perform a dry run of the clean command.",
+			command: "<%= config.bin %> <%= command.id %> --dry-run"
+		},
+		{
+			description: "Reset the project to a clean state.",
+			command: "<%= config.bin %> <%= command.id %> --reset"
+		},
+		{
+			description: "Clean from the project root directory.",
+			command: "<%= config.bin %> <%= command.id %> --root"
+		}
+	];
+	async run() {
+		const { flags } = await this.parse(CleanCommand);
+		const cwd = flags.root ? findProjectRoot() : process.cwd();
+		const { stdout } = await execa("git", [
+			"ls-files",
+			"--others",
+			"--ignored",
+			"--exclude-standard",
+			"--directory",
+			...(flags.reset ? RESET_PATTERNS : CLEAN_PATTERNS).map((pattern) => `--exclude=${pattern}`)
+		], {
+			cwd,
+			lines: true
+		});
+		const paths = stdout.filter((line) => line.trim().length > 0).map((filePath) => path.resolve(cwd, filePath));
+		if (paths.length === 0) {
+			this.logger.info("No files to clean");
+			return;
+		}
+		if (flags["dry-run"]) {
+			this.logger.info("The following files would be removed:");
+			this.logger.paths(paths);
+			return;
+		}
+		await rimraf(paths);
+		this.logger.success("Cleaned the following files:");
+		this.logger.paths(paths);
+	}
+};
+
+//#endregion
+//#region src/index.ts
+const commands = { clean: CleanCommand };
+
+//#endregion
+export { commands };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/clean-command.ts","../src/index.ts"],"sourcesContent":["import path from 'node:path';\n\nimport { Command } from '@jpp-toolkit/core';\nimport { findProjectRoot } from '@jpp-toolkit/utils';\nimport { Flags } from '@oclif/core';\nimport { execa } from 'execa';\nimport { rimraf } from 'rimraf';\n\nconst RESET_PATTERNS = ['!old', '!tmp'];\nconst CLEAN_PATTERNS = [\n    ...RESET_PATTERNS,\n    '!node_modules',\n    '!node_modules/**',\n    '**/node_modules/.cache',\n    '!**/hooks/_',\n    '!**/hooks/_/**',\n    '!.env',\n];\n\nexport class CleanCommand extends Command {\n    static override summary = 'Remove build artifacts and temporary files from the project.';\n\n    static override flags = {\n        'dry-run': Flags.boolean({\n            char: 'd',\n            description: 'Perform a dry run without deleting files.',\n            default: false,\n        }),\n        'reset': Flags.boolean({\n            char: 'r',\n            description: 'Reset the project to a clean state.',\n            default: false,\n        }),\n        'root': Flags.boolean({\n            char: 'R',\n            description: 'Clean from the project root directory.',\n            default: false,\n        }),\n    };\n\n    static override examples = [\n        {\n            description: 'Perform a dry run of the clean command.',\n            command: '<%= config.bin %> <%= command.id %> --dry-run',\n        },\n        {\n            description: 'Reset the project to a clean state.',\n            command: '<%= config.bin %> <%= command.id %> --reset',\n        },\n        {\n            description: 'Clean from the project root directory.',\n            command: '<%= config.bin %> <%= command.id %> --root',\n        },\n    ];\n\n    public async run(): Promise<void> {\n        const { flags } = await this.parse(CleanCommand);\n\n        const cwd = flags.root ? findProjectRoot() : process.cwd();\n        const patterns = flags.reset ? RESET_PATTERNS : CLEAN_PATTERNS;\n\n        const { stdout } = await execa(\n            'git',\n            [\n                'ls-files',\n                '--others',\n                '--ignored',\n                '--exclude-standard',\n                '--directory',\n                ...patterns.map((pattern) => `--exclude=${pattern}`),\n            ],\n            { cwd, lines: true },\n        );\n\n        const paths = stdout\n            .filter((line) => line.trim().length > 0)\n            .map((filePath) => path.resolve(cwd, filePath));\n\n        if (paths.length === 0) {\n            this.logger.info('No files to clean');\n            return;\n        }\n\n        if (flags['dry-run']) {\n            this.logger.info('The following files would be removed:');\n            this.logger.paths(paths);\n            return;\n        }\n\n        await rimraf(paths);\n\n        this.logger.success('Cleaned the following files:');\n        this.logger.paths(paths);\n    }\n}\n","import { CleanCommand } from './clean-command';\n\nexport const commands = {\n    clean: CleanCommand,\n};\n"],"mappings":";;;;;;;;AAQA,MAAM,iBAAiB,CAAC,QAAQ,OAAO;AACvC,MAAM,iBAAiB;CACnB,GAAG;CACH;CACA;CACA;CACA;CACA;CACA;CACH;AAED,IAAa,eAAb,MAAa,qBAAqB,QAAQ;CACtC,OAAgB,UAAU;CAE1B,OAAgB,QAAQ;EACpB,WAAW,MAAM,QAAQ;GACrB,MAAM;GACN,aAAa;GACb,SAAS;GACZ,CAAC;EACF,SAAS,MAAM,QAAQ;GACnB,MAAM;GACN,aAAa;GACb,SAAS;GACZ,CAAC;EACF,QAAQ,MAAM,QAAQ;GAClB,MAAM;GACN,aAAa;GACb,SAAS;GACZ,CAAC;EACL;CAED,OAAgB,WAAW;EACvB;GACI,aAAa;GACb,SAAS;GACZ;EACD;GACI,aAAa;GACb,SAAS;GACZ;EACD;GACI,aAAa;GACb,SAAS;GACZ;EACJ;CAED,MAAa,MAAqB;EAC9B,MAAM,EAAE,UAAU,MAAM,KAAK,MAAM,aAAa;EAEhD,MAAM,MAAM,MAAM,OAAO,iBAAiB,GAAG,QAAQ,KAAK;EAG1D,MAAM,EAAE,WAAW,MAAM,MACrB,OACA;GACI;GACA;GACA;GACA;GACA;GACA,IAVS,MAAM,QAAQ,iBAAiB,gBAU5B,KAAK,YAAY,aAAa,UAAU;GACvD,EACD;GAAE;GAAK,OAAO;GAAM,CACvB;EAED,MAAM,QAAQ,OACT,QAAQ,SAAS,KAAK,MAAM,CAAC,SAAS,EAAE,CACxC,KAAK,aAAa,KAAK,QAAQ,KAAK,SAAS,CAAC;AAEnD,MAAI,MAAM,WAAW,GAAG;AACpB,QAAK,OAAO,KAAK,oBAAoB;AACrC;;AAGJ,MAAI,MAAM,YAAY;AAClB,QAAK,OAAO,KAAK,wCAAwC;AACzD,QAAK,OAAO,MAAM,MAAM;AACxB;;AAGJ,QAAM,OAAO,MAAM;AAEnB,OAAK,OAAO,QAAQ,+BAA+B;AACnD,OAAK,OAAO,MAAM,MAAM;;;;;;AC1FhC,MAAa,WAAW,EACpB,OAAO,cACV"}

package/oclif.config.js

@@ -0,0 +1,8 @@
+export default {
+    description: 'Plugin that add the clean command to the jpp cli.',
+    commands: {
+        strategy: 'explicit',
+        target: './dist/index.mjs',
+        identifier: 'commands',
+    },
+};

package/oclif.manifest.json

@@ -0,0 +1,54 @@
+{
+  "commands": {
+    "clean": {
+      "aliases": [],
+      "args": {},
+      "examples": [
+        {
+          "description": "Perform a dry run of the clean command.",
+          "command": "<%= config.bin %> <%= command.id %> --dry-run"
+        },
+        {
+          "description": "Reset the project to a clean state.",
+          "command": "<%= config.bin %> <%= command.id %> --reset"
+        },
+        {
+          "description": "Clean from the project root directory.",
+          "command": "<%= config.bin %> <%= command.id %> --root"
+        }
+      ],
+      "flags": {
+        "dry-run": {
+          "char": "d",
+          "description": "Perform a dry run without deleting files.",
+          "name": "dry-run",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "reset": {
+          "char": "r",
+          "description": "Reset the project to a clean state.",
+          "name": "reset",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "root": {
+          "char": "R",
+          "description": "Clean from the project root directory.",
+          "name": "root",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "clean",
+      "pluginAlias": "@jpp-toolkit/plugin-clean",
+      "pluginName": "@jpp-toolkit/plugin-clean",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Remove build artifacts and temporary files from the project."
+    }
+  },
+  "version": "0.0.11"
+}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@jpp-toolkit/plugin-clean",
+  "version": "0.0.11",
+  "description": "Plugin that add the clean command to the jpp cli.",
+  "keywords": [
+    "jpp",
+    "plugin",
+    "clean"
+  ],
+  "homepage": "https://github.com/jpapini/jpp-toolkit/tree/main/packages/plugin-clean#readme",
+  "bugs": {
+    "url": "https://github.com/jpapini/jpp-toolkit/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jpapini/jpp-toolkit.git",
+    "directory": "packages/plugin-clean"
+  },
+  "license": "MIT",
+  "author": "Julien Papini <julien.papini@gmail.com> (https://github.com/jpapini)",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "src",
+    "oclif.config.js",
+    "oclif.manifest.json"
+  ],
+  "dependencies": {
+    "@oclif/core": "4.8.0",
+    "execa": "9.6.1",
+    "rimraf": "6.1.2",
+    "@jpp-toolkit/core": "0.0.11",
+    "@jpp-toolkit/utils": "0.0.11"
+  },
+  "devDependencies": {
+    "oclif": "4.22.52"
+  },
+  "engines": {
+    "node": "24",
+    "pnpm": "10"
+  },
+  "volta": {
+    "extends": "../../package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit --pretty",
+    "dev": "build-lib --watch",
+    "build": "build-lib"
+  }
+}

package/src/clean-command.ts

@@ -0,0 +1,95 @@
+import path from 'node:path';
+
+import { Command } from '@jpp-toolkit/core';
+import { findProjectRoot } from '@jpp-toolkit/utils';
+import { Flags } from '@oclif/core';
+import { execa } from 'execa';
+import { rimraf } from 'rimraf';
+
+const RESET_PATTERNS = ['!old', '!tmp'];
+const CLEAN_PATTERNS = [
+    ...RESET_PATTERNS,
+    '!node_modules',
+    '!node_modules/**',
+    '**/node_modules/.cache',
+    '!**/hooks/_',
+    '!**/hooks/_/**',
+    '!.env',
+];
+
+export class CleanCommand extends Command {
+    static override summary = 'Remove build artifacts and temporary files from the project.';
+
+    static override flags = {
+        'dry-run': Flags.boolean({
+            char: 'd',
+            description: 'Perform a dry run without deleting files.',
+            default: false,
+        }),
+        'reset': Flags.boolean({
+            char: 'r',
+            description: 'Reset the project to a clean state.',
+            default: false,
+        }),
+        'root': Flags.boolean({
+            char: 'R',
+            description: 'Clean from the project root directory.',
+            default: false,
+        }),
+    };
+
+    static override examples = [
+        {
+            description: 'Perform a dry run of the clean command.',
+            command: '<%= config.bin %> <%= command.id %> --dry-run',
+        },
+        {
+            description: 'Reset the project to a clean state.',
+            command: '<%= config.bin %> <%= command.id %> --reset',
+        },
+        {
+            description: 'Clean from the project root directory.',
+            command: '<%= config.bin %> <%= command.id %> --root',
+        },
+    ];
+
+    public async run(): Promise<void> {
+        const { flags } = await this.parse(CleanCommand);
+
+        const cwd = flags.root ? findProjectRoot() : process.cwd();
+        const patterns = flags.reset ? RESET_PATTERNS : CLEAN_PATTERNS;
+
+        const { stdout } = await execa(
+            'git',
+            [
+                'ls-files',
+                '--others',
+                '--ignored',
+                '--exclude-standard',
+                '--directory',
+                ...patterns.map((pattern) => `--exclude=${pattern}`),
+            ],
+            { cwd, lines: true },
+        );
+
+        const paths = stdout
+            .filter((line) => line.trim().length > 0)
+            .map((filePath) => path.resolve(cwd, filePath));
+
+        if (paths.length === 0) {
+            this.logger.info('No files to clean');
+            return;
+        }
+
+        if (flags['dry-run']) {
+            this.logger.info('The following files would be removed:');
+            this.logger.paths(paths);
+            return;
+        }
+
+        await rimraf(paths);
+
+        this.logger.success('Cleaned the following files:');
+        this.logger.paths(paths);
+    }
+}

package/src/index.ts

@@ -0,0 +1,5 @@
+import { CleanCommand } from './clean-command';
+
+export const commands = {
+    clean: CleanCommand,
+};