oclif 4.22.97 → 4.23.0

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.
@@ -10,6 +10,7 @@ export default class Readme extends Command {
10
10
  'plugin-directory': Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
11
11
  'readme-path': Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
12
12
  'repository-prefix': Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
13
+ 'source-links': Interfaces.BooleanFlag<boolean>;
13
14
  'tsconfig-path': Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
14
15
  version: Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
15
16
  };
@@ -84,6 +84,11 @@ Customize the code URL prefix by setting oclif.repositoryPrefix in package.json.
84
84
  'repository-prefix': core_1.Flags.string({
85
85
  description: 'A template string used to build links to the source code.',
86
86
  }),
87
+ 'source-links': core_1.Flags.boolean({
88
+ allowNo: true,
89
+ default: true,
90
+ description: 'Include links to the source code for each command.',
91
+ }),
87
92
  'tsconfig-path': core_1.Flags.string({
88
93
  default: 'tsconfig.json',
89
94
  description: 'Path to the tsconfig file',
@@ -131,6 +136,7 @@ Customize the code URL prefix by setting oclif.repositoryPrefix in package.json.
131
136
  pluginDir: this.flags['plugin-directory'],
132
137
  readmePath,
133
138
  repositoryPrefix: this.flags['repository-prefix'],
139
+ sourceLinks: this.flags['source-links'],
134
140
  version: this.flags.version,
135
141
  });
136
142
  const readme = await generator.generate();
@@ -11,6 +11,7 @@ type Options = {
11
11
  pluginDir?: string;
12
12
  readmePath: string;
13
13
  repositoryPrefix?: string;
14
+ sourceLinks?: boolean;
14
15
  version?: string;
15
16
  };
16
17
  export default class ReadmeGenerator {
@@ -61,6 +61,8 @@ class ReadmeGenerator {
61
61
  this.options = options;
62
62
  }
63
63
  commandCode(c) {
64
+ if (this.options.sourceLinks === false)
65
+ return;
64
66
  const pluginName = c.pluginName;
65
67
  if (!pluginName)
66
68
  return;
@@ -546,6 +546,12 @@
546
546
  "multiple": false,
547
547
  "type": "option"
548
548
  },
549
+ "source-links": {
550
+ "description": "Include links to the source code for each command.",
551
+ "name": "source-links",
552
+ "allowNo": true,
553
+ "type": "boolean"
554
+ },
549
555
  "tsconfig-path": {
550
556
  "description": "Path to the tsconfig file",
551
557
  "name": "tsconfig-path",
@@ -1195,5 +1201,5 @@
1195
1201
  ]
1196
1202
  }
1197
1203
  },
1198
- "version": "4.22.97"
1204
+ "version": "4.23.0"
1199
1205
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "oclif",
3
3
  "description": "oclif: create your own CLI",
4
- "version": "4.22.97",
4
+ "version": "4.23.0",
5
5
  "author": "Salesforce",
6
6
  "bin": {
7
7
  "oclif": "bin/run.js"
@@ -26,7 +26,7 @@
26
26
  "fs-extra": "^8.1",
27
27
  "github-slugger": "^2",
28
28
  "got": "^13",
29
- "lodash": "^4.17.23",
29
+ "lodash": "^4.18.1",
30
30
  "normalize-package-data": "^6",
31
31
  "semver": "^7.7.4",
32
32
  "sort-package-json": "^2.15.1",