Merge pull request #186 from UnrefinedBrain/allow-running-plugin-subset

add --list-plugins and --plugins options to cli

docs/guide/cli.md

@@ -7,7 +7,9 @@ vue-metamorph provides a CLI codemod runner to faciliate running codemods agains
 | Option | Description | Default |
 | - | - | - |
 | --help | Print available options | N/A |
+| --list-plugins | Lists all registered plugins and exists | N/A |
 | --files <glob> | Run transforms against these files using a [glob](https://www.npmjs.com/package/glob) pattern | `'**/src/**/*'` |
+| --plugins <glob> | Only run plugins matching these [micromatch](https://github.com/micromatch/micromatch) patterns. This option can be passed multiple times to specify multiple patterns | `'*'` |
 
 ## API
 
@@ -54,9 +56,11 @@ Options will be passed to the CodemodPlugin `transform()` and ManualMigrationPlu
 const myCodemod: CodemodPlugin = {
   name: 'myCodemod',
   type: 'codemod',
-  transform(scriptASTs, sfcAST, filename, utils, opts) {
+  transform({ opts }) {
     if (opts.myCustomOption) {
-      // behave differently
+      // do something
+    } else {
+      // do something else
     }
   }
 }

package.json

@@ -52,6 +52,7 @@
     "@types/cli-progress": "^3.11.5",
     "@types/deep-diff": "^1.0.5",
     "@types/lodash-es": "^4.17.12",
+    "@types/micromatch": "^4.0.9",
     "@types/node": "^22.0.0",
     "@typescript-eslint/eslint-plugin": "^7.13.1",
     "@typescript-eslint/parser": "^7.13.1",
@@ -77,6 +78,7 @@
     "glob": "^11.0.0",
     "lodash-es": "^4.17.21",
     "magic-string": "^0.30.10",
+    "micromatch": "^4.0.8",
     "node-html-parser": "^6.1.13",
     "postcss": "^8.4.38",
     "postcss-less": "^6.0.0",

src/cli.ts

@@ -1,6 +1,7 @@
 import { Command } from 'commander';
 import { globSync } from 'glob';
 import { promises as fs } from 'fs';
+import micromatch from 'micromatch';
 import type { CodemodPlugin, ManualMigrationPlugin, Plugin } from './types';
 import { transform } from './transform';
 import { ManualMigrationReport, findManualMigrations } from './manual';
@@ -100,6 +101,8 @@ export interface CreateVueMetamorphCliOptions {
 
 type ProgramOptions = {
   files: string;
+  plugins: string[];
+  listPlugins: boolean;
 };
 
 /**
@@ -111,7 +114,9 @@ export function createVueMetamorphCli(options: CreateVueMetamorphCliOptions) {
   const defaultCliProgressHandler = createDefaultCliProgressHandler(console);
 
   program
-    .requiredOption('--files <glob>', 'Run transforms against these files', '**/src/**/*');
+    .requiredOption('--files <glob>', 'Run transforms against these files', '**/src/**/*')
+    .requiredOption('--plugins <glob...>', 'Run only these plugins using micromatch queries', '*')
+    .option('--list-plugins', 'Print a list of plugins.');
 
   options.additionalCliOptions?.(program);
 
@@ -122,6 +127,11 @@ export function createVueMetamorphCli(options: CreateVueMetamorphCliOptions) {
     const opts = program.opts<ProgramOptions>();
     const stats: Record<string, number> = {};
 
+    if (opts.listPlugins) {
+      process.stdout.write(`${options.plugins.flat().map((plugin) => plugin.name).join('\n')}\n`);
+      process.exit(0);
+    }
+
     const files = globSync(opts.files, {
       absolute: true,
       nodir: true,
@@ -140,7 +150,11 @@ export function createVueMetamorphCli(options: CreateVueMetamorphCliOptions) {
       },
     });
 
-    const plugins = options.plugins.flat();
+    const plugins = options
+      .plugins
+      .flat()
+      .filter((plugin) => micromatch.isMatch(plugin.name, opts.plugins));
+
     const codemodPlugins = plugins.filter((plugin): plugin is CodemodPlugin => plugin.type === 'codemod');
     const manualMigrationPlugins = plugins.filter((plugin): plugin is ManualMigrationPlugin => plugin.type === 'manual');
     const manualMigrationReports: ManualMigrationReport[] = [];