Home > vue-metamorph > createVueMetamorphCli

createVueMetamorphCli() function

Creates a CLI runner that globs files and runs codemod/manual-migration plugins against them.

Parses process.argv for --files <glob>, --plugins <glob...>, and --list-plugins options. Returns an object with run(), abort(), and opts() methods.

Signature:

export declare function createVueMetamorphCli(options: CreateVueMetamorphCliOptions): {
    run: (argv?: string[]) => Promise<void>;
    abort: () => void;
    opts: (argv?: string[]) => import("commander").OptionValues;
};

Parameters

Parameter	Type	Description
options	CreateVueMetamorphCliOptions

Returns:

{ run: (argv?: string[]) => Promise<void>; abort: () => void; opts: (argv?: string[]) => import("commander").OptionValues; }

Example

import { createVueMetamorphCli } from 'vue-metamorph';

const { run, abort } = createVueMetamorphCli({
  plugins: [myCodemod, myManualMigration],
  onProgress({ totalFiles, filesProcessed, stats, done }) {
    console.log(`${filesProcessed}/${totalFiles} files processed`);
  },
});

run();