@depup/oclif 4.22.92-depup.1

package/templates/cli/shared/README.md.ejs

@@ -0,0 +1,396 @@
+<%- name %>
+=================
+
+<%- description %>
+
+
+[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
+[![Version](https://img.shields.io/npm/v/<%- name %>.svg)](https://npmjs.org/package/<%- name %>)
+[![Downloads/week](https://img.shields.io/npm/dw/<%- name %>.svg)](https://npmjs.org/package/<%- name %>)
+
+
+<!-- toc -->
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g mycli123
+$ mycli123 COMMAND
+running command...
+$ mycli123 (--version)
+mycli123/0.0.0 darwin-arm64 node-v20.12.2
+$ mycli123 --help [COMMAND]
+USAGE
+  $ mycli123 COMMAND
+...
+```
+<!-- usagestop -->
+# Commands
+<!-- commands -->
+* [`mycli123 hello PERSON`](#mycli123-hello-person)
+* [`mycli123 hello world`](#mycli123-hello-world)
+* [`mycli123 help [COMMAND]`](#mycli123-help-command)
+* [`mycli123 plugins`](#mycli123-plugins)
+* [`mycli123 plugins add PLUGIN`](#mycli123-plugins-add-plugin)
+* [`mycli123 plugins:inspect PLUGIN...`](#mycli123-pluginsinspect-plugin)
+* [`mycli123 plugins install PLUGIN`](#mycli123-plugins-install-plugin)
+* [`mycli123 plugins link PATH`](#mycli123-plugins-link-path)
+* [`mycli123 plugins remove [PLUGIN]`](#mycli123-plugins-remove-plugin)
+* [`mycli123 plugins reset`](#mycli123-plugins-reset)
+* [`mycli123 plugins uninstall [PLUGIN]`](#mycli123-plugins-uninstall-plugin)
+* [`mycli123 plugins unlink [PLUGIN]`](#mycli123-plugins-unlink-plugin)
+* [`mycli123 plugins update`](#mycli123-plugins-update)
+
+## `mycli123 hello PERSON`
+
+Say hello
+
+```
+USAGE
+  $ mycli123 hello PERSON -f <value>
+
+ARGUMENTS
+  PERSON  Person to say hello to
+
+FLAGS
+  -f, --from=<value>  (required) Who is saying hello
+
+DESCRIPTION
+  Say hello
+
+EXAMPLES
+  $ mycli123 hello friend --from oclif
+  hello friend from oclif! (./src/commands/hello/index.ts)
+```
+
+_See code: [src/commands/hello/index.ts](https://github.com/mdonnalley/mycli123/blob/v0.0.0/src/commands/hello/index.ts)_
+
+## `mycli123 hello world`
+
+Say hello world
+
+```
+USAGE
+  $ mycli123 hello world
+
+DESCRIPTION
+  Say hello world
+
+EXAMPLES
+  $ mycli123 hello world
+  hello world! (./src/commands/hello/world.ts)
+```
+
+_See code: [src/commands/hello/world.ts](https://github.com/mdonnalley/mycli123/blob/v0.0.0/src/commands/hello/world.ts)_
+
+## `mycli123 help [COMMAND]`
+
+Display help for mycli123.
+
+```
+USAGE
+  $ mycli123 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 mycli123.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.21/src/commands/help.ts)_
+
+## `mycli123 plugins`
+
+List installed plugins.
+
+```
+USAGE
+  $ mycli123 plugins [--json] [--core]
+
+FLAGS
+  --core  Show core plugins.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  List installed plugins.
+
+EXAMPLES
+  $ mycli123 plugins
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.16/src/commands/plugins/index.ts)_
+
+## `mycli123 plugins add PLUGIN`
+
+Installs a plugin into mycli123.
+
+```
+USAGE
+  $ mycli123 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 mycli123.
+
+  Uses bundled npm executable to install plugins into /Users/mdonnalley/.local/share/mycli123
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  Use the MYCLI123_NPM_LOG_LEVEL environment variable to set the npm loglevel.
+  Use the MYCLI123_NPM_REGISTRY environment variable to set the npm registry.
+
+ALIASES
+  $ mycli123 plugins add
+
+EXAMPLES
+  Install a plugin from npm registry.
+
+    $ mycli123 plugins add myplugin
+
+  Install a plugin from a github url.
+
+    $ mycli123 plugins add https://github.com/someuser/someplugin
+
+  Install a plugin from a github slug.
+
+    $ mycli123 plugins add someuser/someplugin
+```
+
+## `mycli123 plugins:inspect PLUGIN...`
+
+Displays installation properties of a plugin.
+
+```
+USAGE
+  $ mycli123 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
+  $ mycli123 plugins inspect myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.16/src/commands/plugins/inspect.ts)_
+
+## `mycli123 plugins install PLUGIN`
+
+Installs a plugin into mycli123.
+
+```
+USAGE
+  $ mycli123 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 mycli123.
+
+  Uses bundled npm executable to install plugins into /Users/mdonnalley/.local/share/mycli123
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  Use the MYCLI123_NPM_LOG_LEVEL environment variable to set the npm loglevel.
+  Use the MYCLI123_NPM_REGISTRY environment variable to set the npm registry.
+
+ALIASES
+  $ mycli123 plugins add
+
+EXAMPLES
+  Install a plugin from npm registry.
+
+    $ mycli123 plugins install myplugin
+
+  Install a plugin from a github url.
+
+    $ mycli123 plugins install https://github.com/someuser/someplugin
+
+  Install a plugin from a github slug.
+
+    $ mycli123 plugins install someuser/someplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.16/src/commands/plugins/install.ts)_
+
+## `mycli123 plugins link PATH`
+
+Links a plugin into the CLI for development.
+
+```
+USAGE
+  $ mycli123 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
+  $ mycli123 plugins link myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.16/src/commands/plugins/link.ts)_
+
+## `mycli123 plugins remove [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ mycli123 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
+  $ mycli123 plugins unlink
+  $ mycli123 plugins remove
+
+EXAMPLES
+  $ mycli123 plugins remove myplugin
+```
+
+## `mycli123 plugins reset`
+
+Remove all user-installed and linked plugins.
+
+```
+USAGE
+  $ mycli123 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.0.16/src/commands/plugins/reset.ts)_
+
+## `mycli123 plugins uninstall [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ mycli123 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
+  $ mycli123 plugins unlink
+  $ mycli123 plugins remove
+
+EXAMPLES
+  $ mycli123 plugins uninstall myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.16/src/commands/plugins/uninstall.ts)_
+
+## `mycli123 plugins unlink [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ mycli123 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
+  $ mycli123 plugins unlink
+  $ mycli123 plugins remove
+
+EXAMPLES
+  $ mycli123 plugins unlink myplugin
+```
+
+## `mycli123 plugins update`
+
+Update installed plugins.
+
+```
+USAGE
+  $ mycli123 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.0.16/src/commands/plugins/update.ts)_
+<!-- commandsstop -->

package/templates/cli/shared/package.json.ejs

@@ -0,0 +1,73 @@
+{
+  "name": "<%- name %>",
+  "description": "<%- description %>",
+  "version": "0.0.0",
+  "author": "<%- author %>",
+  "bin": {
+    "<%- bin %>": "./bin/run.js"
+  },
+  "bugs": "https://github.com/<%- owner %>/<%- repository %>/issues",
+  "dependencies": {
+    "@oclif/core": "^4",
+    "@oclif/plugin-help": "^6",
+    "@oclif/plugin-plugins": "^5"
+  },
+  "devDependencies": {
+    "@eslint/compat": "^1",
+    "@oclif/prettier-config": "^0.2.1",
+    "@oclif/test": "^4",
+    "@types/chai": "^4",
+    "@types/mocha": "^10",
+    "@types/node": "^18",
+    "chai": "^4",
+    "eslint": "^9",
+    "eslint-config-oclif": "^6",
+    "eslint-config-prettier": "^10",
+    "mocha": "^11",
+    "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/<%- owner %>/<%- repository %>",
+  "keywords": [
+    "oclif"
+  ],
+  "license": "<%- license %>",
+  "main": "dist/index.js",
+  <% if (moduleType == 'ESM') { %>"type": "module",<% } %>
+  "oclif": {
+    "bin": "<%- bin %>",
+    "dirname": "<%- bin %>",
+    "commands": "./dist/commands",
+    "plugins": [
+      "@oclif/plugin-help",
+      "@oclif/plugin-plugins"
+    ],
+    "topicSeparator": " ",
+    "topics": {
+      "hello": {
+        "description": "Say hello to the world and others"
+      }
+    }
+  },
+  "repository": "<%- owner %>/<%- repository %>",
+  "scripts": {
+    "build": "shx rm -rf dist && tsc -b",
+    "lint": "eslint",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "posttest": "<%- pkgManagerScript %> 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"
+}

package/templates/cli/shared/src/commands/hello/index.ts.ejs

@@ -0,0 +1,22 @@
+import {Args, Command, Flags} from '@oclif/core'
+
+export default class Hello extends Command {
+  static args = {
+    person: 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: Flags.string({char: 'f', description: 'Who is saying hello', required: true}),
+  }
+
+  async run(): Promise<void> {
+    const {args, flags} = await this.parse(Hello)
+
+    this.log(`hello ${args.person} from ${flags.from}! (./src/commands/hello/index.ts)`)
+  }
+}

package/templates/cli/shared/src/commands/hello/world.ts.ejs

@@ -0,0 +1,16 @@
+import {Command} from '@oclif/core'
+
+export default class World extends 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(): Promise<void> {
+    this.log('hello world! (./src/commands/hello/world.ts)')
+  }
+}

package/templates/cli/shared/src/index.ts.ejs

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

package/templates/cli/shared/test/commands/hello/index.test.ts.ejs

@@ -0,0 +1,9 @@
+import {runCommand} from '@oclif/test'
+import {expect} from 'chai'
+
+describe('hello', () => {
+  it('runs hello', async () => {
+    const {stdout} = await runCommand('hello friend --from oclif')
+    expect(stdout).to.contain('hello friend from oclif!')
+  })
+})

package/templates/cli/shared/test/commands/hello/world.test.ts.ejs

@@ -0,0 +1,9 @@
+import {runCommand} from '@oclif/test'
+import {expect} from 'chai'
+
+describe('hello world', () => {
+  it('runs hello world cmd', async () => {
+    const {stdout} = await runCommand('hello world')
+    expect(stdout).to.contain('hello world!')
+  })
+})

package/templates/cli/shared/test/tsconfig.json.ejs

@@ -0,0 +1,9 @@
+{
+  "extends": "../tsconfig",
+  "compilerOptions": {
+    "noEmit": true
+  },
+  "references": [
+    {"path": ".."}
+  ]
+}

package/templates/src/command.ts.ejs

@@ -0,0 +1,27 @@
+import {Args, Command, Flags} from '@oclif/core'
+
+export default class <%- className %> extends Command {
+  static override args = {
+    file: Args.string({description: 'file to read'}),
+  }
+  static override description = 'describe the command here'
+  static override examples = [
+    '<%%= config.bin %> <%%= command.id %>',
+  ]
+  static override flags = {
+    // flag with no value (-f, --force)
+    force: Flags.boolean({char: 'f'}),
+    // flag with a value (-n, --name=VALUE)
+    name: Flags.string({char: 'n', description: 'name to print'}),
+  }
+
+  public async run(): Promise<void> {
+    const {args, flags} = await this.parse(<%- className %>)
+
+    const name = flags.name ?? 'world'
+    this.log(`hello ${name} from <%- path.replace(/\\/g, '\\\\') %>`)
+    if (args.file && flags.force) {
+      this.log(`you input --force and --file: ${args.file}`)
+    }
+  }
+}

package/templates/src/hook.ts.ejs

@@ -0,0 +1,7 @@
+import {Hook} from '@oclif/core'
+
+const hook: Hook<'<%- event %>'> = async function (opts) {
+  process.stdout.write(`example hook running ${opts.id}\n`)
+}
+
+export default hook

package/templates/src/init/dev.cmd.ejs

@@ -0,0 +1,12 @@
+<% switch (moduleType) {
+  case 'ESM' : _%>
+@echo off
+
+node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*
+          <%_ break;
+  case 'CommonJS' : _%>
+@echo off
+
+node "%~dp0\dev" %*
+          <%_ break;
+  } _%>

package/templates/src/init/dev.js.ejs

@@ -0,0 +1,17 @@
+<% switch (moduleType) {
+  case 'ESM' : _%>
+#!/usr/bin/env -S node --loader ts-node/esm --no-warnings=ExperimentalWarning
+
+import {execute} from '@oclif/core'
+await execute({development: true, dir: import.meta.url})
+          <%_ break;
+  case 'CommonJS' : _%>
+#!/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})
+})()
+          <%_ break;
+  } _%>

package/templates/src/init/run.cmd.ejs

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

package/templates/src/init/run.js.ejs

@@ -0,0 +1,17 @@
+<% switch (moduleType) {
+  case 'ESM' : _%>
+#!/usr/bin/env node
+
+import {execute} from '@oclif/core'
+await execute({dir: import.meta.url})
+          <%_ break;
+  case 'CommonJS' : _%>
+#!/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})
+})()
+          <%_ break;
+  } _%>

package/templates/test/command.test.ts.ejs

@@ -0,0 +1,14 @@
+import {runCommand} from '@oclif/test'
+import {expect} from 'chai'
+
+describe('<%- name %>', () => {
+  it('runs <%- name %> cmd', async () => {
+    const {stdout} = await runCommand('<%- name %>')
+    expect(stdout).to.contain('hello world')
+  })
+
+  it('runs <%- name %> --name oclif', async () => {
+    const {stdout} = await runCommand('<%- name %> --name oclif')
+    expect(stdout).to.contain('hello oclif')
+  })
+})

package/templates/test/hook.test.ts.ejs

@@ -0,0 +1,9 @@
+import {runHook} from '@oclif/test'
+import {expect} from 'chai'
+
+describe('hooks', () => {
+  it('shows a message', async () => {
+    const {stdout} = await runHook('init', {id: 'mycommand'})
+    expect(stdout).to.contain('example hook running mycommand')
+  })
+})