@oclif/plugin-help - npm Package Compare versions

Comparing version 5.2.20 to 6.0.1

lib/commands/help.d.ts

 import { Command } from '@oclif/core';
 export default class HelpCommand extends Command {
+    static args: {
+        commands: import("@oclif/core/lib/interfaces/parser.js").Arg<string | undefined, Record<string, unknown>>;
+    };
     static description: string;
     static flags: {
-        'nested-commands': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        'nested-commands': import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
     };
-    static args: {
-        commands: import("@oclif/core/lib/interfaces/parser").Arg<string | undefined, Record<string, unknown>>;
-    };
     static strict: boolean;
     run(): Promise<void>;
 }

lib/commands/help.js

@@ -1,22 +0,19 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const core_1 = require("@oclif/core");
-class HelpCommand extends core_1.Command {
+import { Args, Command, Flags, Help } from '@oclif/core';
+export default class HelpCommand extends Command {
+    static args = {
+        commands: Args.string({ description: 'Command to show help for.', required: false }),
+    };
+    static description = 'Display help for <%= config.bin %>.';
+    static flags = {
+        'nested-commands': Flags.boolean({
+            char: 'n',
+            description: 'Include all nested commands in the output.',
+        }),
+    };
+    static strict = false;
     async run() {
-        const { flags, argv } = await this.parse(HelpCommand);
-        const help = new core_1.Help(this.config, { all: flags['nested-commands'] });
+        const { argv, flags } = await this.parse(HelpCommand);
+        const help = new Help(this.config, { all: flags['nested-commands'] });
         await help.showHelp(argv);
     }
 }
-exports.default = HelpCommand;
-HelpCommand.description = 'Display help for <%= config.bin %>.';
-HelpCommand.flags = {
-    'nested-commands': core_1.Flags.boolean({
-        description: 'Include all nested commands in the output.',
-        char: 'n',
-    }),
-};
-HelpCommand.args = {
-    commands: core_1.Args.string({ required: false, description: 'Command to show help for.' }),
-};
-HelpCommand.strict = false;

lib/index.js

@@ -1,3 +0,1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = {};
+export default {};

oclif.manifest.json

 {
-  "version": "5.2.20",
   "commands": {
     "help": {
-      "id": "help",
+      "aliases": [],
+      "args": {
+        "commands": {
+          "description": "Command to show help for.",
+          "name": "commands",
+          "required": false
+        }
+      },
       "description": "Display help for <%= config.bin %>.",
-      "strict": false,
-      "pluginName": "@oclif/plugin-help",
-      "pluginAlias": "@oclif/plugin-help",
-      "pluginType": "core",
-      "aliases": [],
       "flags": {
         "nested-commands": {
-          "name": "nested-commands",
-          "type": "boolean",
           "char": "n",
           "description": "Include all nested commands in the output.",
-          "allowNo": false
+          "name": "nested-commands",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
-      "args": {
-        "commands": {
-          "name": "commands",
-          "description": "Command to show help for.",
-          "required": false
-        }
-      }
+      "hasDynamicHelp": false,
+      "id": "help",
+      "pluginAlias": "@oclif/plugin-help",
+      "pluginName": "@oclif/plugin-help",
+      "pluginType": "core",
+      "strict": false,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "help.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "help"
+      ]
     }
-  }
+  },
+  "version": "6.0.1"
 }

package.json

 {
   "name": "@oclif/plugin-help",
   "description": "Standard help for oclif.",
-  "version": "5.2.20",
+  "version": "6.0.1",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/plugin-help/issues",
   "dependencies": {
-    "@oclif/core": "^2.15.0"
+    "@oclif/core": "^3.0.8"
   },
   "devDependencies": {
-    "@oclif/plugin-plugins": "^2.4.7",
-    "@oclif/test": "^2.1.0",
+    "@commitlint/config-conventional": "^17.7.0",
+    "@oclif/prettier-config": "^0.2.1",
+    "@oclif/test": "^3.0.2",
     "@types/chai": "^4.3.6",
-    "@types/mocha": "^9.1.0",
-    "chai": "^4.3.8",
-    "eslint": "^7.3.1",
-    "eslint-config-oclif": "^4.0.0",
-    "eslint-config-oclif-typescript": "^1.0.3",
-    "mocha": "^9.2.2",
-    "oclif": "^3.17.1",
+    "@types/mocha": "^10.0.2",
+    "@types/node": "^18",
+    "chai": "^4.3.10",
+    "commitlint": "^17.7.2",
+    "eslint": "^8.51.0",
+    "eslint-config-oclif": "^5.0.0",
+    "eslint-config-oclif-typescript": "^3.0.5",
+    "eslint-config-prettier": "^9.0.0",
+    "husky": "^8.0.3",
+    "lint-staged": "^14.0.1",
+    "mocha": "^10.2.0",
+    "oclif": "^4.0.2",
+    "prettier": "^3.0.3",
     "shx": "^0.3.4",
-    "ts-node": "^9.1.1",
-    "typescript": "^4.6.3"
+    "ts-node": "^10.9.1",
+    "typescript": "^5.2.2"
   },
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=18.0.0"
   },
+  "exports": "./lib/index.js",
   "files": [
     "oclif.manifest.json",
-    "/lib"
+    "/lib",
+    "/oclif.lock"
   ],
@@ -37,9 +46,7 @@ "homepage": "https://github.com/oclif/plugin-help",
   "license": "MIT",
-  "main": "./lib/index.js",
   "oclif": {
     "commands": "./lib/commands",
     "bin": "oclif",
-    "devPlugins": [
-      "@oclif/plugin-plugins"
-    ]
+    "flexibleTaxonomy": true,
+    "topicSeparator": " "
   },
@@ -49,10 +56,12 @@ "repository": "oclif/plugin-help",
     "build": "shx rm -rf lib && tsc",
-    "lint": "eslint . --ext .ts --config .eslintrc",
+    "lint": "eslint . --ext .ts",
+    "postpack": "shx rm oclif.manifest.json oclif.lock",
+    "posttest": "yarn lint",
+    "prepack": "yarn run build && oclif manifest . && oclif lock",
+    "prepare": "husky install",
     "pretest": "yarn build && tsc --noEmit",
-    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
-    "posttest": "yarn lint",
-    "prepack": "yarn run build && oclif manifest .",
-    "postpack": "shx rm oclif.manifest.json"
+    "test": "mocha --forbid-only \"test/**/*.test.ts\""
   },
+  "type": "module",
   "types": "./lib/index.d.ts"
-}
+}

README.md

@@ -1,3 +0,2 @@
-@oclif/plugin-help
-===================
+# @oclif/plugin-help
 
@@ -7,6 +6,4 @@ A CLI command to invoke the standard help functionality from [oclif/core](https://github.com/oclif/core).
 [![Version](https://img.shields.io/npm/v/@oclif/plugin-help.svg)](https://npmjs.org/package/@oclif/plugin-help)
-[![CircleCI](https://circleci.com/gh/oclif/plugin-help/tree/main.svg?style=svg)](https://circleci.com/gh/oclif/plugin-help/tree/main)
-[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/oclif/plugin-help?branch=main&svg=true)](https://ci.appveyor.com/project/heroku/plugin-help/branch/main)
 [![Known Vulnerabilities](https://snyk.io/test/npm/@oclif/plugin-help/badge.svg)](https://snyk.io/test/npm/@oclif/plugin-help)
 [![Downloads/week](https://img.shields.io/npm/dw/@oclif/plugin-help.svg)](https://npmjs.org/package/@oclif/plugin-help)
 [![License](https://img.shields.io/npm/l/@oclif/plugin-help.svg)](https://github.com/oclif/plugin-help/blob/main/package.json)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

284804

increased by5064.17%

Number of package files

9

increased by12.5%

Lines of code

75

increased by10.29%

Is type module

Yes

Worsened metrics

Dev dependency count

20

increased by53.85%

Number of lines in readme file

9

decreased by-25%

Dependency changes

• + Added@oclif/core@3.27.0(transitive)

• + Addedcolor@4.2.3(transitive)

• + Addedcolor-string@1.9.1(transitive)

• + Addedis-arrayish@0.3.2(transitive)

• + Addedminimatch@9.0.5(transitive)

• + Addedsimple-swizzle@0.2.2(transitive)

• - Removed@cspotcode/source-map-support@0.8.1(transitive)

• - Removed@jridgewell/resolve-uri@3.1.2(transitive)

• - Removed@jridgewell/sourcemap-codec@1.5.0(transitive)

• - Removed@jridgewell/trace-mapping@0.3.9(transitive)

• - Removed@oclif/core@2.16.0(transitive)

• - Removed@tsconfig/node10@1.0.11(transitive)

• - Removed@tsconfig/node12@1.0.11(transitive)

• - Removed@tsconfig/node14@1.0.3(transitive)

• - Removed@tsconfig/node16@1.0.4(transitive)

• - Removedacorn@8.12.1(transitive)

• - Removedacorn-walk@8.3.4(transitive)

• - Removedarg@4.1.3(transitive)

• - Removedcreate-require@1.1.1(transitive)

• - Removeddiff@4.0.2(transitive)

• - Removedmake-error@1.3.6(transitive)

• - Removedts-node@10.9.2(transitive)

• - Removedtslib@2.7.0(transitive)

• - Removedtypescript@5.6.2(transitive)

• - Removedv8-compile-cache-lib@3.0.1(transitive)

• - Removedyn@3.1.1(transitive)

• Updated@oclif/core@^3.0.8