From 791cc59fcee30265fe1a0df30869a827aac02f4e Mon Sep 17 00:00:00 2001 From: Benny Neugebauer Date: Tue, 2 Jun 2020 22:55:57 +0200 Subject: [PATCH] docs: describe commandDir() parameters (#1540) (#1613) --- docs/api.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/docs/api.md b/docs/api.md index def8e6a37..093d36331 100644 --- a/docs/api.md +++ b/docs/api.md @@ -220,6 +220,29 @@ var argv = require('yargs') .argv ``` + +.commandDir(directory, [opts]) +------------------------------ + +Apply command modules from a directory relative to the module calling this method. + +`directory` is a relative directory path as a string (required). + +`opts` is an options object (optional). The following options are valid: + +`recurse`: Look for command modules in all subdirectories and apply them as a flattened +(non-hierarchical) list. + +`extensions`: The types of files to look for when requiring command modules. + +`visit`: A synchronous function called for each command module encountered. Accepts +`commandObject`, `pathToFile`, and `filename` as arguments. Returns `commandObject` +to include the command; any falsy value to exclude/skip it. + +`include`: Whitelist certain modules. See [`require-directory` whitelisting](https://www.npmjs.com/package/require-directory#whitelisting) for details. + +`exclude`: Blacklist certain modules. See [`require-directory` blacklisting](https://www.npmjs.com/package/require-directory#blacklisting) for details. + .command(cmd, desc, [builder], [handler]) -----------------------------------------