@oclif/plugin-command-snapshot 3.3.14 → 4.0.1

package/lib/commands/schema/compare.js

@@ -23,7 +23,7 @@ class SchemaCompare extends snapshot_command_1.SnapshotCommand {
         try {
             fs.accessSync(flags.filepath);
         }
-        catch (_a) {
+        catch {
             this.log(`${flags.filepath} not found.`);
             return [];
         }

package/lib/commands/schema/generate.js

@@ -13,7 +13,7 @@ function getAllFiles(dirPath, ext, allFiles = []) {
     try {
         files = fs.readdirSync(dirPath);
     }
-    catch (_a) { }
+    catch { }
     for (const file of files) {
         const fPath = path.join(dirPath, file);
         if (fs.statSync(fPath).isDirectory()) {
@@ -73,9 +73,8 @@ class SchemaGenerator {
         return getAllFiles(path.join(rootDir, 'commands'), '.ts');
     }
     getAllHookFiles() {
-        var _a, _b;
         // eslint-disable-next-line unicorn/no-array-reduce
-        const hookFiles = Object.values((_b = (_a = this.base.config.pjson.oclif) === null || _a === void 0 ? void 0 : _a.hooks) !== null && _b !== void 0 ? _b : {}).reduce((x, y) => {
+        const hookFiles = Object.values(this.base.config.pjson.oclif?.hooks ?? {}).reduce((x, y) => {
             return Array.isArray(y) ? [...x, ...y] : [...x, y];
         }, []);
         const { rootDir, outDir } = this.getDirs();
@@ -107,14 +106,13 @@ class SchemaGenerator {
      * @returns Returns the name of the return type and the hook id.
      */
     parseHookFile(file) {
-        var _a, _b;
         const returnTypeRegex = /(?<=const\shook:\s(.*?)<)[^'](.*?)[^'](>*)(?=>)/g;
         const contents = fs.readFileSync(file, 'utf8');
         const [returnType] = returnTypeRegex.exec(contents) || [];
         if (!returnType || returnType === 'void') {
             return { returnType: null, hookId: null };
         }
-        const hooks = (_b = (_a = this.base.config.pjson.oclif) === null || _a === void 0 ? void 0 : _a.hooks) !== null && _b !== void 0 ? _b : {};
+        const hooks = this.base.config.pjson.oclif?.hooks ?? {};
         const hookId = Object.keys(hooks).find(key => {
             const hookFiles = (Array.isArray(hooks[key]) ? hooks[key] : [hooks[key]]);
             const hookFileNames = hookFiles.map(f => path.basename(f).split('.')[0]);
@@ -160,7 +158,7 @@ class SchemaGenerator {
             }
             return dirs;
         }
-        catch (_a) { }
+        catch { }
         return dirs;
     }
 }

package/lib/commands/snapshot/compare.d.ts

@@ -6,6 +6,7 @@ interface Change {
 }
 type CommandChange = {
     plugin: string;
+    chars: Change[];
     flags: Change[];
     alias: Change[];
 } & Change;
@@ -26,19 +27,6 @@ export default class Compare extends SnapshotCommand {
      * @returns all the command differences
      */
     compareSnapshot(initialCommands: SnapshotEntry[], updatedCommands: CommandChange[]): Promise<CompareResponse>;
-    /**
-     * @deprecated in favor of diffCommandProperty
-   * Compares a flag snapshot with the current command's flags
-   * @param {string[]} initialFlags Flag list from the snapshot
-   * @param {string[]} updatedFlags Flag list from runtime
-   * @return {boolean} true if no changes, false otherwise
-   */
-    diffCommandFlags(initialFlags: string[], updatedFlags: Change[]): {
-        addedFlags: string[];
-        removedFlags: string[];
-        updatedFlags: Change[];
-        changedFlags: Change[];
-    };
     /**
    * compares two command's properties to each other
    * @return a list of added, removed, updated, and changed properties

package/lib/commands/snapshot/compare.js

@@ -25,15 +25,20 @@ class Compare extends snapshot_command_1.SnapshotCommand {
             if (updatedCommand) {
                 const changedFlags = this.diffCommandProperty(initialCommand.flags, updatedCommand.flags).changedProperty;
                 const changedAlias = this.diffCommandProperty(initialCommand.alias, updatedCommand.alias).changedProperty;
+                const changedChars = this.diffCommandProperty(initialCommand.flagChars, updatedCommand.chars).changedProperty;
                 const flagsChanged = changedFlags.length > 0;
                 const aliasChanged = changedAlias.length > 0;
+                const charsChanged = changedChars.length > 0;
                 if (aliasChanged) {
                     updatedCommand.alias = changedAlias;
                 }
+                if (charsChanged) {
+                    updatedCommand.chars = changedChars;
+                }
                 if (flagsChanged) {
                     updatedCommand.flags = changedFlags;
                 }
-                if (flagsChanged || aliasChanged) {
+                if (flagsChanged || aliasChanged || charsChanged) {
                     diffCommands.push(updatedCommand);
                 }
             }
@@ -73,26 +78,16 @@ class Compare extends snapshot_command_1.SnapshotCommand {
         for (const command of diffCommands) {
             this.log(`\t${command.name}`);
             printCommandDiff(command.flags, 'Flags');
+            printCommandDiff(command.chars, 'Short Flags');
             printCommandDiff(command.alias, 'Aliases');
         }
-        this.log(`${os_1.EOL}Command, flag, or alias differences detected. If intended, please update the snapshot file and run again.`);
+        this.log(`${os_1.EOL}Command, flag, flag characters, or alias differences detected. If intended, please update the snapshot file and run again.`);
         // Check if existent commands, or properties (flags, aliases) have been deleted
         if (removedCommands.length > 0 || removedProperties.length > 0) {
             this.log(chalk.red(`${os_1.EOL}Since there are deletions, a major version bump is required.`));
         }
         return { addedCommands, removedCommands, removedFlags: removedCommands, diffCommands };
     }
-    /**
-     * @deprecated in favor of diffCommandProperty
-   * Compares a flag snapshot with the current command's flags
-   * @param {string[]} initialFlags Flag list from the snapshot
-   * @param {string[]} updatedFlags Flag list from runtime
-   * @return {boolean} true if no changes, false otherwise
-   */
-    diffCommandFlags(initialFlags, updatedFlags) {
-        const diffedFlags = this.diffCommandProperty(initialFlags, updatedFlags);
-        return { addedFlags: diffedFlags.addedProperty, removedFlags: diffedFlags.removedProperty, updatedFlags: diffedFlags.updated, changedFlags: diffedFlags.changedProperty };
-    }
     /**
    * compares two command's properties to each other
    * @return a list of added, removed, updated, and changed properties
@@ -125,6 +120,8 @@ class Compare extends snapshot_command_1.SnapshotCommand {
                 plugin: command.pluginName || '',
                 flags: Object.entries(command.flags).map(flagName => ({ name: flagName[0] })),
                 alias: command.aliases.map(alias => ({ name: alias })),
+                // we can assert as string because of the filter
+                chars: Object.values(command.flags).map(flag => flag.char).filter(char => typeof char === 'string').map(char => ({ name: char })),
             };
         });
     }

package/lib/commands/snapshot/generate.js

@@ -8,6 +8,15 @@ class Generate extends snapshot_command_1.SnapshotCommand {
         const numberOfSpaceChar = 4;
         const { flags } = await this.parse(Generate);
         const resultCommands = this.entries;
+        const duplicatedChar = resultCommands.find(command => command.flags.length > 1 && new Set(command.flagChars).size !== command.flagChars.length);
+        if (duplicatedChar) {
+            throw new Error(`Command "${duplicatedChar.command}" has duplicate short-flag characters "${duplicatedChar.flagChars.filter((item, index) => duplicatedChar.flagChars.indexOf(item) !== index)}"`);
+        }
+        const charConflictCommand = resultCommands.find(command => command.flags.length > 1 && new Set([...command.flags, ...command.flagChars, ...command.flagAliases]).size !== [...command.flags, ...command.flagChars, ...command.flagAliases].length);
+        if (charConflictCommand) {
+            const conflictFlags = [...charConflictCommand.flags, ...charConflictCommand.flagChars, ...charConflictCommand.flagAliases].filter((item, index, array) => array.indexOf(item) !== index);
+            throw new Error(`Command "${charConflictCommand.command}" has conflicting flags "${conflictFlags}"`);
+        }
         const filePath = flags.filepath.replace('{version}', this.config.version);
         fs.writeFileSync(filePath, JSON.stringify(resultCommands, null, numberOfSpaceChar));
         this.log(`Generated snapshot file "${filePath}"`);

package/lib/snapshot-command.d.ts

@@ -4,6 +4,8 @@ export type SnapshotEntry = {
     plugin: string;
     flags: string[];
     alias: string[];
+    flagChars: string[];
+    flagAliases: string[];
 };
 export declare abstract class SnapshotCommand extends Command {
     get commands(): Command.Loadable[];

package/lib/snapshot-command.js

@@ -5,11 +5,10 @@ const core_1 = require("@oclif/core");
 const _ = require("lodash");
 class SnapshotCommand extends core_1.Command {
     get commands() {
-        var _a;
-        const devPlugins = (_a = this.config.pjson.oclif.devPlugins) !== null && _a !== void 0 ? _a : [];
+        const devPlugins = this.config.pjson.oclif.devPlugins ?? [];
         const commands = this.config.commands
             // Ignore dev plugins
-            .filter(command => { var _a; return !devPlugins.includes((_a = command.pluginName) !== null && _a !== void 0 ? _a : ''); })
+            .filter(command => !devPlugins.includes(command.pluginName ?? ''))
             // remove aliases that reference themselves
             .filter(command => !command.aliases.includes(command.id));
         return _.sortBy(commands, 'id');
@@ -21,6 +20,8 @@ class SnapshotCommand extends core_1.Command {
                 plugin: command.pluginName,
                 flags: Object.keys(command.flags).sort(),
                 alias: command.aliases,
+                flagChars: Object.values(command.flags).map(flag => flag.char).filter(char => char).sort(),
+                flagAliases: Object.values(command.flags).flatMap(flag => flag.aliases).filter(alias => alias).sort(),
             };
         });
     }

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "3.3.14",
+  "version": "4.0.1",
   "commands": {
     "schema:compare": {
       "id": "schema:compare",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/plugin-command-snapshot",
   "description": "generates and compares OCLIF plugins snapshot files",
-  "version": "3.3.14",
+  "version": "4.0.1",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/plugin-command-snapshot/issues",
   "dependencies": {
@@ -9,18 +9,18 @@
     "chalk": "^4.1.2",
     "just-diff": "^5.2.0",
     "lodash": "^4.17.21",
-    "semver": "^7.5.0",
+    "semver": "^7.5.1",
     "ts-json-schema-generator": "^1.2.0",
     "tslib": "^2.5.0"
   },
   "devDependencies": {
     "@commitlint/config-conventional": "^12.1.4",
     "@oclif/plugin-help": "^5.2.9",
-    "@oclif/test": "^2.3.17",
+    "@oclif/test": "^2.3.19",
     "@types/chai": "^4.3.5",
     "@types/mocha": "^8",
     "@types/node": "^15",
-    "@types/semver": "^7.3.13",
+    "@types/semver": "^7.5.0",
     "chai": "^4",
     "commitlint": "^12.1.4",
     "eslint": "^7.32.0",
@@ -29,13 +29,13 @@
     "husky": "6",
     "mocha": "^8",
     "nyc": "^15",
-    "oclif": "^3.8.2",
+    "oclif": "^3.9.0",
     "sinon": "^11.1.2",
     "ts-node": "^10",
     "typescript": "^4.9.5"
   },
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=16.0.0"
   },
   "files": [
     "/lib",

package/schemas/snapshot-compare.json

@@ -41,6 +41,27 @@
               "plugin": {
                 "type": "string"
               },
+              "chars": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "name": {
+                      "type": "string"
+                    },
+                    "removed": {
+                      "type": "boolean"
+                    },
+                    "added": {
+                      "type": "boolean"
+                    }
+                  },
+                  "required": [
+                    "name"
+                  ],
+                  "additionalProperties": false
+                }
+              },
               "flags": {
                 "type": "array",
                 "items": {
@@ -86,6 +107,7 @@
             },
             "required": [
               "alias",
+              "chars",
               "flags",
               "name",
               "plugin"

package/schemas/snapshot-generate.json

@@ -28,13 +28,27 @@
           "items": {
             "type": "string"
           }
+        },
+        "flagChars": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "flagAliases": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
         }
       },
       "required": [
         "command",
         "plugin",
         "flags",
-        "alias"
+        "alias",
+        "flagChars",
+        "flagAliases"
       ],
       "additionalProperties": false
     }