@oclif/plugin-test-cjs-1 0.1.0

package/README.md

@@ -0,0 +1,303 @@
+oclif-hello-world
+=================
+
+oclif example Hello World CLI
+
+[![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-cjs-1
+$ cjs1 COMMAND
+running command...
+$ cjs1 (--version)
+@oclif/plugin-test-cjs-1/0.1.0 linux-x64 node-v18.17.0
+$ cjs1 --help [COMMAND]
+USAGE
+  $ cjs1 COMMAND
+...
+```
+<!-- usagestop -->
+# Commands
+<!-- commands -->
+* [`cjs1 cjs1`](#cjs1-cjs1)
+* [`cjs1 help [COMMANDS]`](#cjs1-help-commands)
+* [`cjs1 plugins`](#cjs1-plugins)
+* [`cjs1 plugins:install PLUGIN...`](#cjs1-pluginsinstall-plugin)
+* [`cjs1 plugins:inspect PLUGIN...`](#cjs1-pluginsinspect-plugin)
+* [`cjs1 plugins:install PLUGIN...`](#cjs1-pluginsinstall-plugin-1)
+* [`cjs1 plugins:link PLUGIN`](#cjs1-pluginslink-plugin)
+* [`cjs1 plugins:uninstall PLUGIN...`](#cjs1-pluginsuninstall-plugin)
+* [`cjs1 plugins:uninstall PLUGIN...`](#cjs1-pluginsuninstall-plugin-1)
+* [`cjs1 plugins:uninstall PLUGIN...`](#cjs1-pluginsuninstall-plugin-2)
+* [`cjs1 plugins update`](#cjs1-plugins-update)
+
+## `cjs1 cjs1`
+
+```
+USAGE
+  $ cjs1 cjs1
+```
+
+_See code: [dist/commands/cjs1.ts](https://github.com/oclif/plugin-test-cjs-1/blob/v0.1.0/dist/commands/cjs1.ts)_
+
+## `cjs1 help [COMMANDS]`
+
+Display help for cjs1.
+
+```
+USAGE
+  $ cjs1 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 cjs1.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.14/src/commands/help.ts)_
+
+## `cjs1 plugins`
+
+List installed plugins.
+
+```
+USAGE
+  $ cjs1 plugins [--core]
+
+FLAGS
+  --core  Show core plugins.
+
+DESCRIPTION
+  List installed plugins.
+
+EXAMPLES
+  $ cjs1 plugins
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/index.ts)_
+
+## `cjs1 plugins:install PLUGIN...`
+
+Installs a plugin into the CLI.
+
+```
+USAGE
+  $ cjs1 plugins:install PLUGIN...
+
+ARGUMENTS
+  PLUGIN  Plugin to install.
+
+FLAGS
+  -f, --force    Run yarn install with force flag.
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+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
+  $ cjs1 plugins add
+
+EXAMPLES
+  $ cjs1 plugins:install myplugin 
+
+  $ cjs1 plugins:install https://github.com/someuser/someplugin
+
+  $ cjs1 plugins:install someuser/someplugin
+```
+
+## `cjs1 plugins:inspect PLUGIN...`
+
+Displays installation properties of a plugin.
+
+```
+USAGE
+  $ cjs1 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
+  $ cjs1 plugins:inspect myplugin
+```
+
+## `cjs1 plugins:install PLUGIN...`
+
+Installs a plugin into the CLI.
+
+```
+USAGE
+  $ cjs1 plugins:install PLUGIN...
+
+ARGUMENTS
+  PLUGIN  Plugin to install.
+
+FLAGS
+  -f, --force    Run yarn install with force flag.
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+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
+  $ cjs1 plugins add
+
+EXAMPLES
+  $ cjs1 plugins:install myplugin 
+
+  $ cjs1 plugins:install https://github.com/someuser/someplugin
+
+  $ cjs1 plugins:install someuser/someplugin
+```
+
+## `cjs1 plugins:link PLUGIN`
+
+Links a plugin into the CLI for development.
+
+```
+USAGE
+  $ cjs1 plugins:link PLUGIN
+
+ARGUMENTS
+  PATH  [default: .] path to plugin
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+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
+  $ cjs1 plugins:link myplugin
+```
+
+## `cjs1 plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ cjs1 plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ cjs1 plugins unlink
+  $ cjs1 plugins remove
+```
+
+## `cjs1 plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ cjs1 plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ cjs1 plugins unlink
+  $ cjs1 plugins remove
+```
+
+## `cjs1 plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ cjs1 plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ cjs1 plugins unlink
+  $ cjs1 plugins remove
+```
+
+## `cjs1 plugins update`
+
+Update installed plugins.
+
+```
+USAGE
+  $ cjs1 plugins update [-h] [-v]
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Update installed plugins.
+```
+<!-- commandsstop -->

package/bin/dev

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+const path = require('path')
+const project = path.join(__dirname, '..', 'tsconfig.json')
+
+// In dev mode -> use ts-node and dev plugins
+process.env.NODE_ENV = 'development'
+
+require('ts-node').register({project})
+
+// In dev mode, always show stack traces
+oclif.settings.debug = true;
+
+// Start the CLI
+oclif.run().then(oclif.flush).catch(oclif.Errors.handle)

package/bin/dev.cmd

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

package/bin/run

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+oclif.run().then(require('@oclif/core/flush')).catch(require('@oclif/core/handle'))

package/bin/run.cmd

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

package/dist/commands/cjs1.d.ts

@@ -0,0 +1,4 @@
+import { Command } from '@oclif/core';
+export default class CJS1 extends Command {
+    run(): Promise<void>;
+}

package/dist/commands/cjs1.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+class CJS1 extends core_1.Command {
+    async run() {
+        this.log(`hello I am a CJS plugin from ${this.config.root}!`);
+    }
+}
+exports.default = CJS1;

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,15 @@
+{
+  "version": "0.1.0",
+  "commands": {
+    "cjs1": {
+      "id": "cjs1",
+      "strict": true,
+      "pluginName": "@oclif/plugin-test-cjs-1",
+      "pluginAlias": "@oclif/plugin-test-cjs-1",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {},
+      "args": {}
+    }
+  }
+}

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@oclif/plugin-test-cjs-1",
+  "version": "0.1.0",
+  "description": "Test CJS plugin",
+  "author": "Salesforce",
+  "bin": {
+    "cjs1": "./bin/run"
+  },
+  "homepage": "https://github.com/oclif/plugin-test-cjs-1",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "repository": "oclif/plugin-test-cjs-1",
+  "files": [
+    "/bin",
+    "/dist",
+    "/npm-shrinkwrap.json",
+    "/oclif.manifest.json"
+  ],
+  "dependencies": {
+    "@oclif/core": "^2",
+    "@oclif/plugin-help": "^5",
+    "@oclif/plugin-plugins": "^2.4.7"
+  },
+  "devDependencies": {
+    "@oclif/test": "^2.4.0",
+    "@types/chai": "^4",
+    "@types/mocha": "^9.0.0",
+    "@types/node": "^16.18.39",
+    "chai": "^4",
+    "eslint": "^7.32.0",
+    "eslint-config-oclif": "^4",
+    "eslint-config-oclif-typescript": "^1.0.3",
+    "mocha": "^9",
+    "oclif": "^3.10.0",
+    "shx": "^0.3.3",
+    "ts-node": "^10.9.1",
+    "tslib": "^2.6.1",
+    "typescript": "^4.9.5"
+  },
+  "oclif": {
+    "bin": "cjs1",
+    "dirname": "cjs1",
+    "commands": "./dist/commands",
+    "plugins": [
+      "@oclif/plugin-help",
+      "@oclif/plugin-plugins"
+    ],
+    "topicSeparator": " ",
+    "topics": {
+      "hello": {
+        "description": "Say hello to the world and others"
+      }
+    }
+  },
+  "scripts": {
+    "build": "shx rm -rf dist && tsc -b",
+    "lint": "eslint . --ext .ts --config .eslintrc",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "posttest": "yarn lint",
+    "prepack": "yarn build && oclif manifest && oclif readme",
+    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+    "version": "oclif readme && git add README.md"
+  },
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "bugs": "https://github.com/oclif/plugin-test-cjs-1/issues",
+  "keywords": [
+    "oclif"
+  ],
+  "types": "dist/index.d.ts"
+}