@oclif/plugin-test-core-v3 0.1.0

package/README.md

@@ -0,0 +1,415 @@
+@oclif/plugin-test-core-v3
+=================
+
+Test plugin that uses @oclif/core v3
+
+
+[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
+[![Version](https://img.shields.io/npm/v/@oclif/plugin-test-core-v3.svg)](https://npmjs.org/package/@oclif/plugin-test-core-v3)
+[![Downloads/week](https://img.shields.io/npm/dw/@oclif/plugin-test-core-v3.svg)](https://npmjs.org/package/@oclif/plugin-test-core-v3)
+
+
+<!-- toc -->
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g @oclif/plugin-test-core-v3
+$ corev3 COMMAND
+running command...
+$ corev3 (--version)
+@oclif/plugin-test-core-v3/0.1.0 linux-x64 node-v20.13.1
+$ corev3 --help [COMMAND]
+USAGE
+  $ corev3 COMMAND
+...
+```
+<!-- usagestop -->
+# Commands
+<!-- commands -->
+* [`corev3 core-v3 [OPTIONALARG] [DEFAULTARG] [DEFAULTFNARG]`](#corev3-core-v3-optionalarg-defaultarg-defaultfnarg)
+* [`corev3 hello PERSON`](#corev3-hello-person)
+* [`corev3 hello world`](#corev3-hello-world)
+* [`corev3 help [COMMAND]`](#corev3-help-command)
+* [`corev3 plugins`](#corev3-plugins)
+* [`corev3 plugins add PLUGIN`](#corev3-plugins-add-plugin)
+* [`corev3 plugins:inspect PLUGIN...`](#corev3-pluginsinspect-plugin)
+* [`corev3 plugins install PLUGIN`](#corev3-plugins-install-plugin)
+* [`corev3 plugins link PATH`](#corev3-plugins-link-path)
+* [`corev3 plugins remove [PLUGIN]`](#corev3-plugins-remove-plugin)
+* [`corev3 plugins reset`](#corev3-plugins-reset)
+* [`corev3 plugins uninstall [PLUGIN]`](#corev3-plugins-uninstall-plugin)
+* [`corev3 plugins unlink [PLUGIN]`](#corev3-plugins-unlink-plugin)
+* [`corev3 plugins update`](#corev3-plugins-update)
+
+## `corev3 core-v3 [OPTIONALARG] [DEFAULTARG] [DEFAULTFNARG]`
+
+```
+USAGE
+  $ corev3 core-v3 [OPTIONALARG] [DEFAULTARG] [DEFAULTFNARG] [--json] [--optionalString <value>]
+    [--defaultString <value>] [--defaultFnString <value>]
+
+FLAGS
+  --defaultFnString=<value>  [default: async fn default]
+  --defaultString=<value>    [default: simple string default]
+  --optionalString=<value>
+
+GLOBAL FLAGS
+  --json  Format output as json.
+```
+
+_See code: [src/commands/core-v3.ts](https://github.com/oclif/plugin-test-core-v3/blob/v0.1.0/src/commands/core-v3.ts)_
+
+## `corev3 hello PERSON`
+
+Say hello
+
+```
+USAGE
+  $ corev3 hello PERSON -f <value>
+
+ARGUMENTS
+  PERSON  Person to say hello to
+
+FLAGS
+  -f, --from=<value>  (required) Who is saying hello
+
+DESCRIPTION
+  Say hello
+
+EXAMPLES
+  $ corev3 hello friend --from oclif
+  hello friend from oclif! (./src/commands/hello/index.ts)
+```
+
+_See code: [src/commands/hello/index.ts](https://github.com/oclif/plugin-test-core-v3/blob/v0.1.0/src/commands/hello/index.ts)_
+
+## `corev3 hello world`
+
+Say hello world
+
+```
+USAGE
+  $ corev3 hello world
+
+DESCRIPTION
+  Say hello world
+
+EXAMPLES
+  $ corev3 hello world
+  hello world! (./src/commands/hello/world.ts)
+```
+
+_See code: [src/commands/hello/world.ts](https://github.com/oclif/plugin-test-core-v3/blob/v0.1.0/src/commands/hello/world.ts)_
+
+## `corev3 help [COMMAND]`
+
+Display help for corev3.
+
+```
+USAGE
+  $ corev3 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 corev3.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.22/src/commands/help.ts)_
+
+## `corev3 plugins`
+
+List installed plugins.
+
+```
+USAGE
+  $ corev3 plugins [--json] [--core]
+
+FLAGS
+  --core  Show core plugins.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  List installed plugins.
+
+EXAMPLES
+  $ corev3 plugins
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.2/src/commands/plugins/index.ts)_
+
+## `corev3 plugins add PLUGIN`
+
+Installs a plugin into corev3.
+
+```
+USAGE
+  $ corev3 plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
+
+ARGUMENTS
+  PLUGIN...  Plugin to install.
+
+FLAGS
+  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
+  -h, --help     Show CLI help.
+  -s, --silent   Silences npm output.
+  -v, --verbose  Show verbose npm output.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Installs a plugin into corev3.
+
+  Uses bundled npm executable to install plugins into /home/runner/.local/share/corev3
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  Use the COREV3_NPM_LOG_LEVEL environment variable to set the npm loglevel.
+  Use the COREV3_NPM_REGISTRY environment variable to set the npm registry.
+
+ALIASES
+  $ corev3 plugins add
+
+EXAMPLES
+  Install a plugin from npm registry.
+
+    $ corev3 plugins add myplugin
+
+  Install a plugin from a github url.
+
+    $ corev3 plugins add https://github.com/someuser/someplugin
+
+  Install a plugin from a github slug.
+
+    $ corev3 plugins add someuser/someplugin
+```
+
+## `corev3 plugins:inspect PLUGIN...`
+
+Displays installation properties of a plugin.
+
+```
+USAGE
+  $ corev3 plugins inspect PLUGIN...
+
+ARGUMENTS
+  PLUGIN...  [default: .] Plugin to inspect.
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Displays installation properties of a plugin.
+
+EXAMPLES
+  $ corev3 plugins inspect myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.2/src/commands/plugins/inspect.ts)_
+
+## `corev3 plugins install PLUGIN`
+
+Installs a plugin into corev3.
+
+```
+USAGE
+  $ corev3 plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
+
+ARGUMENTS
+  PLUGIN...  Plugin to install.
+
+FLAGS
+  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
+  -h, --help     Show CLI help.
+  -s, --silent   Silences npm output.
+  -v, --verbose  Show verbose npm output.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Installs a plugin into corev3.
+
+  Uses bundled npm executable to install plugins into /home/runner/.local/share/corev3
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  Use the COREV3_NPM_LOG_LEVEL environment variable to set the npm loglevel.
+  Use the COREV3_NPM_REGISTRY environment variable to set the npm registry.
+
+ALIASES
+  $ corev3 plugins add
+
+EXAMPLES
+  Install a plugin from npm registry.
+
+    $ corev3 plugins install myplugin
+
+  Install a plugin from a github url.
+
+    $ corev3 plugins install https://github.com/someuser/someplugin
+
+  Install a plugin from a github slug.
+
+    $ corev3 plugins install someuser/someplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.2/src/commands/plugins/install.ts)_
+
+## `corev3 plugins link PATH`
+
+Links a plugin into the CLI for development.
+
+```
+USAGE
+  $ corev3 plugins link PATH [-h] [--install] [-v]
+
+ARGUMENTS
+  PATH  [default: .] path to plugin
+
+FLAGS
+  -h, --help          Show CLI help.
+  -v, --verbose
+      --[no-]install  Install dependencies after linking the plugin.
+
+DESCRIPTION
+  Links a plugin into the CLI for development.
+  Installation of a linked plugin will override a user-installed or core plugin.
+
+  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
+  command will override the user-installed or core plugin implementation. This is useful for development work.
+
+
+EXAMPLES
+  $ corev3 plugins link myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.2/src/commands/plugins/link.ts)_
+
+## `corev3 plugins remove [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ corev3 plugins remove [PLUGIN...] [-h] [-v]
+
+ARGUMENTS
+  PLUGIN...  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ corev3 plugins unlink
+  $ corev3 plugins remove
+
+EXAMPLES
+  $ corev3 plugins remove myplugin
+```
+
+## `corev3 plugins reset`
+
+Remove all user-installed and linked plugins.
+
+```
+USAGE
+  $ corev3 plugins reset [--hard] [--reinstall]
+
+FLAGS
+  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
+  --reinstall  Reinstall all plugins after uninstalling.
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.2/src/commands/plugins/reset.ts)_
+
+## `corev3 plugins uninstall [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ corev3 plugins uninstall [PLUGIN...] [-h] [-v]
+
+ARGUMENTS
+  PLUGIN...  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ corev3 plugins unlink
+  $ corev3 plugins remove
+
+EXAMPLES
+  $ corev3 plugins uninstall myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.2/src/commands/plugins/uninstall.ts)_
+
+## `corev3 plugins unlink [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ corev3 plugins unlink [PLUGIN...] [-h] [-v]
+
+ARGUMENTS
+  PLUGIN...  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ corev3 plugins unlink
+  $ corev3 plugins remove
+
+EXAMPLES
+  $ corev3 plugins unlink myplugin
+```
+
+## `corev3 plugins update`
+
+Update installed plugins.
+
+```
+USAGE
+  $ corev3 plugins update [-h] [-v]
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Update installed plugins.
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.1.2/src/commands/plugins/update.ts)_
+<!-- commandsstop -->

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\dev" %*

package/bin/dev.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env node_modules/.bin/ts-node
+// eslint-disable-next-line node/shebang, unicorn/prefer-top-level-await
+;(async () => {
+  const oclif = await import('@oclif/core')
+  await oclif.execute({development: true, dir: __dirname})
+})()

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/bin/run.js

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+
+// eslint-disable-next-line unicorn/prefer-top-level-await
+(async () => {
+  const oclif = await import('@oclif/core')
+  await oclif.execute({dir: __dirname})
+})()

package/dist/commands/core-v3.d.ts

@@ -0,0 +1,20 @@
+import { Command, Interfaces } from '@oclif/core';
+type Result = {
+    args: Interfaces.InferredArgs<typeof CoreV3.args>;
+    flags: Interfaces.InferredFlags<typeof CoreV3.flags>;
+};
+export default class CoreV3 extends Command {
+    static args: {
+        optionalArg: Interfaces.Arg<string | undefined, Record<string, unknown>>;
+        defaultArg: Interfaces.Arg<string, Record<string, unknown>>;
+        defaultFnArg: Interfaces.Arg<string, Record<string, unknown>>;
+    };
+    static enableJsonFlag: boolean;
+    static flags: {
+        optionalString: Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
+        defaultString: Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
+        defaultFnString: Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
+    };
+    run(): Promise<Result>;
+}
+export {};

package/dist/commands/core-v3.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable perfectionist/sort-objects */
+const core_1 = require("@oclif/core");
+class CoreV3 extends core_1.Command {
+    static args = {
+        optionalArg: core_1.Args.string(),
+        defaultArg: core_1.Args.string({
+            default: 'simple string default',
+        }),
+        defaultFnArg: core_1.Args.string({
+            default: async () => 'async fn default',
+        }),
+    };
+    static enableJsonFlag = true;
+    static flags = {
+        optionalString: core_1.Flags.string(),
+        defaultString: core_1.Flags.string({
+            default: 'simple string default',
+        }),
+        defaultFnString: core_1.Flags.string({
+            default: async () => 'async fn default',
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(CoreV3);
+        this.log(`hello I am an @oclif/core@v3 plugin from ${this.config.root}!`);
+        return { args, flags };
+    }
+}
+exports.default = CoreV3;

package/dist/commands/hello/index.d.ts

@@ -0,0 +1,12 @@
+import { Command } from '@oclif/core';
+export default class Hello extends Command {
+    static args: {
+        person: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        from: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/hello/index.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+class Hello extends core_1.Command {
+    static args = {
+        person: core_1.Args.string({ description: 'Person to say hello to', required: true }),
+    };
+    static description = 'Say hello';
+    static examples = [
+        `<%= config.bin %> <%= command.id %> friend --from oclif
+hello friend from oclif! (./src/commands/hello/index.ts)
+`,
+    ];
+    static flags = {
+        from: core_1.Flags.string({ char: 'f', description: 'Who is saying hello', required: true }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(Hello);
+        this.log(`hello ${args.person} from ${flags.from}! (./src/commands/hello/index.ts)`);
+    }
+}
+exports.default = Hello;

package/dist/commands/hello/world.d.ts

@@ -0,0 +1,8 @@
+import { Command } from '@oclif/core';
+export default class World extends Command {
+    static args: {};
+    static description: string;
+    static examples: string[];
+    static flags: {};
+    run(): Promise<void>;
+}

package/dist/commands/hello/world.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+class World extends core_1.Command {
+    static args = {};
+    static description = 'Say hello world';
+    static examples = [
+        `<%= config.bin %> <%= command.id %>
+hello world! (./src/commands/hello/world.ts)
+`,
+    ];
+    static flags = {};
+    async run() {
+        this.log('hello world! (./src/commands/hello/world.ts)');
+    }
+}
+exports.default = World;

package/dist/hooks/init/init.d.ts

@@ -0,0 +1,3 @@
+import { Hook } from '@oclif/core';
+declare const hook: Hook.Init;
+export default hook;

package/dist/hooks/init/init.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const hook = async function () {
+    console.log('Greetings! from plugin-test-core-v3 init hook');
+};
+exports.default = hook;

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { run } from '@oclif/core';

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.run = void 0;
+var core_1 = require("@oclif/core");
+Object.defineProperty(exports, "run", { enumerable: true, get: function () { return core_1.run; } });

package/oclif.manifest.json

@@ -0,0 +1,128 @@
+{
+  "commands": {
+    "core-v3": {
+      "aliases": [],
+      "args": {
+        "optionalArg": {
+          "name": "optionalArg"
+        },
+        "defaultArg": {
+          "default": "simple string default",
+          "name": "defaultArg"
+        },
+        "defaultFnArg": {
+          "default": "async fn default",
+          "name": "defaultFnArg"
+        }
+      },
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "optionalString": {
+          "name": "optionalString",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "defaultString": {
+          "name": "defaultString",
+          "default": "simple string default",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "defaultFnString": {
+          "name": "defaultFnString",
+          "default": "async fn default",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "core-v3",
+      "pluginAlias": "@oclif/plugin-test-core-v3",
+      "pluginName": "@oclif/plugin-test-core-v3",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": true,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "core-v3.js"
+      ]
+    },
+    "hello": {
+      "aliases": [],
+      "args": {
+        "person": {
+          "description": "Person to say hello to",
+          "name": "person",
+          "required": true
+        }
+      },
+      "description": "Say hello",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> friend --from oclif\nhello friend from oclif! (./src/commands/hello/index.ts)\n"
+      ],
+      "flags": {
+        "from": {
+          "char": "f",
+          "description": "Who is saying hello",
+          "name": "from",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "hello",
+      "pluginAlias": "@oclif/plugin-test-core-v3",
+      "pluginName": "@oclif/plugin-test-core-v3",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "hello",
+        "index.js"
+      ]
+    },
+    "hello:world": {
+      "aliases": [],
+      "args": {},
+      "description": "Say hello world",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>\nhello world! (./src/commands/hello/world.ts)\n"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "hello:world",
+      "pluginAlias": "@oclif/plugin-test-core-v3",
+      "pluginName": "@oclif/plugin-test-core-v3",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "hello",
+        "world.js"
+      ]
+    }
+  },
+  "version": "0.1.0"
+}

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@oclif/plugin-test-core-v3",
+  "description": "Test plugin that uses @oclif/core v3",
+  "version": "0.1.0",
+  "author": "Salesforce",
+  "bin": {
+    "corev3": "./bin/run.js"
+  },
+  "bugs": "https://github.com/oclif/plugin-test-core-v3/issues",
+  "dependencies": {
+    "@oclif/core": "^3",
+    "@oclif/plugin-help": "^6",
+    "@oclif/plugin-plugins": "^5"
+  },
+  "devDependencies": {
+    "@oclif/prettier-config": "^0.2.1",
+    "@oclif/test": "^3",
+    "@types/chai": "^4",
+    "@types/mocha": "^10",
+    "@types/node": "^18",
+    "chai": "^4",
+    "eslint": "^8",
+    "eslint-config-oclif": "^5",
+    "eslint-config-oclif-typescript": "^3",
+    "eslint-config-prettier": "^9",
+    "mocha": "^10",
+    "oclif": "^4",
+    "shx": "^0.3.3",
+    "ts-node": "^10",
+    "typescript": "^5"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "/bin",
+    "/dist",
+    "/oclif.manifest.json"
+  ],
+  "homepage": "https://github.com/oclif/plugin-test-core-v3",
+  "keywords": [
+    "oclif"
+  ],
+  "license": "MIT",
+  "main": "dist/index.js",
+  "oclif": {
+    "bin": "corev3",
+    "dirname": "corev3",
+    "commands": "./dist/commands",
+    "plugins": [
+      "@oclif/plugin-help",
+      "@oclif/plugin-plugins"
+    ],
+    "topicSeparator": " ",
+    "topics": {
+      "hello": {
+        "description": "Say hello to the world and others"
+      }
+    }
+  },
+  "repository": "oclif/plugin-test-core-v3",
+  "scripts": {
+    "build": "shx rm -rf dist && tsc -b",
+    "lint": "eslint . --ext .ts",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "posttest": "yarn lint",
+    "prepack": "oclif manifest && oclif readme",
+    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+    "version": "oclif readme && git add README.md"
+  },
+  "types": "dist/index.d.ts"
+}