oclif 4.0.3 → 4.1.0

package/lib/command-base.js

@@ -6,8 +6,6 @@ class CommandBase extends core_1.Command {
     async generate(type, generatorOptions = {}) {
         const env = (0, yeoman_environment_1.createEnv)();
         env.register(require.resolve(`./generators/${type}`), `oclif:${type}`);
-        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-ignore
         await env.run(`oclif:${type}`, generatorOptions);
     }
 }

package/lib/commands/pack/win.d.ts

@@ -3,6 +3,7 @@ export default class PackWin extends Command {
     static description: string;
     static flags: {
         'additional-cli': Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
+        'defender-exclusion': Interfaces.OptionFlag<"hidden" | "checked" | "unchecked", Interfaces.CustomOptions>;
         root: Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
         tarball: Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
         targets: Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;

package/lib/commands/pack/win.js

@@ -12,8 +12,7 @@ const upload_util_1 = require("../../upload-util");
 const exec = (0, node_util_1.promisify)(node_child_process_1.exec);
 const scripts = {
     /* eslint-disable no-useless-escape */
-    // eslint-disable-next-line unicorn/no-useless-undefined
-    cmd: (config, additionalCLI = undefined) => `@echo off
+    cmd: (config, additionalCLI) => `@echo off
 setlocal enableextensions
 
 set ${additionalCLI ? `${additionalCLI.toUpperCase()}_BINPATH` : config.scopedEnvVarKey('BINPATH')}=%~dp0\\${additionalCLI ?? config.bin}.cmd
@@ -23,7 +22,7 @@ if exist "%LOCALAPPDATA%\\${config.dirname}\\client\\bin\\${additionalCLI ?? con
   "%~dp0\\..\\client\\bin\\node.exe" "%~dp0\\..\\client\\${additionalCLI ? `${additionalCLI}\\bin\\run` : 'bin\\run'}" %*
 )
 `,
-    nsis: (config, arch, customization) => `!include MUI2.nsh
+    nsis: ({ arch, config, customization, defenderOptionDefault, hideDefenderOption, }) => `!include MUI2.nsh
 
 !define Version '${config.version.split('-')[0]}'
 Name "${config.name}"
@@ -76,7 +75,7 @@ Section "Set PATH to ${config.name}"
   Call AddToPath
 SectionEnd
 
-Section "Add %LOCALAPPDATA%\\${config.dirname} to Windows Defender exclusions (highly recommended for performance!)"
+Section ${defenderOptionDefault ? '' : '/o '}"${hideDefenderOption ? '-' : ''}Add %LOCALAPPDATA%\\${config.dirname} to Windows Defender exclusions (highly recommended for performance!)"
   ExecShell "" '"$0"' "/C powershell -ExecutionPolicy Bypass -Command $\\"& {Add-MpPreference -ExclusionPath $\\"$LOCALAPPDATA\\${config.dirname}$\\"}$\\" -FFFeatureOff" SW_HIDE
 SectionEnd
 
@@ -203,14 +202,21 @@ 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
 the CLI should already exist in a directory named after the CLI that is the root of the tarball produced by "oclif pack:tarballs"`,
             hidden: true,
         }),
+        'defender-exclusion': core_1.Flags.option({
+            options: ['checked', 'unchecked', 'hidden'],
+        })({
+            default: 'checked',
+            description: 'there is no way to set a hidden checkbox with "true" as a default...the user can always allow full security',
+            summary: `set to "checked" or "unchecked" to set the default value for the checkbox.  Set to "hidden" to hide the option (will let defender do its thing)`,
+        }),
         root: core_1.Flags.string({
             char: 'r',
             default: '.',
@@ -231,9 +237,9 @@ the CLI should already exist in a directory named after the CLI that is the root
         const { flags } = await this.parse(PackWin);
         const buildConfig = await Tarballs.buildConfig(flags.root, { targets: flags?.targets?.split(',') });
         const { config } = buildConfig;
-        await Tarballs.build(buildConfig, { pack: false, parallel: true, platform: 'win32', tarball: flags.tarball });
-        const arches = buildConfig.targets.filter((t) => t.platform === 'win32').map((t) => t.arch);
         const nsisCustomization = config.nsisCustomization ? (0, node_fs_1.readFileSync)(config.nsisCustomization, 'utf8') : '';
+        const arches = buildConfig.targets.filter((t) => t.platform === 'win32').map((t) => t.arch);
+        await Tarballs.build(buildConfig, { pack: false, parallel: true, platform: 'win32', tarball: flags.tarball });
         await Promise.all(arches.map(async (arch) => {
             const installerBase = path.join(buildConfig.tmp, `windows-${arch}-installer`);
             await (0, promises_1.rm)(installerBase, { force: true, recursive: true });
@@ -241,7 +247,14 @@ the CLI should already exist in a directory named after the CLI that is the root
             await Promise.all([
                 (0, promises_1.writeFile)(path.join(installerBase, 'bin', `${config.bin}.cmd`), scripts.cmd(config)),
                 (0, promises_1.writeFile)(path.join(installerBase, 'bin', `${config.bin}`), scripts.sh(config)),
-                (0, promises_1.writeFile)(path.join(installerBase, `${config.bin}.nsi`), scripts.nsis(config, arch, nsisCustomization)),
+                (0, promises_1.writeFile)(path.join(installerBase, `${config.bin}.nsi`), scripts.nsis({
+                    arch,
+                    config,
+                    customization: nsisCustomization,
+                    // hiding it also unchecks it
+                    defenderOptionDefault: flags['defender-exclusion'] === 'hidden' ? false : flags['default-defender-exclusion'],
+                    hideDefenderOption: flags['hide-defender-option'] === 'hidden',
+                })),
                 ...(config.binAliases
                     ? config.binAliases.flatMap((alias) => 
                     // write duplicate files for windows aliases

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

@@ -19,6 +19,7 @@
         }
       },
       "hasDynamicHelp": false,
+      "hiddenAliases": [],
       "id": "generate",
       "pluginAlias": "oclif",
       "pluginName": "oclif",
@@ -37,6 +38,7 @@
       "description": "Using oclif.lock allows your plugins dependencies to be locked to the version specified in the lock file during plugin install.\nOnce the oclif.lock file is created you can include it your npm package by adding it to the files property of your package.json. We do not recommend committing the oclif.lock file to git.",
       "flags": {},
       "hasDynamicHelp": false,
+      "hiddenAliases": [],
       "id": "lock",
       "pluginAlias": "oclif",
       "pluginName": "oclif",
@@ -70,6 +72,7 @@
         }
       },
       "hasDynamicHelp": false,
+      "hiddenAliases": [],
       "id": "manifest",
       "pluginAlias": "oclif",
       "pluginName": "oclif",
@@ -175,6 +178,7 @@
         }
       },
       "hasDynamicHelp": false,
+      "hiddenAliases": [],
       "id": "promote",
       "pluginAlias": "oclif",
       "pluginName": "oclif",
@@ -214,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",
@@ -230,6 +243,7 @@
         }
       },
       "hasDynamicHelp": false,
+      "hiddenAliases": [],
       "id": "readme",
       "pluginAlias": "oclif",
       "pluginName": "oclif",
@@ -262,6 +276,7 @@
         }
       },
       "hasDynamicHelp": false,
+      "hiddenAliases": [],
       "id": "generate:command",
       "pluginAlias": "oclif",
       "pluginName": "oclif",
@@ -302,6 +317,7 @@
         }
       },
       "hasDynamicHelp": false,
+      "hiddenAliases": [],
       "id": "generate:hook",
       "pluginAlias": "oclif",
       "pluginName": "oclif",
@@ -341,6 +357,7 @@
         }
       },
       "hasDynamicHelp": false,
+      "hiddenAliases": [],
       "id": "pack:deb",
       "pluginAlias": "oclif",
       "pluginName": "oclif",
@@ -396,6 +413,7 @@
         }
       },
       "hasDynamicHelp": false,
+      "hiddenAliases": [],
       "id": "pack:macos",
       "pluginAlias": "oclif",
       "pluginName": "oclif",
@@ -456,6 +474,7 @@
         }
       },
       "hasDynamicHelp": false,
+      "hiddenAliases": [],
       "id": "pack:tarballs",
       "pluginAlias": "oclif",
       "pluginName": "oclif",
@@ -473,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\"",
@@ -483,6 +502,20 @@
           "multiple": false,
           "type": "option"
         },
+        "defender-exclusion": {
+          "description": "there is no way to set a hidden checkbox with \"true\" as a default...the user can always allow full security",
+          "name": "defender-exclusion",
+          "summary": "set to \"checked\" or \"unchecked\" to set the default value for the checkbox.  Set to \"hidden\" to hide the option (will let defender do its thing)",
+          "default": "checked",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "checked",
+            "unchecked",
+            "hidden"
+          ],
+          "type": "option"
+        },
         "root": {
           "char": "r",
           "description": "path to oclif CLI root",
@@ -511,6 +544,7 @@
         }
       },
       "hasDynamicHelp": false,
+      "hiddenAliases": [],
       "id": "pack:win",
       "pluginAlias": "oclif",
       "pluginName": "oclif",
@@ -542,6 +576,7 @@
         }
       },
       "hasDynamicHelp": false,
+      "hiddenAliases": [],
       "id": "upload:deb",
       "pluginAlias": "oclif",
       "pluginName": "oclif",
@@ -581,6 +616,7 @@
         }
       },
       "hasDynamicHelp": false,
+      "hiddenAliases": [],
       "id": "upload:macos",
       "pluginAlias": "oclif",
       "pluginName": "oclif",
@@ -626,6 +662,7 @@
         }
       },
       "hasDynamicHelp": false,
+      "hiddenAliases": [],
       "id": "upload:tarballs",
       "pluginAlias": "oclif",
       "pluginName": "oclif",
@@ -664,6 +701,7 @@
         }
       },
       "hasDynamicHelp": false,
+      "hiddenAliases": [],
       "id": "upload:win",
       "pluginAlias": "oclif",
       "pluginName": "oclif",
@@ -679,5 +717,5 @@
       ]
     }
   },
-  "version": "4.0.3"
+  "version": "4.1.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "oclif",
   "description": "oclif: create your own CLI",
-  "version": "4.0.3",
+  "version": "4.1.0",
   "author": "Salesforce",
   "bin": {
     "oclif": "bin/run.js"
@@ -31,13 +31,13 @@
     "@commitlint/config-conventional": "^17.7.0",
     "@oclif/plugin-legacy": "^1.3.0",
     "@oclif/prettier-config": "^0.2.1",
-    "@oclif/test": "^3.0.2",
+    "@oclif/test": "^3.1.2",
     "@types/async-retry": "^1.4.5",
     "@types/chai": "^4.3.4",
     "@types/cli-progress": "^3.11.0",
     "@types/fs-extra": "^9.0",
-    "@types/lodash.template": "^4.5.0",
     "@types/lodash": "^4.14.191",
+    "@types/lodash.template": "^4.5.0",
     "@types/mocha": "^10.0.2",
     "@types/node": "^18",
     "@types/semver": "^7.3.13",
@@ -46,10 +46,10 @@
     "chai": "^4.3.7",
     "commitlint": "^17.7.2",
     "conventional-changelog-cli": "^2.2.2",
-    "eslint-config-oclif-typescript": "^3.0.1",
+    "eslint": "^8.50.0",
     "eslint-config-oclif": "^5.0.0",
+    "eslint-config-oclif-typescript": "^3.0.1",
     "eslint-config-prettier": "^9.0.0",
-    "eslint": "^8.50.0",
     "fancy-test": "^3.0.1",
     "globby": "^11.1.0",
     "husky": "^8.0.3",