@oclif/plugin-test-esbuild 0.1.3

package/README.md

@@ -0,0 +1,397 @@
+plugin-test-esbuild
+=================
+
+Example of using `esbuild` with oclif
+
+[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
+[![CircleCI](https://circleci.com/gh/oclif/hello-world/tree/main.svg?style=shield)](https://circleci.com/gh/oclif/hello-world/tree/main)
+[![GitHub license](https://img.shields.io/github/license/oclif/hello-world)](https://github.com/oclif/hello-world/blob/main/LICENSE)
+
+<!-- toc -->
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g @oclif/plugin-test-esbuild
+$ bundle COMMAND
+running command...
+$ bundle (--version)
+@oclif/plugin-test-esbuild/0.1.3 linux-x64 node-v20.11.0
+$ bundle --help [COMMAND]
+USAGE
+  $ bundle COMMAND
+...
+```
+<!-- usagestop -->
+# Commands
+<!-- commands -->
+* [`bundle hello PERSON`](#bundle-hello-person)
+* [`bundle hello alias`](#bundle-hello-alias)
+* [`bundle hello world`](#bundle-hello-world)
+* [`bundle help [COMMANDS]`](#bundle-help-commands)
+* [`bundle plugins`](#bundle-plugins)
+* [`bundle plugins:install PLUGIN...`](#bundle-pluginsinstall-plugin)
+* [`bundle plugins:inspect PLUGIN...`](#bundle-pluginsinspect-plugin)
+* [`bundle plugins:install PLUGIN...`](#bundle-pluginsinstall-plugin-1)
+* [`bundle plugins:link PLUGIN`](#bundle-pluginslink-plugin)
+* [`bundle plugins:uninstall PLUGIN...`](#bundle-pluginsuninstall-plugin)
+* [`bundle plugins reset`](#bundle-plugins-reset)
+* [`bundle plugins:uninstall PLUGIN...`](#bundle-pluginsuninstall-plugin-1)
+* [`bundle plugins:uninstall PLUGIN...`](#bundle-pluginsuninstall-plugin-2)
+* [`bundle plugins update`](#bundle-plugins-update)
+
+## `bundle hello PERSON`
+
+Say hello
+
+```
+USAGE
+  $ bundle hello PERSON -f <value>
+
+ARGUMENTS
+  PERSON  Person to say hello to
+
+FLAGS
+  -f, --from=<value>  (required) Who is saying hello
+
+DESCRIPTION
+  Say hello
+
+EXAMPLES
+  $ oex hello friend --from oclif
+  hello friend from oclif! (./src/commands/hello/index.ts)
+```
+
+## `bundle hello alias`
+
+Say hello world
+
+```
+USAGE
+  $ bundle hello alias
+
+DESCRIPTION
+  Say hello world
+
+EXAMPLES
+  $ bundle hello alias
+  hello world! (./src/commands/hello/world.ts)
+```
+
+## `bundle hello world`
+
+Say hello world
+
+```
+USAGE
+  $ bundle hello world
+
+DESCRIPTION
+  Say hello world
+
+EXAMPLES
+  $ bundle hello world
+  hello world! (./src/commands/hello/world.ts)
+```
+
+## `bundle help [COMMANDS]`
+
+Display help for bundle.
+
+```
+USAGE
+  $ bundle help [COMMANDS] [-n]
+
+ARGUMENTS
+  COMMANDS  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for bundle.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.12/src/commands/help.ts)_
+
+## `bundle plugins`
+
+List installed plugins.
+
+```
+USAGE
+  $ bundle plugins [--json] [--core]
+
+FLAGS
+  --core  Show core plugins.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  List installed plugins.
+
+EXAMPLES
+  $ bundle plugins
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.2.1/src/commands/plugins/index.ts)_
+
+## `bundle plugins:install PLUGIN...`
+
+Installs a plugin into the CLI.
+
+```
+USAGE
+  $ bundle plugins add plugins:install PLUGIN...
+
+ARGUMENTS
+  PLUGIN  Plugin to install.
+
+FLAGS
+  -f, --force    Run yarn install with force flag.
+  -h, --help     Show CLI help.
+  -s, --silent   Silences yarn output.
+  -v, --verbose  Show verbose yarn output.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Installs a plugin into the CLI.
+  Can be installed from npm or a git url.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
+  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
+  the CLI without the need to patch and update the whole CLI.
+
+
+ALIASES
+  $ bundle plugins add
+
+EXAMPLES
+  $ bundle plugins add myplugin 
+
+  $ bundle plugins add https://github.com/someuser/someplugin
+
+  $ bundle plugins add someuser/someplugin
+```
+
+## `bundle plugins:inspect PLUGIN...`
+
+Displays installation properties of a plugin.
+
+```
+USAGE
+  $ bundle 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
+  $ bundle plugins inspect myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.2.1/src/commands/plugins/inspect.ts)_
+
+## `bundle plugins:install PLUGIN...`
+
+Installs a plugin into the CLI.
+
+```
+USAGE
+  $ bundle plugins install PLUGIN...
+
+ARGUMENTS
+  PLUGIN  Plugin to install.
+
+FLAGS
+  -f, --force    Run yarn install with force flag.
+  -h, --help     Show CLI help.
+  -s, --silent   Silences yarn output.
+  -v, --verbose  Show verbose yarn output.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Installs a plugin into the CLI.
+  Can be installed from npm or a git url.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
+  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
+  the CLI without the need to patch and update the whole CLI.
+
+
+ALIASES
+  $ bundle plugins add
+
+EXAMPLES
+  $ bundle plugins install myplugin 
+
+  $ bundle plugins install https://github.com/someuser/someplugin
+
+  $ bundle plugins install someuser/someplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.2.1/src/commands/plugins/install.ts)_
+
+## `bundle plugins:link PLUGIN`
+
+Links a plugin into the CLI for development.
+
+```
+USAGE
+  $ bundle plugins link PLUGIN
+
+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
+  $ bundle plugins link myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.2.1/src/commands/plugins/link.ts)_
+
+## `bundle plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ bundle plugins remove plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ bundle plugins unlink
+  $ bundle plugins remove
+
+EXAMPLES
+  $ bundle plugins remove myplugin
+```
+
+## `bundle plugins reset`
+
+Remove all user-installed and linked plugins.
+
+```
+USAGE
+  $ bundle 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/v4.2.1/src/commands/plugins/reset.ts)_
+
+## `bundle plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ bundle plugins uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ bundle plugins unlink
+  $ bundle plugins remove
+
+EXAMPLES
+  $ bundle plugins uninstall myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.2.1/src/commands/plugins/uninstall.ts)_
+
+## `bundle plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ bundle plugins unlink plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ bundle plugins unlink
+  $ bundle plugins remove
+
+EXAMPLES
+  $ bundle plugins unlink myplugin
+```
+
+## `bundle plugins update`
+
+Update installed plugins.
+
+```
+USAGE
+  $ bundle 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/v4.2.1/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({development: false, dir: __dirname})
+})()

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 = [
+        `$ oex hello 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 (opts) {
+    process.stdout.write(`example hook running ${opts.id}\n`);
+};
+exports.default = hook;

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import Hello from './commands/hello';
+import HelloWorld from './commands/hello/world';
+export { default as INIT_HOOK } from './hooks/init/init';
+export declare const COMMANDS: {
+    hello: typeof Hello;
+    'hello:alias': typeof HelloWorld;
+    'hello:world': typeof HelloWorld;
+};