nodebbs 0.0.0

package/README.md

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

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*

package/bin/dev.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env -S node --loader ts-node/esm --disable-warning=ExperimentalWarning
+
+import {execute} from '@oclif/core'
+
+await execute({development: true, dir: import.meta.url})

package/bin/run.cmd

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

package/bin/run.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import {execute} from '@oclif/core'
+
+await execute({dir: import.meta.url})

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/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        from: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/hello/index.js

@@ -0,0 +1,19 @@
+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() {
+        const { args, flags } = await this.parse(Hello);
+        this.log(`hello ${args.person} from ${flags.from}! (./src/commands/hello/index.ts)`);
+    }
+}

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,14 @@
+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() {
+        this.log('hello world! (./src/commands/hello/world.ts)');
+    }
+}

package/dist/index.d.ts

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

package/dist/index.js

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

package/oclif.manifest.json

@@ -0,0 +1,69 @@
+{
+  "commands": {
+    "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": "nodebbs",
+      "pluginName": "nodebbs",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "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": "nodebbs",
+      "pluginName": "nodebbs",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "hello",
+        "world.js"
+      ]
+    }
+  },
+  "version": "0.0.0"
+}

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "nodebbs",
+  "description": "A new CLI generated with oclif",
+  "version": "0.0.0",
+  "author": "wengqianshan",
+  "bin": {
+    "nodebbs": "./bin/run.js"
+  },
+  "bugs": "https://github.com/nodebbs/nodebbs/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": "^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/nodebbs/nodebbs",
+  "keywords": [
+    "oclif"
+  ],
+  "license": "MIT",
+  "main": "dist/index.js",
+  "type": "module",
+  "oclif": {
+    "bin": "nodebbs",
+    "dirname": "nodebbs",
+    "commands": "./dist/commands",
+    "plugins": [
+      "@oclif/plugin-help",
+      "@oclif/plugin-plugins"
+    ],
+    "topicSeparator": " ",
+    "topics": {
+      "hello": {
+        "description": "Say hello to the world and others"
+      }
+    }
+  },
+  "repository": "nodebbs/nodebbs",
+  "scripts": {
+    "build": "shx rm -rf dist && tsc -b",
+    "lint": "eslint",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "posttest": "pnpm run 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"
+}