yargs-file-commands 0.0.12 → 0.0.13

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # yargs-file-commands
 
+## 0.0.13
+
+### Patch Changes
+
+- More explicit exceptions when bad parameters are passed in
+- Validate that provided command directories are aboslute
+- More robust parameter checking and logging
+- Improved debugging logging
+- More robust debug messages
+
 ## 0.0.12
 
 ### Patch Changes

package/dist/lib/fileCommands.js

@@ -55,12 +55,21 @@ export const fileCommands = async (options) => {
     if (fullOptions.commandDirs.length === 0) {
         throw new Error('No command directories provided');
     }
+    // throw if some command directories are not absolute, first filter to find non-absolute an then throw, listing those that are not absolute
+    const nonAbsoluteDirs = fullOptions.commandDirs.filter((dir) => !path.isAbsolute(dir));
+    if (nonAbsoluteDirs.length > 0) {
+        throw new Error(`Command directories must be absolute paths: ${nonAbsoluteDirs.join(', ')}`);
+    }
     const commands = [];
     for (const commandDir of fullOptions.commandDirs) {
         const fullPath = path.resolve(commandDir);
-        console.debug(`Scanning directory for commands: ${fullPath}`);
+        if (fullOptions.logLevel === 'debug') {
+            console.debug(`Scanning directory for commands: ${fullPath}`);
+        }
         const filePaths = await scanDirectory(commandDir, commandDir, fullOptions);
-        console.debug(`Importing found commands:`);
+        if (fullOptions.logLevel === 'debug') {
+            console.debug(`Importing found commands:`);
+        }
         for (const filePath of filePaths) {
             const localPath = path.relative(commandDir, filePath);
             const segments = segmentPath(filePath, commandDir);

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.12",
+  "version": "0.0.13",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/lib/fileCommands.ts

@@ -82,15 +82,31 @@ export const fileCommands = async (options: FileCommandsOptions) => {
     throw new Error('No command directories provided');
   }
 
+  // throw if some command directories are not absolute, first filter to find non-absolute an then throw, listing those that are not absolute
+  const nonAbsoluteDirs = fullOptions.commandDirs.filter(
+    (dir) => !path.isAbsolute(dir)
+  );
+  if (nonAbsoluteDirs.length > 0) {
+    throw new Error(
+      `Command directories must be absolute paths: ${nonAbsoluteDirs.join(
+        ', '
+      )}`
+    );
+  }
+
   const commands: Command[] = [];
 
   for (const commandDir of fullOptions.commandDirs) {
     const fullPath = path.resolve(commandDir);
-    console.debug(`Scanning directory for commands: ${fullPath}`);
+    if (fullOptions.logLevel === 'debug') {
+      console.debug(`Scanning directory for commands: ${fullPath}`);
+    }
 
     const filePaths = await scanDirectory(commandDir, commandDir, fullOptions);
 
-    console.debug(`Importing found commands:`);
+    if (fullOptions.logLevel === 'debug') {
+      console.debug(`Importing found commands:`);
+    }
     for (const filePath of filePaths) {
       const localPath = path.relative(commandDir, filePath);
       const segments = segmentPath(filePath, commandDir);