npm package: @oclif/test-plugin-generator
Description: generate test plugins for oclif
Author: Salesforce
Latest version: 0.4.15

Test Plugin Generator
=================

Generates plugins for @oclif/plugin-plugins integration tests

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![CircleCI](https://circleci.com/gh/oclif/test-plugin-generator/tree/main.svg?style=shield)](https://circleci.com/gh/oclif/test-plugin-generator/tree/main)
[![GitHub license](https://img.shields.io/github/license/oclif/test-plugin-generator)](https://github.com/oclif/test-plugin-generator/blob/main/LICENSE)

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ npm install -g @oclif/test-plugin-generator
$ test-plugin-generator COMMAND
running command...
$ test-plugin-generator (--version)
@oclif/test-plugin-generator/0.4.15 linux-x64 node-v20.11.1
$ test-plugin-generator --help [COMMAND]
USAGE
  $ test-plugin-generator COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`test-plugin-generator generate`](#test-plugin-generator-generate)
* [`test-plugin-generator generate matrix`](#test-plugin-generator-generate-matrix)
* [`test-plugin-generator help [COMMAND]`](#test-plugin-generator-help-command)
* [`test-plugin-generator publish`](#test-plugin-generator-publish)

## `test-plugin-generator generate`

Generate an oclif test plugin that uses a specific package manager.

```
USAGE
  $ test-plugin-generator generate -m npm|pnpm|yarn [--bundle-dependencies-all | --bundle-dependency <value>]
    [-d <value>] [-f] [-n <value>] [--oclif-lock] [--shrinkwrap] [--yarn-version
    latest|stable|classic|canary|1.x|2.x|3.x|4.x]

FLAGS
  -d, --directory=<value>             [default: Current working directory.] Directory to create the plugin in.
  -f, --force                         Overwrite existing plugin.
  -m, --package-manager=<option>      (required) Package manager to use for plugin.
                                      <options: npm|pnpm|yarn>
  -n, --name=<value>                  Override the computed name of the plugin.
      --bundle-dependencies-all       Set bundleDependencies:true in package.json.
      --bundle-dependency=<value>...  Add package to bundleDependencies in package.json.
      --oclif-lock                    Generate oclif.lock for yarn plugins.
      --shrinkwrap                    Generate shrinkwrap for npm plugin.
      --yarn-version=<option>         Version of yarn to use for yarn plugins.
                                      <options: latest|stable|classic|canary|1.x|2.x|3.x|4.x>

DESCRIPTION
  Generate an oclif test plugin that uses a specific package manager.

EXAMPLES
  $ test-plugin-generator generate --package-manager npm

  $ test-plugin-generator generate --package-manager npm --shrinkwrap

  $ test-plugin-generator generate --package-manager npm --bundle-dependencies-all

  $ test-plugin-generator generate --package-manager npm --bundle-dependency @oclif/core

  $ test-plugin-generator generate --package-manager pnpm

  $ test-plugin-generator generate --package-manager pnpm --bundle-dependencies-all

  $ test-plugin-generator generate --package-manager pnpm --bundle-dependency @oclif/core

  $ test-plugin-generator generate --package-manager yarn --yarn-version 1.x

  $ test-plugin-generator generate --package-manager yarn --yarn-version 2.x

  $ test-plugin-generator generate --package-manager yarn --yarn-version 3.x

  $ test-plugin-generator generate --package-manager yarn --yarn-version 4.x

  $ test-plugin-generator generate --package-manager yarn --yarn-version latest

  $ test-plugin-generator generate --package-manager yarn --yarn-version stable
```

_See code: [src/commands/generate/index.ts](https://github.com/oclif/test-plugin-generator/blob/v0.4.15/src/commands/generate/index.ts)_

## `test-plugin-generator generate matrix`

Generate plugins based on a matrix of options.

```
USAGE
  $ test-plugin-generator generate matrix -m <value> [-c <value>] [-d <value>]

FLAGS
  -c, --chunk-size=<value>        Number of plugins to generate at a time.
  -d, --output-directory=<value>  [default: Current working directory.] Directory to create the plugin in.
  -m, --matrix=<value>            (required) [default: matrix.json] JSON file containing a matrix of options.

EXAMPLES
  $ test-plugin-generator generate matrix
```

_See code: [src/commands/generate/matrix.ts](https://github.com/oclif/test-plugin-generator/blob/v0.4.15/src/commands/generate/matrix.ts)_

## `test-plugin-generator help [COMMAND]`

Display help for test-plugin-generator.

```
USAGE
  $ test-plugin-generator help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for test-plugin-generator.
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.18/src/commands/help.ts)_

## `test-plugin-generator publish`

Publish generated plugin to npm registry.

```
USAGE
  $ test-plugin-generator publish [--clear-registry] [-d <value>] [--dry-run] [-p <value>] [-r <value>]

FLAGS
  -d, --directory=<value>         Directory of plugins to publish.
  -p, --plugin-directory=<value>  Plugin directory to publish from.
  -r, --registry=<value>          [default: http://localhost:4873/] Verdaccio registry to publish to.
      --[no-]clear-registry       Clear registry before publishing.
      --dry-run                   Do not publish to registry.

DESCRIPTION
  Publish generated plugin to npm registry.

EXAMPLES
  $ test-plugin-generator publish
```

_See code: [src/commands/publish.ts](https://github.com/oclif/test-plugin-generator/blob/v0.4.15/src/commands/publish.ts)_
<!-- commandsstop -->