config

test-example~ config

Source:
Properties:
Name Type Attributes Default Description
config.sourcePath string <optional>
"source/"

Path of the Source directory

config.testPath string <optional>
"test/"

Path of the Test directory

config.overWrite boolean <optional>
true

Overwrite existed test scripts or not

config.hookModule string <optional>

Path of Node.JS Module contained Hook method

Config namespace of this plugin

Example

// Merge those options below to your JSDoc `config.json`
    {
        "plugins":         ["node_modules/test-example"],
        "test-example":    {
            "sourcePath":    "path/to/source/directory",
            "testPath":      "path/to/test/directory",
            "overWrite":     false,
            "hookModule":    "path/to/plugin/hook"
        }
    }