@oclif/plugin-command-snapshot 3.1.3 → 3.2.0

package/lib/commands/schema/compare.js

@@ -3,12 +3,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const path = require("path");
 const fs = require("fs");
 const semver = require("semver");
-const _ = require("lodash");
+const lodash_1 = require("lodash");
 const just_diff_1 = require("just-diff");
 const core_1 = require("@oclif/core");
 const snapshot_command_1 = require("../../snapshot-command");
 const generate_1 = require("./generate");
 const chalk_1 = require("chalk");
+function isNumber(n) {
+    return Number.isInteger(Number(n));
+}
+function isMeaningless(n) {
+    const meaninglessKeys = ['$comment', '__computed'];
+    return meaninglessKeys.includes(n);
+}
 class SchemaCompare extends snapshot_command_1.SnapshotCommand {
     async run() {
         const { flags } = await this.parse(SchemaCompare);
@@ -28,25 +35,34 @@ class SchemaCompare extends snapshot_command_1.SnapshotCommand {
             this.log('No changes have been detected.');
             return [];
         }
-        const humandReadableChanges = {};
+        const humanReadableChanges = {};
         for (const change of changes) {
+            const lastPathElement = change.path[change.path.length - 1];
+            if (isMeaningless(lastPathElement))
+                continue;
             const objPath = change.path.join('.');
-            const existing = _.get(existingSchema, objPath);
-            const latest = _.get(latestSchema, objPath);
+            const existing = (0, lodash_1.get)(existingSchema, objPath);
+            const latest = (0, lodash_1.get)(latestSchema, objPath);
             const [commandId] = objPath.split('.definitions');
             const readablePath = objPath.replace(`${commandId}.`, '');
-            if (!humandReadableChanges[commandId]) {
-                humandReadableChanges[commandId] = [];
+            if (!humanReadableChanges[commandId]) {
+                humanReadableChanges[commandId] = [];
             }
+            const lastElementIsNum = isNumber(lastPathElement);
+            const basePath = lastElementIsNum ? readablePath.replace(`.${lastPathElement}`, '') : readablePath;
             switch (change.op) {
                 case 'replace':
-                    humandReadableChanges[commandId].push(`${(0, chalk_1.underline)(readablePath)} was changed from ${(0, chalk_1.cyan)(existing)} to ${(0, chalk_1.cyan)(latest)}`);
+                    humanReadableChanges[commandId].push(`${(0, chalk_1.underline)(readablePath)} was changed from ${(0, chalk_1.cyan)(existing)} to ${(0, chalk_1.cyan)(latest)}`);
                     break;
                 case 'add':
-                    humandReadableChanges[commandId].push(`${(0, chalk_1.underline)(readablePath)} was ${(0, chalk_1.cyan)('added')} to latest schema`);
+                    humanReadableChanges[commandId].push(lastElementIsNum ?
+                        `Array item at ${(0, chalk_1.underline)(basePath)} was ${(0, chalk_1.cyan)('added')} to latest schema` :
+                        `${(0, chalk_1.underline)(readablePath)} was ${(0, chalk_1.cyan)('added')} to latest schema`);
                     break;
                 case 'remove':
-                    humandReadableChanges[commandId].push(`${(0, chalk_1.underline)(readablePath)} was ${(0, chalk_1.cyan)('not found')} in latest schema`);
+                    humanReadableChanges[commandId].push(lastElementIsNum ?
+                        `Array item at ${(0, chalk_1.underline)(basePath)} was ${(0, chalk_1.cyan)('not found')} in latest schema` :
+                        `${(0, chalk_1.underline)(readablePath)} was ${(0, chalk_1.cyan)('not found')} in latest schema`);
                     break;
                 default:
                     break;
@@ -54,7 +70,7 @@ class SchemaCompare extends snapshot_command_1.SnapshotCommand {
         }
         this.log();
         this.log((0, chalk_1.bold)((0, chalk_1.red)('Found the following schema changes:')));
-        for (const [commandId, changes] of Object.entries(humandReadableChanges)) {
+        for (const [commandId, changes] of Object.entries(humanReadableChanges)) {
             this.log();
             this.log((0, chalk_1.bold)(commandId));
             for (const change of changes) {
@@ -62,7 +78,8 @@ class SchemaCompare extends snapshot_command_1.SnapshotCommand {
             }
         }
         this.log();
-        this.log('If intended, please update the schema file(s) and run again.');
+        const bin = process.platform === 'win32' ? 'bin\\dev.cmd' : 'bin/dev';
+        this.log('If intended, please update the schema file(s) and run again:', (0, chalk_1.bold)(`${bin} ${(0, core_1.toConfiguredId)('schema:generate', this.config)}`));
         process.exitCode = 1;
         return changes;
     }

package/lib/commands/schema/generate.d.ts

@@ -11,9 +11,9 @@ export declare type GenerateResponse = string[];
 export declare function getAllFiles(dirPath: string, ext: string, allFiles?: string[]): string[];
 export declare class SchemaGenerator {
     private base;
-    private ignorevoid;
+    private ignoreVoid;
     private classToId;
-    constructor(base: SnapshotCommand, ignorevoid?: boolean);
+    constructor(base: SnapshotCommand, ignoreVoid?: boolean);
     generate(): Promise<Schemas>;
     private generateSchema;
     private getAllCmdFiles;

package/lib/commands/schema/generate.js

@@ -13,7 +13,7 @@ function getAllFiles(dirPath, ext, allFiles = []) {
         files = fs.readdirSync(dirPath);
     }
     catch (_a) { }
-    files.forEach(file => {
+    for (const file of files) {
         const fPath = path.join(dirPath, file);
         if (fs.statSync(fPath).isDirectory()) {
             allFiles = getAllFiles(fPath, ext, allFiles);
@@ -21,14 +21,14 @@ function getAllFiles(dirPath, ext, allFiles = []) {
         else if (file.endsWith(ext)) {
             allFiles.push(fPath);
         }
-    });
+    }
     return allFiles;
 }
 exports.getAllFiles = getAllFiles;
 class SchemaGenerator {
-    constructor(base, ignorevoid = true) {
+    constructor(base, ignoreVoid = true) {
         this.base = base;
-        this.ignorevoid = ignorevoid;
+        this.ignoreVoid = ignoreVoid;
         this.classToId = {};
     }
     async generate() {
@@ -40,7 +40,7 @@ class SchemaGenerator {
         const cmdSchemas = {};
         for (const file of this.getAllCmdFiles()) {
             const { returnType, commandId } = this.parseCmdFile(file);
-            if (this.ignorevoid && returnType === 'void')
+            if (this.ignoreVoid && returnType === 'void')
                 continue;
             cmdSchemas[commandId] = this.generateSchema(returnType, file);
         }
@@ -63,12 +63,8 @@ class SchemaGenerator {
             return (0, ts_json_schema_generator_1.createGenerator)(config).createSchema(config.type);
         }
         catch (error) {
-            if (error.message.toLowerCase().includes('no root type')) {
-                throw new Error(`Schema generator could not find the ${(0, chalk_1.red)(returnType)} type. Please make sure that ${(0, chalk_1.red)(returnType)} is exported.`);
-            }
-            else {
-                throw error;
-            }
+            const error_ = error.message.toLowerCase().includes('no root type') ? new Error(`Schema generator could not find the ${(0, chalk_1.red)(returnType)} type. Please make sure that ${(0, chalk_1.red)(returnType)} is exported.`) : error;
+            throw error_;
         }
     }
     getAllCmdFiles() {
@@ -77,8 +73,9 @@ class SchemaGenerator {
     }
     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) => {
-            return Array.isArray(y) ? x.concat(y) : x.concat([y]);
+            return Array.isArray(y) ? [...x, ...y] : [...x, y];
         }, []);
         const { rootDir, outDir } = this.getDirs();
         return hookFiles.map(h => `${path.resolve(h)}.ts`.replace(outDir, rootDir));
@@ -130,13 +127,13 @@ class SchemaGenerator {
         return { returnType, hookId };
     }
     validateReturnType(returnType, commandId) {
-        const notAllowed = this.ignorevoid ? ['any', 'unknown'] : ['any', 'unknown', 'void'];
-        const vaugeTypes = ['JsonMap', 'JsonCollection', 'AnyJson'];
+        const notAllowed = this.ignoreVoid ? ['any', 'unknown'] : ['any', 'unknown', 'void'];
+        const vagueTypes = ['JsonMap', 'JsonCollection', 'AnyJson'];
         if (notAllowed.includes(returnType)) {
             throw new Error(`${returnType} (from ${commandId}) is not allowed. Please use a more specific type.`);
         }
-        else if (vaugeTypes.includes(returnType)) {
-            throw new Error(`${returnType} (from ${commandId}) is too vauge. Please use a more specific type.`);
+        else if (vagueTypes.includes(returnType)) {
+            throw new Error(`${returnType} (from ${commandId}) is too vague. Please use a more specific type.`);
         }
     }
     determineCommandId(contents) {

package/lib/commands/snapshot/compare.js

@@ -16,7 +16,7 @@ class Compare extends snapshot_command_1.SnapshotCommand {
     async compareSnapshot(initialCommands, updatedCommands) {
         const removedCommands = [];
         const diffCommands = [];
-        initialCommands.forEach(initialCommand => {
+        for (const initialCommand of initialCommands) {
             const updatedCommand = updatedCommands.find(updatedCommand => {
                 // Protect against old snapshot files that don't have the plugin entry filled out.
                 const samePlugin = initialCommand.plugin ? initialCommand.plugin === updatedCommand.plugin : true;
@@ -40,7 +40,7 @@ class Compare extends snapshot_command_1.SnapshotCommand {
             else {
                 removedCommands.push(initialCommand.command);
             }
-        });
+        }
         const initialCommandNames = initialCommands.map(initialCommand => initialCommand.command);
         const updatedCommandNames = updatedCommands.map(updatedCommand => updatedCommand.name);
         const addedCommands = _.difference(updatedCommandNames, initialCommandNames);
@@ -51,30 +51,30 @@ class Compare extends snapshot_command_1.SnapshotCommand {
         // Fail the process since there are changes to the snapshot file
         process.exitCode = 1;
         this.log(`The following commands and flags have modified: (${chalk.green('+')} added, ${chalk.red('-')} removed)${os_1.EOL}`);
-        removedCommands.forEach(command => {
+        for (const command of removedCommands) {
             this.log(chalk.red(`\t-${command}`));
-        });
-        addedCommands.forEach(command => {
+        }
+        for (const command of addedCommands) {
             this.log(chalk.green(`\t+${command}`));
-        });
+        }
         const removedProperties = [];
-        diffCommands.forEach(command => {
+        const printCommandDiff = (properties, propertyName) => {
+            if (properties.some(prop => prop.added || prop.removed))
+                this.log(`\t  ${propertyName}:`);
+            for (const prop of properties) {
+                if (prop.added || prop.removed) {
+                    const color = prop.added ? chalk.green : chalk.red;
+                    this.log(color(`\t\t${prop.added ? '+' : '-'}${prop.name}`));
+                }
+                if (prop.removed)
+                    removedProperties.push();
+            }
+        };
+        for (const command of diffCommands) {
             this.log(`\t${command.name}`);
-            const printCommandDiff = (properties, propertyName) => {
-                if (properties.find(prop => prop.added || prop.removed))
-                    this.log(`\t  ${propertyName}:`);
-                properties.forEach(prop => {
-                    if (prop.added || prop.removed) {
-                        const color = prop.added ? chalk.green : chalk.red;
-                        this.log(color(`\t\t${prop.added ? '+' : '-'}${prop.name}`));
-                    }
-                    if (prop.removed)
-                        removedProperties.push();
-                });
-            };
             printCommandDiff(command.flags, '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.`);
         // Check if existent commands, or properties (flags, aliases) have been deleted
         if (removedCommands.length > 0 || removedProperties.length > 0) {
@@ -104,18 +104,18 @@ class Compare extends snapshot_command_1.SnapshotCommand {
         const addedProperty = _.difference(updatedPropertyNames, initial);
         const removedProperty = _.difference(initial, updatedPropertyNames);
         const changedProperty = [];
-        updated.forEach(update => {
+        for (const update of updated) {
             if (addedProperty.includes(update.name)) {
                 update.added = true;
                 changedProperty.push(update);
             }
-        });
-        removedProperty.forEach(remove => {
+        }
+        for (const remove of removedProperty) {
             changedProperty.push({ name: remove, removed: true });
             // The removed flags in not included in the updated flags, but we want it to
             // so it shows removed.
             updated.push({ name: remove, removed: true });
-        });
+        }
         return { addedProperty, removedProperty, updated, changedProperty };
     }
     get changed() {

package/lib/snapshot-command.d.ts

@@ -1,4 +1,4 @@
-import { Command } from '@oclif/core';
+import { Command, Interfaces } from '@oclif/core';
 export declare type SnapshotEntry = {
     command: string;
     plugin: string;
@@ -6,6 +6,6 @@ export declare type SnapshotEntry = {
     alias: string[];
 };
 export declare abstract class SnapshotCommand extends Command {
-    get commands(): import("@oclif/core/lib/interfaces").Command.Plugin[];
+    get commands(): Interfaces.Command.Loadable[];
     get entries(): SnapshotEntry[];
 }

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"3.1.3","commands":{"schema:compare":{"id":"schema:compare","strict":true,"pluginName":"@oclif/plugin-command-snapshot","pluginAlias":"@oclif/plugin-command-snapshot","pluginType":"core","aliases":[],"flags":{"filepath":{"name":"filepath","type":"option","description":"path of the generated snapshot file","multiple":false,"default":"./schemas"}},"args":[]},"schema:generate":{"id":"schema:generate","strict":true,"pluginName":"@oclif/plugin-command-snapshot","pluginAlias":"@oclif/plugin-command-snapshot","pluginType":"core","aliases":[],"flags":{"filepath":{"name":"filepath","type":"option","description":"directory to save the generated schema files; can use \"{version}\" to insert the current CLI/plugin version","multiple":false,"default":"./schemas"},"singlefile":{"name":"singlefile","type":"boolean","description":"put generated schema into a single file","allowNo":false},"ignorevoid":{"name":"ignorevoid","type":"boolean","description":"ignore commands that return void","allowNo":false}},"args":[]},"snapshot:compare":{"id":"snapshot:compare","strict":true,"pluginName":"@oclif/plugin-command-snapshot","pluginAlias":"@oclif/plugin-command-snapshot","pluginType":"core","aliases":[],"flags":{"filepath":{"name":"filepath","type":"option","description":"path of the generated snapshot file","multiple":false,"default":"./command-snapshot.json"}},"args":[]},"snapshot:generate":{"id":"snapshot:generate","strict":true,"pluginName":"@oclif/plugin-command-snapshot","pluginAlias":"@oclif/plugin-command-snapshot","pluginType":"core","aliases":[],"flags":{"filepath":{"name":"filepath","type":"option","description":"path to save the generated snapshot file; can use \"{version}\" to replace the current CLI/plugin version","multiple":false,"default":"./command-snapshot.json"}},"args":[]}}}
+{"version":"3.2.0","commands":{"schema:compare":{"id":"schema:compare","strict":true,"pluginName":"@oclif/plugin-command-snapshot","pluginAlias":"@oclif/plugin-command-snapshot","pluginType":"core","aliases":[],"flags":{"filepath":{"name":"filepath","type":"option","description":"path of the generated snapshot file","multiple":false,"default":"./schemas"}},"args":[]},"schema:generate":{"id":"schema:generate","strict":true,"pluginName":"@oclif/plugin-command-snapshot","pluginAlias":"@oclif/plugin-command-snapshot","pluginType":"core","aliases":[],"flags":{"filepath":{"name":"filepath","type":"option","description":"directory to save the generated schema files; can use \"{version}\" to insert the current CLI/plugin version","multiple":false,"default":"./schemas"},"singlefile":{"name":"singlefile","type":"boolean","description":"put generated schema into a single file","allowNo":false},"ignorevoid":{"name":"ignorevoid","type":"boolean","description":"ignore commands that return void","allowNo":false}},"args":[]},"snapshot:compare":{"id":"snapshot:compare","strict":true,"pluginName":"@oclif/plugin-command-snapshot","pluginAlias":"@oclif/plugin-command-snapshot","pluginType":"core","aliases":[],"flags":{"filepath":{"name":"filepath","type":"option","description":"path of the generated snapshot file","multiple":false,"default":"./command-snapshot.json"}},"args":[]},"snapshot:generate":{"id":"snapshot:generate","strict":true,"pluginName":"@oclif/plugin-command-snapshot","pluginAlias":"@oclif/plugin-command-snapshot","pluginType":"core","aliases":[],"flags":{"filepath":{"name":"filepath","type":"option","description":"path to save the generated snapshot file; can use \"{version}\" to replace the current CLI/plugin version","multiple":false,"default":"./command-snapshot.json"}},"args":[]}}}

package/package.json

@@ -1,38 +1,38 @@
 {
   "name": "@oclif/plugin-command-snapshot",
   "description": "generates and compares OCLIF plugins snapshot files",
-  "version": "3.1.3",
+  "version": "3.2.0",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/plugin-command-snapshot/issues",
   "dependencies": {
-    "@oclif/core": "^1.3.4",
+    "@oclif/core": "^1.16.4",
     "chalk": "^4.1.2",
-    "just-diff": "^3.1.1",
-    "semver": "^7.3.5",
-    "sinon": "^11.1.2",
-    "ts-json-schema-generator": "^0.97.0",
-    "tslib": "^2"
+    "just-diff": "^5.1.1",
+    "lodash": "^4.17.21",
+    "semver": "^7.3.7",
+    "ts-json-schema-generator": "^1.1.0",
+    "tslib": "^2.4.0"
   },
   "devDependencies": {
     "@commitlint/config-conventional": "^12.1.4",
-    "@oclif/plugin-help": "^5.1.11",
-    "@oclif/test": "^2.1.0",
-    "@types/chai": "^4",
+    "@oclif/plugin-help": "^5.1.12",
+    "@oclif/test": "^2.1.1",
+    "@types/chai": "^4.3.3",
     "@types/mocha": "^8",
     "@types/node": "^15",
     "@types/semver": "^7.3.9",
     "chai": "^4",
     "commitlint": "^12.1.4",
-    "eslint": "^7",
-    "eslint-config-oclif": "^3.1",
-    "eslint-config-oclif-typescript": "^0.2",
-    "globby": "^11",
+    "eslint": "^7.32.0",
+    "eslint-config-oclif": "^4",
+    "eslint-config-oclif-typescript": "^1.0.2",
     "husky": "6",
     "mocha": "^8",
     "nyc": "^15",
-    "oclif": "^2.4.4",
-    "ts-node": "^9",
-    "typescript": "^4.5.5"
+    "oclif": "^2.6.3",
+    "sinon": "^11.1.2",
+    "ts-node": "^10",
+    "typescript": "^4.8.3"
   },
   "engines": {
     "node": ">=12.0.0"
@@ -74,4 +74,4 @@
     "test": "nyc --extension .ts mocha --forbid-only \"test/**/*.test.ts\" --timeout 20000",
     "version": "oclif readme && git add README.md"
   }
-}
+}