yargs-file-commands 0.0.1 → 0.0.3

package/README.md

@@ -1,7 +1,6 @@
 # Yargs File Commands
 
 [![NPM Package][npm]][npm-url]
-[![Build Size][build-size]][build-size-url]
 [![NPM Downloads][npm-downloads]][npmtrends-url]
 
 This Yargs helper function lets you define all your commands as individual files and their file names and directory structure defines via implication your nested command structure.
@@ -19,21 +18,15 @@ npm install yargs-file-commands
 ## Example
 
 ```ts
-import { createRequire } from 'module';
-import path from 'path';
-import yargs from 'yargs';
-import { fileCommands } from 'yargs-file-commands';
-
-const require = createRequire(import.meta.url);
-
 export const main = async () => {
-  const rootCommandDir = path.join(
-    import.meta.url.replace('file://', ''),
-    '../commands'
-  );
-
-  return yargs(process.argv)
-    .command(await fileCommands({ rootDirs: [rootCommandDir] }))
+  const commandsDir = path.join(distDir, 'commands');
+
+  return yargs(hideBin(process.argv))
+    .scriptName(packageInfo.name!)
+    .version(packageInfo.version!)
+    .command(
+      await fileCommands({ commandDirs: [commandsDir], logLevel: 'debug' })
+    )
     .help().argv;
 };
 ```
@@ -90,7 +83,7 @@ studio start
 
 The "fileCommands" method takes the following options:
 
-**routesDirs**
+**commandDirs**
 
 - An array of directories where the routes are located relative to the build root folder.
 - Required
@@ -100,11 +93,10 @@ The "fileCommands" method takes the following options:
 - An array of file extensions for the route files. Files without matching extensions are ignored
 - Default: `[".js", ".ts"]`
 
-** ignorePatterns?: RegExp[];
-**
+**ignorePatterns**
 
 - An array of regexs which if matched against a filename or directory, lead it to being ignored/skipped over.
-- Default: `[ /^[\.|_].*/, /\.(test|spec)\.[jt]s$/, /__(test|spec)__/, /\.d\.ts$/ ]`
+- Default: `[ /^[.|_].*/, /\.(?:test|spec)\.[jt]s$/, /__(?:test|spec)__/, /\.d\.ts$/ ]`
 
 **logLevel**
 
@@ -140,3 +132,10 @@ npm run publish
 # run example cli
 npx example-cli
 ```
+
+Underneath the hood, we are using [NX](https://nx.dev) to manage the monorepo and shared scripts.
+
+[npm]: https://img.shields.io/npm/v/yargs-file-commands
+[npm-url]: https://www.npmjs.com/package/yargs-file-commands
+[npm-downloads]: https://img.shields.io/npm/dw/yargs-file-commands
+[npmtrends-url]: https://www.npmtrends.com/yargs-file-commands

package/dist/lib/fileCommands.d.ts

@@ -1,5 +1,5 @@
 export type FileCommandsOptions = {
-    rootDirs: string[];
+    commandDirs: string[];
     extensions?: string[];
     ignorePatterns?: RegExp[];
     logLevel?: 'info' | 'debug';

package/dist/lib/fileCommands.js

@@ -5,9 +5,9 @@ import { segmentPath } from './segmentPath.js';
 export const DefaultFileCommandsOptions = {
     extensions: ['.js', '.ts'],
     ignorePatterns: [
-        /^[\.|_].*/,
-        /\.(test|spec)\.[jt]s$/,
-        /__(test|spec)__/,
+        /^[.|_].*/,
+        /\.(?:test|spec)\.[jt]s$/,
+        /__(?:test|spec)__/,
         /\.d\.ts$/
     ],
     logLevel: 'info'
@@ -15,13 +15,13 @@ export const DefaultFileCommandsOptions = {
 export const fileCommands = async (options) => {
     const fullOptions = { ...DefaultFileCommandsOptions, ...options };
     const commands = [];
-    await Promise.all(options.rootDirs.map(async (rootCommandDir) => {
-        const filePaths = await scanDirectory(rootCommandDir, fullOptions);
+    await Promise.all(options.commandDirs.map(async (commandDir) => {
+        const filePaths = await scanDirectory(commandDir, fullOptions);
         const rootDirCommands = await Promise.all(filePaths.map(async (filePath) => {
-            const segments = segmentPath(filePath, rootCommandDir);
+            const segments = segmentPath(filePath, commandDir);
             return {
                 fullPath: filePath,
-                segments: segmentPath(filePath, rootCommandDir),
+                segments: segmentPath(filePath, commandDir),
                 commandModule: await importCommandFromFile(filePath, segments[segments.length - 1])
             };
         }));

package/dist/lib/scanDirectory.d.ts

@@ -1,4 +1,5 @@
 export interface ScanDirectoryOptions {
     ignorePatterns?: RegExp[];
+    extensions?: string[];
 }
 export declare const scanDirectory: (dirPath: string, options?: ScanDirectoryOptions) => Promise<string[]>;

package/dist/lib/scanDirectory.js

@@ -1,7 +1,7 @@
 import { readdir, stat } from 'fs/promises';
-import { join } from 'path';
+import path, { join } from 'path';
 export const scanDirectory = async (dirPath, options = {}) => {
-    const { ignorePatterns = [] } = options;
+    const { ignorePatterns = [], extensions = [] } = options;
     // Check if path should be ignored
     const shouldIgnore = ignorePatterns.some((pattern) => pattern.test(dirPath));
     if (shouldIgnore) {
@@ -20,6 +20,10 @@ export const scanDirectory = async (dirPath, options = {}) => {
             if (stats.isDirectory()) {
                 return scanDirectory(fullPath, options);
             }
+            const extension = path.extname(fullPath);
+            if (!extensions.includes(extension)) {
+                return [];
+            }
             return [fullPath];
         });
         const nestedFiles = await Promise.all(nestedFilesPromises);

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