Skip to content

argument-parser

Classes

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.

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.

Kind: global class

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.

ParamTypeDescription
optionsPluginOptionsThe plugin options to parse.

Example

js
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

NameTypeDescription
diststringDestination path for the generated files.
excludestringPatterns to exclude from processing.
folderstringMain folder for processing.
helpersArray.<string>List of helper functions or modules.
includestringPatterns to include for processing.
jsDocConfigPathstringPath to the JSDoc configuration file.
partialsArray.<string>List of partial templates or modules.
readmestringPath to the README file.
rmPatternArray.<string>Patterns for files to be removed.
sourcestringSource path for the files to be processed.
titlestringTitle for the generated documentation.
watchbooleanFlag to determine if the application should watch for file changes.

Released under the MIT License.