oclif 3.15.1 → 3.16.0

package/.oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "3.15.1",
+  "version": "3.16.0",
   "commands": {
     "generate": {
       "id": "generate",
@@ -173,6 +173,18 @@
           "type": "boolean",
           "description": "include aliases in the command list",
           "allowNo": true
+        },
+        "repository-prefix": {
+          "name": "repository-prefix",
+          "type": "option",
+          "description": "a template string used to build links to the source code",
+          "multiple": false
+        },
+        "version": {
+          "name": "version",
+          "type": "option",
+          "description": "version to use in readme links. defaults to the version in package.json",
+          "multiple": false
         }
       },
       "args": {}

package/lib/commands/readme.d.ts

@@ -5,8 +5,11 @@ export default class Readme extends Command {
         dir: Interfaces.OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
         multi: Interfaces.BooleanFlag<boolean>;
         aliases: Interfaces.BooleanFlag<boolean>;
+        'repository-prefix': Interfaces.OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        version: Interfaces.OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
     };
     private HelpClass;
+    private flags;
     run(): Promise<void>;
     replaceTag(readme: string, tag: string, body: string): string;
     toc(__: Interfaces.Config, readme: string): string;

package/lib/commands/readme.js

@@ -13,7 +13,7 @@ const columns = Number.parseInt(process.env.COLUMNS, 10) || 120;
 const slugify = new (require('github-slugger'))();
 class Readme extends core_1.Command {
     async run() {
-        const { flags } = await this.parse(Readme);
+        this.flags = (await this.parse(Readme)).flags;
         const cwd = process.cwd();
         const readmePath = path.resolve(cwd, 'README.md');
         const config = await core_1.Config.load({ root: cwd, devPlugins: false, userPlugins: false });
@@ -29,13 +29,13 @@ class Readme extends core_1.Command {
         let readme = await fs.readFile(readmePath, 'utf8');
         let commands = config.commands
             .filter(c => !c.hidden && c.pluginType === 'core')
-            .filter(c => flags.aliases ? true : !c.aliases.includes(c.id))
+            .filter(c => this.flags.aliases ? true : !c.aliases.includes(c.id))
             .map(c => c.id === '.' ? Object.assign(Object.assign({}, c), { id: '' }) : c);
         this.debug('commands:', commands.map(c => c.id).length);
         commands = (0, util_1.uniqBy)(commands, c => c.id);
         commands = (0, util_1.sortBy)(commands, c => c.id);
         readme = this.replaceTag(readme, 'usage', this.usage(config));
-        readme = this.replaceTag(readme, 'commands', flags.multi ? this.multiCommands(config, commands, flags.dir) : this.commands(config, commands));
+        readme = this.replaceTag(readme, 'commands', this.flags.multi ? this.multiCommands(config, commands, this.flags.dir) : this.commands(config, commands));
         readme = this.replaceTag(readme, 'toc', this.toc(config, readme));
         readme = readme.trimEnd();
         readme += '\n';
@@ -66,7 +66,7 @@ $ npm install -g ${config.name}
 $ ${config.bin} COMMAND
 running command...
 $ ${config.bin} ${versionFlagsString}
-${config.name}/${process.env.OCLIF_NEXT_VERSION || config.version} ${process.platform}-${process.arch} node-v${process.versions.node}
+${config.name}/${this.flags.version || config.version} ${process.platform}-${process.arch} node-v${process.versions.node}
 $ ${config.bin} --help [COMMAND]
 USAGE
   $ ${config.bin} COMMAND
@@ -156,9 +156,9 @@ USAGE
             return;
         if (config.name === plugin.name) {
             label = commandPath;
-            version = process.env.OCLIF_NEXT_VERSION || version;
+            version = this.flags.version || version;
         }
-        const template = plugin.pjson.oclif.repositoryPrefix || '<%- repo %>/blob/v<%- version %>/<%- commandPath %>';
+        const template = this.flags['repository-prefix'] || plugin.pjson.oclif.repositoryPrefix || '<%- repo %>/blob/v<%- version %>/<%- commandPath %>';
         return `_See code: [${label}](${_.template(template)({ repo, version, commandPath, config, c })})_`;
     }
     repo(plugin) {
@@ -168,7 +168,7 @@ USAGE
         if (!repo)
             return;
         const url = new url_1.URL(repo);
-        if (!['github.com', 'gitlab.com'].includes(url.hostname) && !pjson.oclif.repositoryPrefix)
+        if (!['github.com', 'gitlab.com'].includes(url.hostname) && !pjson.oclif.repositoryPrefix && !this.flags['repository-prefix'])
             return;
         return `https://${url.hostname}${url.pathname.replace(/\.git$/, '')}`;
     }
@@ -245,4 +245,6 @@ Readme.flags = {
     dir: core_1.Flags.string({ description: 'output directory for multi docs', default: 'docs', required: true }),
     multi: core_1.Flags.boolean({ description: 'create a different markdown page for each topic' }),
     aliases: core_1.Flags.boolean({ description: 'include aliases in the command list', allowNo: true, default: true }),
+    'repository-prefix': core_1.Flags.string({ description: 'a template string used to build links to the source code' }),
+    version: core_1.Flags.string({ description: 'version to use in readme links. defaults to the version in package.json', env: 'OCLIF_NEXT_VERSION' }),
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "oclif",
   "description": "oclif: create your own CLI",
-  "version": "3.15.1",
+  "version": "3.16.0",
   "author": "Salesforce",
   "bin": {
     "oclif": "bin/run"