argument-parser
Classes
- ArgumentParser
The
ArgumentParser
class provides a mechanism to parse plugin options for the application. It acts as a wrapper around theparsePluginOptions
function, ensuring a consistent interface for argument parsing throughout the application.
Typedefs
- PluginOptions
Represents the plugin options provided to the application.
ArgumentParser
The ArgumentParser
class provides a mechanism to parse plugin options for the application. It acts as a wrapper around the parsePluginOptions
function, ensuring a consistent interface for argument parsing throughout the application.
argumentParser.parse(options) ⇒ object
Parses the provided plugin options into a structured format.
Kind: instance method of ArgumentParser
Returns: object
- An object containing the parsed arguments.
Param | Type | Description |
---|---|---|
options | PluginOptions | The plugin options to parse. |
Example
const parser = new ArgumentParser();
const parsedArgs = parser.parse(process.argv);
const parser = new ArgumentParser();
const parsedArgs = parser.parse(process.argv);
PluginOptions
Represents the plugin options provided to the application.
Kind: global typedef
Properties
Name | Type | Description |
---|---|---|
dist | string | Destination path for the generated files. |
exclude | string | Patterns to exclude from processing. |
folder | string | Main folder for processing. |
helpers | Array.<string> | List of helper functions or modules. |
include | string | Patterns to include for processing. |
jsDocConfigPath | string | Path to the JSDoc configuration file. |
partials | Array.<string> | List of partial templates or modules. |
readme | string | Path to the README file. |
rmPattern | Array.<string> | Patterns for files to be removed. |
source | string | Source path for the files to be processed. |
title | string | Title for the generated documentation. |
watch | boolean | Flag to determine if the application should watch for file changes. |