@oclif/plugin-command-snapshot 3.3.2 → 3.3.4

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

@@ -7,7 +7,7 @@ export type SchemaComparison = Array<{
 }>;
 export default class SchemaCompare extends SnapshotCommand {
     static flags: {
-        filepath: import("@oclif/core/lib/interfaces").OptionFlag<string, Record<string, unknown>>;
+        filepath: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
     };
     run(): Promise<SchemaComparison>;
     private readExistingSchema;

package/lib/commands/schema/compare.js

@@ -9,6 +9,7 @@ const core_1 = require("@oclif/core");
 const snapshot_command_1 = require("../../snapshot-command");
 const generate_1 = require("./generate");
 const chalk_1 = require("chalk");
+const util_1 = require("../../util");
 function isNumber(n) {
     return Number.isInteger(Number(n));
 }
@@ -98,7 +99,7 @@ class SchemaCompare extends snapshot_command_1.SnapshotCommand {
         else {
             for (const file of schemaFiles) {
                 const schema = JSON.parse(fs.readFileSync(file).toString('utf8'));
-                const key = path.basename(file.replace(/-/g, ':')).replace('.json', '');
+                const key = path.basename((0, util_1.getKeyNameFromFilename)(file));
                 if (file.split(path.sep).includes('hooks')) {
                     schemas.hooks[key] = schema;
                 }

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

@@ -37,7 +37,7 @@ export declare class SchemaGenerator {
 }
 export default class SchemaGenerate extends SnapshotCommand {
     static flags: {
-        filepath: import("@oclif/core/lib/interfaces").OptionFlag<string, Record<string, unknown>>;
+        filepath: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
         singlefile: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         ignorevoid: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     };

package/lib/commands/schema/generate.js

@@ -7,6 +7,7 @@ const core_1 = require("@oclif/core");
 const ts_json_schema_generator_1 = require("ts-json-schema-generator");
 const snapshot_command_1 = require("../../snapshot-command");
 const chalk_1 = require("chalk");
+const util_1 = require("../../util");
 function getAllFiles(dirPath, ext, allFiles = []) {
     let files = [];
     try {
@@ -180,7 +181,7 @@ class SchemaGenerate extends snapshot_command_1.SnapshotCommand {
         }
         else {
             for (const [cmdId, schema] of Object.entries(schemas.commands)) {
-                const fileName = `${cmdId.replace(/:/g, '-')}.json`;
+                const fileName = (0, util_1.getSchemaFileName)(cmdId);
                 const filePath = path.join(directory, fileName);
                 fs.writeFileSync(filePath, JSON.stringify(schema, null, 2));
                 this.log(`Generated JSON schema file "${filePath}"`);
@@ -190,7 +191,7 @@ class SchemaGenerate extends snapshot_command_1.SnapshotCommand {
                 const hooksDir = path.join(directory, 'hooks');
                 fs.mkdirSync(hooksDir, { recursive: true });
                 for (const [hookId, schema] of Object.entries(schemas.hooks)) {
-                    const fileName = `${hookId.replace(/:/g, '-')}.json`;
+                    const fileName = (0, util_1.getSchemaFileName)(hookId);
                     const filePath = path.join(hooksDir, fileName);
                     fs.writeFileSync(filePath, JSON.stringify(schema, null, 2));
                     this.log(`Generated JSON schema file "${filePath}"`);

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

@@ -17,7 +17,7 @@ export type CompareResponse = {
 };
 export default class Compare extends SnapshotCommand {
     static flags: {
-        filepath: import("@oclif/core/lib/interfaces").OptionFlag<string, Record<string, unknown>>;
+        filepath: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
     };
     /**
      * Compare a snapshot with the current commands

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

@@ -2,7 +2,7 @@ import { SnapshotCommand, SnapshotEntry } from '../../snapshot-command';
 export type Snapshots = SnapshotEntry[];
 export default class Generate extends SnapshotCommand {
     static flags: {
-        filepath: import("@oclif/core/lib/interfaces").OptionFlag<string, Record<string, unknown>>;
+        filepath: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
     };
     run(): Promise<Snapshots>;
 }

package/lib/util.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Get the file name for a given command ID replacing "-" with "__" and ":" with "-"
+ * @param cmdId - command ID
+ * @returns {string} - file name
+ */
+export declare const getSchemaFileName: (cmdId: string) => string;
+/**
+ * Get the command ID from a given file name replacing "-" with ":" and "__" with "-"
+ * @param file - file name
+ * @returns {string} - command ID
+ */
+export declare const getKeyNameFromFilename: (file: string) => string;

package/lib/util.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getKeyNameFromFilename = exports.getSchemaFileName = void 0;
+/**
+ * Get the file name for a given command ID replacing "-" with "__" and ":" with "-"
+ * @param cmdId - command ID
+ * @returns {string} - file name
+ */
+const getSchemaFileName = (cmdId) => {
+    const baseName = cmdId.replace(/-/g, '__').replace(/:/g, '-');
+    return `${baseName}.json`;
+};
+exports.getSchemaFileName = getSchemaFileName;
+/**
+ * Get the command ID from a given file name replacing "-" with ":" and "__" with "-"
+ * @param file - file name
+ * @returns {string} - command ID
+ */
+const getKeyNameFromFilename = (file) => {
+    return file.replace(/-/g, ':')
+        .replace(/__/g, '-')
+        .replace('.json', '');
+};
+exports.getKeyNameFromFilename = getKeyNameFromFilename;

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "3.3.2",
+  "version": "3.3.4",
   "commands": {
     "schema:compare": {
       "id": "schema:compare",

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@oclif/plugin-command-snapshot",
   "description": "generates and compares OCLIF plugins snapshot files",
-  "version": "3.3.2",
+  "version": "3.3.4",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/plugin-command-snapshot/issues",
   "dependencies": {
-    "@oclif/core": "^2.0.3",
+    "@oclif/core": "^2.0.8",
     "chalk": "^4.1.2",
     "just-diff": "^5.2.0",
     "lodash": "^4.17.21",
@@ -15,8 +15,8 @@
   },
   "devDependencies": {
     "@commitlint/config-conventional": "^12.1.4",
-    "@oclif/plugin-help": "^5.1.22",
-    "@oclif/test": "^2.3.0",
+    "@oclif/plugin-help": "^5.2.2",
+    "@oclif/test": "^2.3.4",
     "@types/chai": "^4.3.4",
     "@types/mocha": "^8",
     "@types/node": "^15",
@@ -29,10 +29,10 @@
     "husky": "6",
     "mocha": "^8",
     "nyc": "^15",
-    "oclif": "^3.6.0",
+    "oclif": "^3.6.2",
     "sinon": "^11.1.2",
     "ts-node": "^10",
-    "typescript": "^4.9.4"
+    "typescript": "^4.9.5"
   },
   "engines": {
     "node": ">=12.0.0"