oclif 4.7.0 → 4.7.2

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

@@ -6,5 +6,6 @@ export default class PackDeb extends Command {
         root: Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
         tarball: Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
     };
+    static summary: string;
     run(): Promise<void>;
 }

package/lib/commands/pack/deb.js

@@ -71,7 +71,7 @@ APT::FTPArchive::Release {
 `,
 };
 class PackDeb extends core_1.Command {
-    static description = 'Pack CLI into debian package.';
+    static description = 'Add a pretarball script to your package.json if you need to run any scripts before the tarball is created.';
     static flags = {
         compression: core_1.Flags.option({
             options: ['gzip', 'none', 'xz', 'zstd'],
@@ -87,6 +87,7 @@ class PackDeb extends core_1.Command {
             required: false,
         }),
     };
+    static summary = 'Pack CLI into debian package.';
     async run() {
         if (process.platform !== 'linux')
             throw new Error('debian packing must be run on linux');

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

@@ -7,5 +7,6 @@ export default class PackMacos extends Command {
         tarball: Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
         targets: Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
     };
+    static summary: string;
     run(): Promise<void>;
 }

package/lib/commands/pack/macos.js

@@ -150,7 +150,7 @@ exit 0
     },
 };
 class PackMacos extends core_1.Command {
-    static description = 'Pack CLI into macOS .pkg';
+    static description = 'Add a pretarball script to your package.json if you need to run any scripts before the tarball is created.';
     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
@@ -172,6 +172,7 @@ the CLI should already exist in a directory named after the CLI that is the root
             description: 'Comma-separated targets to pack (e.g.: darwin-x64,darwin-arm64).',
         }),
     };
+    static summary = 'Pack CLI into macOS .pkg';
     async run() {
         if (process.platform !== 'darwin')
             this.error('must be run from macos');

package/lib/commands/pack/tarballs.js

@@ -26,7 +26,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const core_1 = require("@oclif/core");
 const Tarballs = __importStar(require("../../tarballs"));
 class PackTarballs extends core_1.Command {
-    static description = 'This can be used to create oclif CLIs that use the system node or that come preloaded with a node binary.';
+    static description = `This can be used to create oclif CLIs that use the system node or that come preloaded with a node binary.
+
+Add a pretarball script to your package.json if you need to run any scripts before the tarball is created.`;
     static flags = {
         parallel: core_1.Flags.boolean({ description: 'Build tarballs in parallel.' }),
         root: core_1.Flags.string({ char: 'r', default: '.', description: 'Path to oclif CLI root.', required: true }),

package/lib/commands/pack/win.js

@@ -224,7 +224,11 @@ exit $ret
     /* eslint-enable no-useless-escape */
 };
 class PackWin extends core_1.Command {
-    static description = "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 description = `You need to have 7zip, nsis (makensis), and grep installed on your machine in order to run this command.
+
+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.
+
+Add a pretarball script to your package.json if you need to run any scripts before the tarball is created.`;
     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/oclif.manifest.json

@@ -509,7 +509,7 @@
     "pack:deb": {
       "aliases": [],
       "args": {},
-      "description": "Pack CLI into debian package.",
+      "description": "Add a pretarball script to your package.json if you need to run any scripts before the tarball is created.",
       "flags": {
         "compression": {
           "char": "z",
@@ -553,6 +553,7 @@
       "pluginName": "oclif",
       "pluginType": "core",
       "strict": true,
+      "summary": "Pack CLI into debian package.",
       "enableJsonFlag": false,
       "isESM": false,
       "relativePath": [
@@ -565,7 +566,7 @@
     "pack:macos": {
       "aliases": [],
       "args": {},
-      "description": "Pack CLI into macOS .pkg",
+      "description": "Add a pretarball script to your package.json if you need to run any scripts before the tarball is created.",
       "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\"",
@@ -609,6 +610,7 @@
       "pluginName": "oclif",
       "pluginType": "core",
       "strict": true,
+      "summary": "Pack CLI into macOS .pkg",
       "enableJsonFlag": false,
       "isESM": false,
       "relativePath": [
@@ -621,7 +623,7 @@
     "pack:tarballs": {
       "aliases": [],
       "args": {},
-      "description": "This can be used to create oclif CLIs that use the system node or that come preloaded with a node binary.",
+      "description": "This can be used to create oclif CLIs that use the system node or that come preloaded with a node binary.\n\nAdd a pretarball script to your package.json if you need to run any scripts before the tarball is created.",
       "flags": {
         "parallel": {
           "description": "Build tarballs in parallel.",
@@ -683,7 +685,7 @@
     "pack:win": {
       "aliases": [],
       "args": {},
-      "description": "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.",
+      "description": "You need to have 7zip, nsis (makensis), and grep installed on your machine in order to run this command.\n\nThis 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.\n\nAdd a pretarball script to your package.json if you need to run any scripts before the tarball is created.",
       "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\".",
@@ -909,5 +911,5 @@
       ]
     }
   },
-  "version": "4.7.0"
+  "version": "4.7.2"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "oclif",
   "description": "oclif: create your own CLI",
-  "version": "4.7.0",
+  "version": "4.7.2",
   "author": "Salesforce",
   "bin": {
     "oclif": "bin/run.js"
@@ -29,7 +29,7 @@
     "lodash.template": "^4.5.0",
     "normalize-package-data": "^3.0.3",
     "semver": "^7.6.0",
-    "sort-package-json": "^2.8.0",
+    "sort-package-json": "^2.10.0",
     "validate-npm-package-name": "^5.0.0"
   },
   "devDependencies": {