@oclif/plugin-command-snapshot 5.0.9 → 5.1.0

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

@@ -10,6 +10,5 @@ export default class SchemaCompare extends SnapshotCommand {
         filepath: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
     };
     run(): Promise<SchemaComparison>;
-    private generateLatestSchema;
     private readExistingSchema;
 }

package/lib/commands/schema/compare.js

@@ -6,8 +6,8 @@ import * as fs from 'node:fs';
 import * as path from 'node:path';
 import * as semver from 'semver';
 import SnapshotCommand from '../../snapshot-command.js';
-import { getKeyNameFromFilename } from '../../util.js';
-import { SchemaGenerator, getAllFiles } from './generate.js';
+import { GLOB_PATTERNS, getAllFiles, getKeyNameFromFilename } from '../../util.js';
+import { SchemaGenerator } from './generate.js';
 function isNumber(n) {
     return Number.isInteger(Number(n));
 }
@@ -25,6 +25,19 @@ export default class SchemaCompare extends SnapshotCommand {
         }),
     };
     async run() {
+        const strategy = typeof this.config.pjson.oclif?.commands === 'string' ? 'pattern' : this.config.pjson.oclif?.commands?.strategy;
+        const commandsDir = typeof this.config.pjson.oclif?.commands === 'string'
+            ? this.config.pjson.oclif?.commands
+            : this.config.pjson.oclif?.commands?.target;
+        const commandGlobs = typeof this.config.pjson.oclif?.commands === 'string'
+            ? GLOB_PATTERNS
+            : this.config.pjson.oclif?.commands?.globPatterns;
+        if (strategy === 'single') {
+            this.error('This command is not supported for single command CLIs');
+        }
+        if (strategy === 'explicit') {
+            this.error('This command is not supported for explicit command discovery');
+        }
         const { flags } = await this.parse(SchemaCompare);
         try {
             fs.accessSync(flags.filepath);
@@ -34,7 +47,8 @@ export default class SchemaCompare extends SnapshotCommand {
             return [];
         }
         const existingSchema = this.readExistingSchema(flags.filepath);
-        const latestSchema = await this.generateLatestSchema();
+        const generator = new SchemaGenerator({ base: this, commandGlobs, commandsDir });
+        const latestSchema = await generator.generate();
         this.debug('existingSchema', existingSchema);
         this.debug('latestSchema', latestSchema);
         const changes = diff(latestSchema, existingSchema);
@@ -89,15 +103,11 @@ export default class SchemaCompare extends SnapshotCommand {
             }
         }
         this.log();
-        const bin = process.platform === 'win32' ? 'bin\\dev.cmd' : 'bin/dev';
+        const bin = process.platform === 'win32' ? 'bin\\dev.cmd' : 'bin/dev.js';
         this.log('If intended, please update the schema file(s) and run again:', chalk.bold(`${bin} ${toConfiguredId('schema:generate', this.config)}`));
         process.exitCode = 1;
         return changes;
     }
-    async generateLatestSchema() {
-        const generator = new SchemaGenerator(this);
-        return generator.generate();
-    }
     readExistingSchema(filePath) {
         const contents = fs.readdirSync(filePath);
         const folderIsVersioned = contents.every((c) => semver.valid(c));

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

@@ -8,12 +8,19 @@ export type Schemas = {
     hooks: SchemasMap;
 };
 export type GenerateResponse = string[];
-export declare function getAllFiles(dirPath: string, ext: string, allFiles?: string[]): string[];
+type SchemaGenerateOptions = {
+    base: SnapshotCommand;
+    commandGlobs?: string[];
+    commandsDir?: string;
+    ignoreVoid?: boolean;
+};
 export declare class SchemaGenerator {
     private base;
-    private ignoreVoid;
     private classToId;
-    constructor(base: SnapshotCommand, ignoreVoid?: boolean);
+    private commandGlobs;
+    private commandsDir;
+    private ignoreVoid;
+    constructor(options: SchemaGenerateOptions);
     generate(): Promise<Schemas>;
     private determineCommandId;
     private generateSchema;
@@ -43,3 +50,4 @@ export default class SchemaGenerate extends SnapshotCommand {
     };
     run(): Promise<GenerateResponse>;
 }
+export {};

package/lib/commands/schema/generate.js

@@ -1,35 +1,22 @@
 import { Flags } from '@oclif/core';
 import chalk from 'chalk';
+import { globbySync } from 'globby';
 import * as fs from 'node:fs';
 import * as path from 'node:path';
 import { createGenerator } from 'ts-json-schema-generator';
 import SnapshotCommand from '../../snapshot-command.js';
-import { getSchemaFileName } from '../../util.js';
-export function getAllFiles(dirPath, ext, allFiles = []) {
-    let files = [];
-    try {
-        files = fs.readdirSync(dirPath);
-    }
-    catch { }
-    for (const file of files) {
-        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;
-}
+import { GLOB_PATTERNS, getAllFiles, getSchemaFileName } from '../../util.js';
 export class SchemaGenerator {
     base;
-    ignoreVoid;
     classToId = {};
-    // eslint-disable-next-line no-useless-constructor
-    constructor(base, ignoreVoid = true) {
-        this.base = base;
-        this.ignoreVoid = ignoreVoid;
+    commandGlobs;
+    commandsDir;
+    ignoreVoid;
+    constructor(options) {
+        this.base = options.base;
+        this.ignoreVoid = options.ignoreVoid ?? true;
+        this.commandsDir = options.commandsDir;
+        this.commandGlobs = options.commandGlobs ?? GLOB_PATTERNS;
     }
     async generate() {
         for (const cmd of this.base.commands) {
@@ -81,7 +68,11 @@ export class SchemaGenerator {
         }
     }
     getAllCmdFiles() {
-        const { rootDir } = this.getDirs();
+        const { outDir, rootDir } = this.getDirs();
+        if (this.commandsDir) {
+            const commandsSrcDir = path.resolve(this.base.config.root, this.commandsDir).replace(outDir, rootDir);
+            return globbySync(this.commandGlobs, { absolute: true, cwd: commandsSrcDir });
+        }
         return getAllFiles(path.join(rootDir, 'commands'), '.ts');
     }
     getAllHookFiles() {
@@ -180,8 +171,21 @@ export default class SchemaGenerate extends SnapshotCommand {
         }),
     };
     async run() {
+        const strategy = typeof this.config.pjson.oclif?.commands === 'string' ? 'pattern' : this.config.pjson.oclif?.commands?.strategy;
+        const commandsDir = typeof this.config.pjson.oclif?.commands === 'string'
+            ? this.config.pjson.oclif?.commands
+            : this.config.pjson.oclif?.commands?.target;
+        const commandGlobs = typeof this.config.pjson.oclif?.commands === 'string'
+            ? GLOB_PATTERNS
+            : this.config.pjson.oclif?.commands?.globPatterns;
+        if (strategy === 'single') {
+            this.error('This command is not supported for single command CLIs');
+        }
+        if (strategy === 'explicit') {
+            this.error('This command is not supported for explicit command discovery');
+        }
         const { flags } = await this.parse(SchemaGenerate);
-        const generator = new SchemaGenerator(this, flags.ignorevoid);
+        const generator = new SchemaGenerator({ base: this, commandGlobs, commandsDir, ignoreVoid: flags.ignorevoid });
         const schemas = await generator.generate();
         const directory = flags.filepath.replace('{version}', this.config.version);
         fs.mkdirSync(directory, { recursive: true });

package/lib/util.d.ts

@@ -10,3 +10,5 @@ export declare const getSchemaFileName: (cmdId: string) => string;
  * @returns {string} - command ID
  */
 export declare const getKeyNameFromFilename: (file: string) => string;
+export declare const getAllFiles: (dirPath: string, ext: string, allFiles?: string[]) => string[];
+export declare const GLOB_PATTERNS: string[];

package/lib/util.js

@@ -1,3 +1,5 @@
+import fs from 'node:fs';
+import path from 'node:path';
 /**
  * Get the file name for a given command ID replacing "-" with "__" and ":" with "-"
  * @param cmdId - command ID
@@ -13,3 +15,19 @@ export const getSchemaFileName = (cmdId) => {
  * @returns {string} - command ID
  */
 export const getKeyNameFromFilename = (file) => file.replaceAll('-', ':').replaceAll('__', '-').replace('.json', '');
+export const getAllFiles = (dirPath, ext, allFiles = []) => safeReadDirSync(dirPath)
+    .flatMap((f) => f.isDirectory() ? getAllFiles(path.join(dirPath, f.name), ext, allFiles) : path.join(dirPath, f.name))
+    .filter((f) => f.endsWith(ext));
+const safeReadDirSync = (dirPath) => {
+    try {
+        // TODO: use recursive option when available in Node 20
+        return fs.readdirSync(dirPath, { withFileTypes: true });
+    }
+    catch {
+        return [];
+    }
+};
+export const GLOB_PATTERNS = [
+    '**/*.+(js|cjs|mjs|ts|tsx|mts|cts)',
+    '!**/*.+(d.ts|test.ts|test.js|spec.ts|spec.js|d.mts|d.cts)?(x)',
+];