yargs-file-commands 0.0.9 → 0.0.10

package/dist/lib/fileCommands.d.ts

@@ -1,23 +1,18 @@
+import { type ScanDirectoryOptions } from './scanDirectory.js';
 /**
  * Configuration options for file-based command generation
  * @interface FileCommandsOptions
  */
-export type FileCommandsOptions = {
+export type FileCommandsOptions = ScanDirectoryOptions & {
     /** Array of directory paths to scan for command files */
     commandDirs: string[];
-    /** File extensions to consider when scanning for command files */
-    extensions?: string[];
-    /** Regular expressions for patterns to ignore when scanning directories */
-    ignorePatterns?: RegExp[];
-    /** Logging verbosity level */
-    logLevel?: 'info' | 'debug';
 };
 /**
  * Default configuration options for file-based commands
  * @constant
  * @type {Partial<FileCommandsOptions>}
  */
-export declare const DefaultFileCommandsOptions: Partial<FileCommandsOptions>;
+export declare const DefaultFileCommandsOptions: Required<FileCommandsOptions>;
 /**
  * Generates a command tree structure from files in specified directories
  * @async

package/dist/lib/fileCommands.js

@@ -9,6 +9,8 @@ import { segmentPath } from './segmentPath.js';
  * @type {Partial<FileCommandsOptions>}
  */
 export const DefaultFileCommandsOptions = {
+    /** Default directories to scan for command files */
+    commandDirs: [],
     /** Default file extensions to process */
     extensions: ['.js', '.ts'],
     /** Default patterns to ignore when scanning directories */
@@ -19,7 +21,9 @@ export const DefaultFileCommandsOptions = {
         /\.d\.ts$/ // TypeScript declaration files
     ],
     /** Default logging level */
-    logLevel: 'info'
+    logLevel: 'info',
+    /** Default log prefix */
+    logPrefix: '  '
 };
 /**
  * Generates a command tree structure from files in specified directories
@@ -41,9 +45,16 @@ export const DefaultFileCommandsOptions = {
 export const fileCommands = async (options) => {
     const fullOptions = {
         ...DefaultFileCommandsOptions,
-        ...options,
-        logPrefix: '  '
+        ...options
     };
+    // validate extensions have dots in them
+    if (fullOptions.extensions.some((ext) => !ext.startsWith('.'))) {
+        throw new Error(`Invalid extensions provided, must start with a dot: ${fullOptions.extensions.join(', ')}`);
+    }
+    // check for empty list of directories to scan
+    if (fullOptions.commandDirs.length === 0) {
+        throw new Error('No command directories provided');
+    }
     const commands = [];
     for (const commandDir of fullOptions.commandDirs) {
         const fullPath = path.resolve(commandDir);
@@ -59,6 +70,10 @@ export const fileCommands = async (options) => {
             });
         }
     }
+    // check if no commands were found
+    if (commands.length === 0) {
+        throw new Error(`No commands found in specified directories: ${fullOptions.commandDirs.join(', ')}`);
+    }
     const commandRootNodes = buildSegmentTree(commands);
     if (fullOptions.logLevel === 'debug') {
         console.debug('Command tree structure:');

package/dist/lib/scanDirectory.d.ts

@@ -3,11 +3,13 @@
  * @interface ScanDirectoryOptions
  */
 export interface ScanDirectoryOptions {
-    /** Regular expressions for patterns to ignore */
-    ignorePatterns?: RegExp[];
-    /** File extensions to include in the scan */
+    /** File extensions to consider when scanning for command files */
     extensions?: string[];
+    /** Regular expressions for patterns to ignore when scanning directories */
+    ignorePatterns?: RegExp[];
+    /** Logging verbosity level */
     logLevel?: 'info' | 'debug';
+    /** Prefix for log messages */
     logPrefix?: string;
 }
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "yargs-file-commands",
   "description": "A yargs helper function that lets you define your commands structure via directory and file naming conventions.",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",