@oclif/plugin-command-snapshot 3.0.0 → 3.1.0

package/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [3.1.0](https://github.com/oclif/plugin-command-snapshot/compare/v3.0.0...v3.1.0) (2021-10-08)
+
+
+### Features
+
+* generate schema for hooks ([266b832](https://github.com/oclif/plugin-command-snapshot/commit/266b83242fab1961b036998119791b999a08ee19))
+
+
+### Bug Fixes
+
+* ignore hooks with no return type ([070ed41](https://github.com/oclif/plugin-command-snapshot/commit/070ed41902268d48034fdaa2b96f9a4a54eefd2c))
+* schema:compare with hooks ([508549a](https://github.com/oclif/plugin-command-snapshot/commit/508549a372e56b3d79dec970e62477d9905dec13))
+
 ### [2.2.2](https://github.com/oclif/plugin-command-snapshot/compare/v2.2.1...v2.2.2) (2021-06-30)
 
 

package/lib/commands/schema/compare.js

@@ -20,7 +20,9 @@ class SchemaCompare extends snapshot_command_1.SnapshotCommand {
             return [];
         }
         const existingSchema = this.readExistingSchema(flags.filepath);
-        const latestSchema = await this.generateLatestSchema();
+        const latestSchema = (await this.generateLatestSchema());
+        this.debug('existingSchema', existingSchema);
+        this.debug('latestSchema', latestSchema);
         const changes = just_diff_1.diff(latestSchema, existingSchema);
         if (changes.length === 0) {
             this.log('No changes have been detected.');
@@ -44,7 +46,7 @@ class SchemaCompare extends snapshot_command_1.SnapshotCommand {
                     humandReadableChanges[commandId].push(`${chalk_1.underline(readablePath)} was ${chalk_1.cyan('added')} to latest schema`);
                     break;
                 case 'remove':
-                    humandReadableChanges[commandId].push(`${chalk_1.underline(readablePath)} was ${chalk_1.cyan('removed')} from latest schema`);
+                    humandReadableChanges[commandId].push(`${chalk_1.underline(readablePath)} was ${chalk_1.cyan('not found')} in latest schema`);
                     break;
                 default:
                     break;
@@ -68,15 +70,24 @@ class SchemaCompare extends snapshot_command_1.SnapshotCommand {
         const contents = fs.readdirSync(filePath);
         const folderIsVersioned = contents.every(c => semver.valid(c));
         const schemasDir = folderIsVersioned ? path.join(filePath, semver.rsort(contents)[0] || '') : filePath;
-        const schemaFiles = fs.readdirSync(schemasDir).map(f => path.join(schemasDir, f)).filter(f => !fs.statSync(f).isDirectory());
-        let schemas = {};
+        const schemaFiles = generate_1.getAllFiles(schemasDir, '.json');
+        let schemas = {
+            commands: {},
+            hooks: {},
+        };
         if (schemaFiles.length === 1 && schemaFiles[0].endsWith('schema.json')) {
             schemas = JSON.parse(fs.readFileSync(schemaFiles[0]).toString('utf8'));
         }
         else {
             for (const file of schemaFiles) {
                 const schema = JSON.parse(fs.readFileSync(file).toString('utf8'));
-                schemas[path.basename(file.replace(/-/g, ':')).replace('.json', '')] = schema;
+                const key = path.basename(file.replace(/-/g, ':')).replace('.json', '');
+                if (file.split(path.sep).includes('hooks')) {
+                    schemas.hooks[key] = schema;
+                }
+                else {
+                    schemas.commands[key] = schema;
+                }
             }
         }
         return schemas;

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

@@ -3,17 +3,37 @@ import { SnapshotCommand } from '../../snapshot-command';
 export declare type SchemasMap = {
     [key: string]: Schema;
 };
+export declare type Schemas = {
+    commands: SchemasMap;
+    hooks: SchemasMap;
+};
 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 classToId;
     constructor(base: SnapshotCommand, ignorevoid?: boolean);
-    generate(): Promise<SchemasMap>;
+    generate(): Promise<Schemas>;
+    private generateSchema;
     private getAllCmdFiles;
-    private parseFile;
+    private getAllHookFiles;
+    /**
+     * Use regex to find the typescript type being returned by the command's
+     * `run` method.
+     * @param file the file to parse
+     * @returns Returns the name of the return type and the command id.
+     */
+    private parseCmdFile;
+    /**
+     * Use regex to find the typescript type being returned by the hook
+     * @param file the file to parse
+     * @returns Returns the name of the return type and the hook id.
+     */
+    private parseHookFile;
     private validateReturnType;
     private determineCommandId;
+    private getDirs;
 }
 export default class SchemaGenerate extends SnapshotCommand {
     static flags: {

package/lib/commands/schema/generate.js

@@ -1,12 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SchemaGenerator = void 0;
+exports.SchemaGenerator = exports.getAllFiles = void 0;
 const path = require("path");
 const fs = require("fs");
 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");
+function getAllFiles(dirPath, ext, allFiles = []) {
+    let files = [];
+    try {
+        files = fs.readdirSync(dirPath);
+    }
+    catch (_a) { }
+    files.forEach(file => {
+        const fPath = path.join(dirPath, file);
+        if (fs.statSync(fPath).isDirectory()) {
+            allFiles = getAllFiles(fPath, ext, allFiles);
+        }
+        else if (file.endsWith(ext)) {
+            allFiles.push(fPath);
+        }
+    });
+    return allFiles;
+}
+exports.getAllFiles = getAllFiles;
 class SchemaGenerator {
     constructor(base, ignorevoid = true) {
         this.base = base;
@@ -19,45 +37,59 @@ class SchemaGenerator {
             const loadedCmd = await cmd.load(); // commands are loaded async in oclif/core
             this.classToId[loadedCmd.name] = loadedCmd.id;
         }
-        const schemas = {};
+        const cmdSchemas = {};
         for (const file of this.getAllCmdFiles()) {
-            const { returnType, commandId } = this.parseFile(file);
+            const { returnType, commandId } = this.parseCmdFile(file);
             if (this.ignorevoid && returnType === 'void')
                 continue;
-            try {
-                const config = {
-                    path: file,
-                    type: returnType,
-                    skipTypeCheck: true,
-                };
-                const schema = ts_json_schema_generator_1.createGenerator(config).createSchema(config.type);
-                schemas[commandId] = schema;
-            }
-            catch (error) {
-                if (error.message.toLowerCase().includes('no root type')) {
-                    throw new Error(`Schema generator could not find the ${chalk_1.red(returnType)} type. Please make sure that ${chalk_1.red(returnType)} is exported.`);
-                }
-                else {
-                    throw error;
-                }
+            cmdSchemas[commandId] = this.generateSchema(returnType, file);
+        }
+        const hookSchemas = {};
+        for (const file of this.getAllHookFiles()) {
+            const { returnType, hookId } = this.parseHookFile(file);
+            if (returnType && hookId) {
+                hookSchemas[hookId] = this.generateSchema(returnType, file);
             }
         }
-        return schemas;
+        return { commands: cmdSchemas, hooks: hookSchemas };
     }
-    getAllCmdFiles(dirPath = path.join(this.base.config.root, 'src', 'commands'), allFiles = []) {
-        const files = fs.readdirSync(dirPath);
-        files.forEach(file => {
-            const fPath = path.join(dirPath, file);
-            if (fs.statSync(fPath).isDirectory()) {
-                allFiles = this.getAllCmdFiles(fPath, allFiles);
+    generateSchema(returnType, file) {
+        try {
+            const config = {
+                path: file,
+                type: returnType,
+                skipTypeCheck: true,
+            };
+            return 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 ${chalk_1.red(returnType)} type. Please make sure that ${chalk_1.red(returnType)} is exported.`);
             }
-            else if (file.endsWith('ts')) {
-                allFiles.push(fPath);
+            else {
+                throw error;
             }
-        });
-        return allFiles;
+        }
+    }
+    getAllCmdFiles() {
+        const { rootDir } = this.getDirs();
+        return getAllFiles(path.join(rootDir, 'commands'), '.ts');
+    }
+    getAllHookFiles() {
+        var _a, _b;
+        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]);
+        }, []);
+        const { rootDir, outDir } = this.getDirs();
+        return hookFiles.map(h => `${path.resolve(h)}.ts`.replace(outDir, rootDir));
     }
-    parseFile(file) {
+    /**
+     * Use regex to find the typescript type being returned by the command's
+     * `run` method.
+     * @param file the file to parse
+     * @returns Returns the name of the return type and the command id.
+     */
+    parseCmdFile(file) {
         const returnTypeRegex = /(?<=async\srun\(\):\sPromise<)(.*?)(>*)(?=>)/g;
         const contents = fs.readFileSync(file, 'utf8');
         const [returnType] = returnTypeRegex.exec(contents) || [];
@@ -71,6 +103,32 @@ class SchemaGenerator {
         this.validateReturnType(returnType, commandId);
         return { returnType, commandId };
     }
+    /**
+     * Use regex to find the typescript type being returned by the hook
+     * @param file the file to parse
+     * @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) {
+            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 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]);
+            const currentFileName = path.basename(file).split('.')[0];
+            return hookFileNames.includes(currentFileName);
+        });
+        if (!hookId) {
+            return { returnType: null, hookId: null };
+        }
+        this.validateReturnType(returnType, hookId);
+        return { returnType, hookId };
+    }
     validateReturnType(returnType, commandId) {
         const notAllowed = this.ignorevoid ? ['any', 'unknown'] : ['any', 'unknown', 'void'];
         const vaugeTypes = ['JsonMap', 'JsonCollection', 'AnyJson'];
@@ -89,6 +147,24 @@ class SchemaGenerator {
             }
         }
     }
+    getDirs() {
+        const dirs = {
+            rootDir: path.join(this.base.config.root, 'src'),
+            outDir: path.join(this.base.config.root, 'lib'),
+        };
+        try {
+            const tsConfig = JSON.parse(fs.readFileSync(path.join(this.base.config.root, 'tsconfig.json'), 'utf-8'));
+            if (tsConfig.compilerOptions.rootDir) {
+                dirs.rootDir = path.join(this.base.config.root, tsConfig.compilerOptions.rootDir);
+            }
+            if (tsConfig.compilerOptions.outDir) {
+                dirs.outDir = path.join(this.base.config.root, tsConfig.compilerOptions.outDir);
+            }
+            return dirs;
+        }
+        catch (_a) { }
+        return dirs;
+    }
 }
 exports.SchemaGenerator = SchemaGenerator;
 class SchemaGenerate extends snapshot_command_1.SnapshotCommand {
@@ -106,13 +182,24 @@ class SchemaGenerate extends snapshot_command_1.SnapshotCommand {
             files.push(filePath);
         }
         else {
-            for (const [cmdId, schema] of Object.entries(schemas)) {
+            for (const [cmdId, schema] of Object.entries(schemas.commands)) {
                 const fileName = `${cmdId.replace(/:/g, '-')}.json`;
                 const filePath = path.join(directory, fileName);
                 fs.writeFileSync(filePath, JSON.stringify(schema, null, 2));
                 this.log(`Generated JSON schema file "${filePath}"`);
                 files.push(filePath);
             }
+            if (Object.values(schemas.hooks).length > 0) {
+                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 filePath = path.join(hooksDir, fileName);
+                    fs.writeFileSync(filePath, JSON.stringify(schema, null, 2));
+                    this.log(`Generated JSON schema file "${filePath}"`);
+                    files.push(filePath);
+                }
+            }
         }
         return files;
     }

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"3.0.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":[]}}}
+{"version":"3.1.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,11 +1,11 @@
 {
   "name": "@oclif/plugin-command-snapshot",
   "description": "generates and compares OCLIF plugins snapshot files",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "author": "Ramyasri @nramyasri-sf",
   "bugs": "https://github.com/oclif/plugin-command-snapshot/issues",
   "dependencies": {
-    "@oclif/core": "^0.5.39",
+    "@oclif/core": "^1.0.1",
     "chalk": "^4.1.1",
     "just-diff": "^3.1.1",
     "semver": "^7.3.5",

package/yarn.lock

@@ -460,6 +460,29 @@
     widest-line "^3.1.0"
     wrap-ansi "^7.0.0"
 
+"@oclif/core@^1.0.1":
+  version "1.0.1"
+  resolved "https://registry.npmjs.org/@oclif/core/-/core-1.0.1.tgz#e97fc5c234db1a745fb4468eb79cabeea5f84af9"
+  integrity sha512-ai9XwnEZ+P34VUtV+fX/6HmRbo5CXGdZjX3iK3PsY6O+KYeJBKVAkPCKLz0qtAHxx0HX4+Yj2wnmy+hTCx6HYQ==
+  dependencies:
+    "@oclif/linewrap" "^1.0.0"
+    chalk "^4.1.0"
+    clean-stack "^3.0.0"
+    cli-ux "^5.1.0"
+    debug "^4.1.1"
+    fs-extra "^9.0.1"
+    get-package-type "^0.1.0"
+    globby "^11.0.1"
+    indent-string "^4.0.0"
+    is-wsl "^2.1.1"
+    lodash.template "^4.4.0"
+    semver "^7.3.2"
+    string-width "^4.2.0"
+    strip-ansi "^6.0.0"
+    tslib "^2.0.0"
+    widest-line "^3.1.0"
+    wrap-ansi "^7.0.0"
+
 "@oclif/errors@^1.2.1", "@oclif/errors@^1.2.2", "@oclif/errors@^1.3.3":
   version "1.3.4"
   resolved "https://registry.npmjs.org/@oclif/errors/-/errors-1.3.4.tgz#a96f94536b4e25caa72eff47e8b3ed04f6995f55"