oclif 4.0.4 → 4.1.0

package/lib/commands/pack/win.js

@@ -202,8 +202,8 @@ exit $ret
 };
 class PackWin extends core_1.Command {
     static description = `create windows installer from oclif CLI
-
-  This command requires WINDOWS_SIGNING (prefixed with the name of your executable, e.g. OCLIF_WINDOWS_SIGNING_PASS) to be set in the environment`;
+  
+  This command will produce unsigned installers unless you supply WINDOWS_SIGNING_PASS (prefixed with the name of your executable, e.g. OCLIF_WINDOWS_SIGNING_PASS) in the environment and have set the windows.name and windows.keypath properties in your package.json's oclif property.`;
     static flags = {
         'additional-cli': core_1.Flags.string({
             description: `an Oclif CLI other than the one listed in config.bin that should be made available to the user

package/lib/commands/readme.d.ts

@@ -5,6 +5,7 @@ export default class Readme extends Command {
         aliases: Interfaces.BooleanFlag<boolean>;
         dir: Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
         multi: Interfaces.BooleanFlag<boolean>;
+        'readme-path': Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
         'repository-prefix': Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
         version: Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
     };

package/lib/commands/readme.js

@@ -26,6 +26,7 @@ Customize the code URL prefix by setting oclif.repositoryPrefix in package.json.
         aliases: core_1.Flags.boolean({ allowNo: true, default: true, description: 'include aliases in the command list' }),
         dir: core_1.Flags.string({ default: 'docs', description: 'output directory for multi docs', required: true }),
         multi: core_1.Flags.boolean({ description: 'create a different markdown page for each topic' }),
+        'readme-path': core_1.Flags.string({ default: 'README.md', description: 'Path to the README file.', required: 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',
@@ -138,7 +139,7 @@ Customize the code URL prefix by setting oclif.repositoryPrefix in package.json.
             if (readme.includes(`<!-- ${tag}stop -->`)) {
                 readme = readme.replace(new RegExp(`<!-- ${tag} -->(.|\n)*<!-- ${tag}stop -->`, 'm'), `<!-- ${tag} -->`);
             }
-            this.log(`replacing <!-- ${tag} --> in README.md`);
+            this.log(`replacing <!-- ${tag} --> in ${this.flags['readme-path']}`);
         }
         return readme.replace(`<!-- ${tag} -->`, `<!-- ${tag} -->\n${body}\n<!-- ${tag}stop -->`);
     }
@@ -146,7 +147,7 @@ Customize the code URL prefix by setting oclif.repositoryPrefix in package.json.
         const { flags } = await this.parse(Readme);
         this.flags = flags;
         const cwd = process.cwd();
-        const readmePath = path.resolve(cwd, 'README.md');
+        const readmePath = path.resolve(cwd, flags['readme-path']);
         const tsConfigPath = path.resolve(cwd, 'tsconfig.json');
         const tsConfig = await fs.readJSON(tsConfigPath).catch(() => ({}));
         const outDir = tsConfig.compilerOptions?.outDir ?? 'lib';

package/oclif.manifest.json

@@ -218,6 +218,15 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "readme-path": {
+          "description": "Path to the README file.",
+          "name": "readme-path",
+          "required": true,
+          "default": "README.md",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "repository-prefix": {
           "description": "a template string used to build links to the source code",
           "name": "repository-prefix",
@@ -483,7 +492,7 @@
     "pack:win": {
       "aliases": [],
       "args": {},
-      "description": "create windows installer from oclif CLI\n\n  This command requires WINDOWS_SIGNING (prefixed with the name of your executable, e.g. OCLIF_WINDOWS_SIGNING_PASS) to be set in the environment",
+      "description": "create windows installer from oclif CLI\n  \n  This command will produce unsigned installers unless you supply WINDOWS_SIGNING_PASS (prefixed with the name of your executable, e.g. OCLIF_WINDOWS_SIGNING_PASS) in the environment and have set the windows.name and windows.keypath properties in your package.json's oclif property.",
       "flags": {
         "additional-cli": {
           "description": "an Oclif CLI other than the one listed in config.bin that should be made available to the user\nthe CLI should already exist in a directory named after the CLI that is the root of the tarball produced by \"oclif pack:tarballs\"",
@@ -708,5 +717,5 @@
       ]
     }
   },
-  "version": "4.0.4"
+  "version": "4.1.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "oclif",
   "description": "oclif: create your own CLI",
-  "version": "4.0.4",
+  "version": "4.1.0",
   "author": "Salesforce",
   "bin": {
     "oclif": "bin/run.js"