@oclif/plugin-help 5.0.1 → 5.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -2,6 +2,34 @@
2
2
 
3
3
  All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
4
4
 
5
+ ### [5.1.3](https://github.com/oclif/plugin-help/compare/v5.1.2...v5.1.3) (2021-11-18)
6
+
7
+
8
+ ### Bug Fixes
9
+
10
+ * bump oclif/core one more time ([#309](https://github.com/oclif/plugin-help/issues/309)) ([ca5a5b1](https://github.com/oclif/plugin-help/commit/ca5a5b10b79904588ed8fba55dac1ef83d84f4ad))
11
+
12
+ ### [5.1.2](https://github.com/oclif/plugin-help/compare/v5.1.1...v5.1.2) (2021-11-08)
13
+
14
+
15
+ ### Bug Fixes
16
+
17
+ * bump oclif/core to v1 ([#304](https://github.com/oclif/plugin-help/issues/304)) ([4dbe2fc](https://github.com/oclif/plugin-help/commit/4dbe2fc3f09f477efe98ba49a7c585a395ca3cfb))
18
+
19
+ ### [5.1.1](https://github.com/oclif/plugin-help/compare/v5.1.0...v5.1.1) (2021-09-29)
20
+
21
+
22
+ ### Bug Fixes
23
+
24
+ * adjust help text to new style guide ([#282](https://github.com/oclif/plugin-help/issues/282)) ([58e35ce](https://github.com/oclif/plugin-help/commit/58e35ce281dcb302e801d09d2e4a05bf7a6fa0cc))
25
+
26
+ ## [5.1.0](https://github.com/oclif/plugin-help/compare/v5.0.1...v5.1.0) (2021-09-23)
27
+
28
+
29
+ ### Features
30
+
31
+ * rename help cmd flag --all to --nested-commands ([#279](https://github.com/oclif/plugin-help/issues/279)) ([27772d2](https://github.com/oclif/plugin-help/commit/27772d2e947e5ff4cc668f6d3cf81b54c46ca62a))
32
+
5
33
  ### [5.0.1](https://github.com/oclif/plugin-help/compare/v5.0.0...v5.0.1) (2021-09-21)
6
34
 
7
35
  ## [5.0.0](https://github.com/oclif/plugin-help/compare/v4.0.3...v5.0.0) (2021-09-21)
@@ -2,7 +2,7 @@ import { Command } from '@oclif/core';
2
2
  export default class HelpCommand extends Command {
3
3
  static description: string;
4
4
  static flags: {
5
- all: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
5
+ 'nested-commands': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
6
6
  };
7
7
  static args: {
8
8
  name: string;
@@ -4,16 +4,19 @@ const core_1 = require("@oclif/core");
4
4
  class HelpCommand extends core_1.Command {
5
5
  async run() {
6
6
  const { flags, argv } = await this.parse(HelpCommand);
7
- const help = new core_1.Help(this.config, { all: flags.all });
7
+ const help = new core_1.Help(this.config, { all: flags['nested-commands'] });
8
8
  await help.showHelp(argv);
9
9
  }
10
10
  }
11
11
  exports.default = HelpCommand;
12
- HelpCommand.description = 'display help for <%= config.bin %>';
12
+ HelpCommand.description = 'Display help for <%= config.bin %>.';
13
13
  HelpCommand.flags = {
14
- all: core_1.Flags.boolean({ description: 'see all commands in CLI' }),
14
+ 'nested-commands': core_1.Flags.boolean({
15
+ description: 'Include all nested commands in the output.',
16
+ char: 'n',
17
+ }),
15
18
  };
16
19
  HelpCommand.args = [
17
- { name: 'command', required: false, description: 'command to show help for' },
20
+ { name: 'command', required: false, description: 'Command to show help for.' },
18
21
  ];
19
22
  HelpCommand.strict = false;
@@ -1 +1 @@
1
- {"version":"5.0.1","commands":{"help":{"id":"help","description":"display help for <%= config.bin %>","pluginName":"@oclif/plugin-help","pluginType":"core","aliases":[],"flags":{"all":{"name":"all","type":"boolean","description":"see all commands in CLI","allowNo":false}},"args":[{"name":"command","description":"command to show help for","required":false}]}}}
1
+ {"version":"5.1.3","commands":{"help":{"id":"help","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}},"args":[{"name":"command","description":"Command to show help for.","required":false}]}}}
package/package.json CHANGED
@@ -1,14 +1,13 @@
1
1
  {
2
2
  "name": "@oclif/plugin-help",
3
- "description": "standard help for oclif",
4
- "version": "5.0.1",
3
+ "description": "Standard help for oclif.",
4
+ "version": "5.1.3",
5
5
  "author": "Jeff Dickey @jdxcode",
6
6
  "bugs": "https://github.com/oclif/plugin-help/issues",
7
7
  "dependencies": {
8
- "@oclif/core": "^0.5.39"
8
+ "@oclif/core": "^1.0.3"
9
9
  },
10
10
  "devDependencies": {
11
- "@oclif/dev-cli": "^1.26.0",
12
11
  "@oclif/plugin-plugins": "^1.10.1",
13
12
  "@oclif/test": "core-v1",
14
13
  "@types/chai": "^4.1.7",
@@ -18,7 +17,7 @@
18
17
  "eslint-config-oclif": "^3.1.0",
19
18
  "eslint-config-oclif-typescript": "^0.2.0",
20
19
  "mocha": "^8.2.1",
21
- "oclif": "^1.18.1",
20
+ "oclif": "^2.0.0-main.10",
22
21
  "shx": "^0.3.3",
23
22
  "ts-node": "^9.1.1",
24
23
  "typescript": "^4.3.5"
@@ -50,7 +49,7 @@
50
49
  "pretest": "yarn build && tsc --noEmit",
51
50
  "test": "mocha --forbid-only \"test/**/*.test.ts\"",
52
51
  "posttest": "yarn lint",
53
- "prepack": "yarn run build && oclif-dev manifest",
52
+ "prepack": "yarn run build && oclif manifest .",
54
53
  "postpack": "shx rm oclif.manifest.json"
55
54
  },
56
55
  "types": "./lib/help.d.ts"