Global

Members

(constant) cliArgMap :ISpmhArgParserMap

Type:

ISpmhArgParserMap

Source: bin/cli-options.js, line 24

(constant) cliOptions :ISpmhArgParserOptions

Type:

ISpmhArgParserOptions

Source: bin/cli-options.js, line 12

(constant) globalEnv

Source: core/base.js, line 7

(constant) globalEnv :IWpwGlobalEnvironment

Type:

IWpwGlobalEnvironment

Source: utils/global.js, line 33

logger :WpwLogger

Type:

WpwLogger

Source: scripts/create-new-plugin.js, line 14

(constant) os

Source: core/wrapper.js, line 7

(constant) plugins

Source: exports/plugins.js, line 7

(constant) schema :SpmhJsonSchema

Type:

SpmhJsonSchema

Source: loaders/wpw-task-loader/lib/task.js, line 16

terserOptions :MinifyOptions

Type:

MinifyOptions

Source: exports/optimization.js, line 217

(constant) webpack

Source: bin/wpw-cli.js, line 9

(constant) wpwBuildOptionsKeys

Since: 1.11.0
Source: utils/utils.js, line 25

(constant) wpwBuildOptionsRootKeys

Since: 1.11.0
Source: utils/utils.js, line 31

Methods

_printQ(b, txt, q, failed, last)

Parameters:

Name	Type	Description
`b`	WpwBuild
`txt`	string
`q`	Array.<SpmhMessage>
`failed`	boolean
`last`	boolean

Source: utils/print.js, line 22

angular(opts, logger) → {boolean}

Parameters:

Name	Type	Description
`opts`	any
`logger`	WpwLogger

Source: utils/vendormod.js, line 19

Returns:

Type:: boolean

(async) applyVendorMods(opts, logger) → {Promise.<boolean>}

Parameters:

Name	Type	Description
`opts`	any
`logger`	WpwLogger

Source: utils/vendormod.js, line 251

Returns:

Type:: Promise.<boolean>

babel(tsopt) → {WebpackRuleSetUseItem}

Parameters:

Name	Type	Attributes	Description
`ts`	boolean	<optional>

Source: exports/rules.js, line 287

Returns:

Type:: WebpackRuleSetUseItem

breakProp(prop, wpwMod) → {string}

Break property name into separate spaced words at each camel cased character

Parameters:

Name	Type	Description
`prop`	string
`wpwMod`	WpwModule

Source: utils/utils.js, line 41

Returns:

string

Type:: string

cleanupBuildDone(build, loggeropt)

Parameters:

Name	Type	Attributes	Description
`build`	WpwBuild
`logger`	WpwLogger	<optional>

Source: utils/utils.js, line 58

createEntryObjFromDir(dir, ext, recurseopt, ignoreopt) → {any}

Parameters:

Name	Type	Attributes
`dir`	string
`ext`	WpwSourceCodeExtension \| WpwSourceDotExtensionApp
`recurse`	boolean \| undefined	<optional>
`ignore`	string \| Array.<string> \| undefined	<optional>

Source: utils/utils.js, line 128

Returns:

Type:: any

defaultProcessFn(builtPolicy, pluginData, $)

The default function for adding the CSP to the head of a document
Can be overwritten to allow the developer to process the CSP in their own way

Parameters:

Name	Type	Description
`builtPolicy`	string
`pluginData`	object
`$`	object

Source: plugins/web/csp.js, line 232

error(e, padopt) → {SpmhLogErrorFnResult.<E>}

Parameters:

Name	Type	Attributes	Description
`e`	E
`pad`	string \| number	<optional>

Source: core/module.js, line 199

Returns:

Type:: SpmhLogErrorFnResult.<E>

esbuild(tsopt) → {WebpackRuleSetUseItem}

Parameters:

Name	Type	Attributes	Description
`ts`	boolean	<optional>

Source: exports/rules.js, line 327

Returns:

Type:: WebpackRuleSetUseItem

exportConfig(name, createFn, build, wpc) → {any}

Parameters:

Name	Type	Description
`name`	string
`createFn`	function
`build`	WpwBuild
`wpc`	WpwWebpackConfig

Source: exports/index.js, line 86

Returns:

Type:: any

formatJsError(err, topTitle) → {string}

Parameters:

Name	Type	Default	Description
`err`	Error \| WebpackError
`topTitle`	string	EXCEPTION

Source: utils/utils.js, line 147

Returns:

Type:: string

getScriptBuildAssets(cfg, …addtl) → {Array.<string>}

Parameters:

Name	Type	Attributes	Description
`cfg`	WpwPluginConfigScript \| WpwPluginConfigRunScripts
`addtl`	Array.<string>	<repeatable>

Source: utils/utils.js, line 167

Returns:

Type:: Array.<string>

getScriptBuildDependencies(build, cfg, …addtl) → {Array.<string>}

Parameters:

Name	Type	Attributes
`build`	WpwBuild
`cfg`	WpwPluginConfigScript \| WpwPluginConfigRunScripts
`addtl`	Array.<string>	<repeatable>

Source: utils/utils.js, line 181

Returns:

Type:: Array.<string>

getUniqBuildKey(buildopt, prependBuildNmopt, xKeyopt, jChropt) → {string}

Parameters:

Name	Type	Attributes	Default
`build`	WpwBuild \| null	<optional>
`prependBuildNm`	boolean \| null	<optional>
`xKey`	string	<optional>
`jChr`	"-" \| "_" \| ""	<optional>	-

Since: 1.11.0
Source: utils/utils.js, line 201

Returns:

Type:: string

getUniqKey(wpw, xKey, jChropt) → {string}

Parameters:

Name	Type	Attributes	Default
`wpw`	WpwWrapper
`xKey`	string
`jChr`	"-" \| "_" \| ""	<optional>	-

Since: 1.11.0
Source: utils/utils.js, line 215

Returns:

Type:: string

hookdone(msgopt, rtnopt) → {T}

Parameters:

Name	Type	Attributes	Description
`msg`	string	<optional>
`rtn`	T	<optional>

Since: 1.11.0
Source: core/module.js, line 207

Returns:

Type:: T

hookstart(msgopt) → {WpwLogger}

Parameters:

Name	Type	Attributes	Description
`msg`	string	<optional>

Source: core/module.js, line 212

Returns:

Type:: WpwLogger

isWpwBuildOptionsKey(group, key, stat)

Parameters:

Name	Type	Description
`group`	string
`key`	any
`stat`	boolean	set to `true` to check to see if the options section specified by 'key' exists in the current configuration, adn return false if not, as opposed to only checking to see if 'key' is an actual/valid options section key

Since: 1.11.0
Source: utils/utils.js, line 227

isWpwBuildOptionsRootKey(key, stat)

Parameters:

Name	Type	Description
`key`	any
`stat`	boolean	set to `true` to check to see if the options section specified by 'key' exists in the current configuration, adn return false if not, as opposed to only checking to see if 'key' is an actual/valid options section key

Since: 1.11.0
Source: utils/utils.js, line 243

(async) jsdoc(opts, logger) → {Promise.<boolean>}

Parameters:

Name	Type	Description
`opts`	any
`logger`	WpwLogger

Source: utils/vendormod.js, line 45

Returns:

Type:: Promise.<boolean>

loader(source, map, meta)

Parameters:

Name	Type	Description
`source`	string
`map`	string
`meta`	any

Source: loaders/wpw-task-loader/lib/loader.js, line 24

loaderAsync(source, map, meta)

Parameters:

Name	Type	Description
`source`	string
`map`	string
`meta`	any

Source: loaders/wpw-task-loader/lib/loader.js, line 9

nodefetch(opts, logger) → {boolean}

Parameters:

Name	Type	Description
`opts`	any
`logger`	WpwLogger

Source: utils/vendormod.js, line 98

Returns:

Type:: boolean

nyc(opts, logger) → {boolean}

Parameters:

Name	Type	Description
`opts`	any
`logger`	WpwLogger

Source: utils/vendormod.js, line 129

Returns:

Type:: boolean

printBuildMessages(build, failed, suppress)

Parameters:

Name	Type	Description
`build`	WpwBuild
`failed`	boolean
`suppress`	Array.<string>

Source: utils/print.js, line 60

printBuildProperties(build, logIcon, lPad)

Parameters:

Name	Type	Description
`build`	WpwBuild
`logIcon`	any
`lPad`	string

Source: utils/print.js, line 81

printWpcProperties(build, logIcon, lPad)

Parameters:

Name	Type	Description
`build`	WpwBuild
`logIcon`	any
`lPad`	string

Source: utils/print.js, line 219

printWpwProperties(w, logIcon, lPad)

Parameters:

Name	Type	Description
`w`	WpwWrapper
`logIcon`	any
`lPad`	string

Source: utils/print.js, line 281

sortBuildOptions(x, y) → {number}

Parameters:

Name	Type	Description
`x`	string
`y`	string

Source: utils/print.js, line 319

Returns:

Type:: number

sourcemapPlugin(opts, logger) → {boolean}

Parameters:

Name	Type	Description
`opts`	any
`logger`	WpwLogger

Source: utils/vendormod.js, line 159

Returns:

Type:: boolean

task(_tsopt) → {WebpackRuleSetUseItem}

Parameters:

Name	Type	Attributes	Description
`_ts`	boolean	<optional>

Source: exports/rules.js, line 353

Returns:

Type:: WebpackRuleSetUseItem

(async) taskLoader(ctx, source, map, meta) → {Promise.<WpwLoaderResult>}

Parameters:

Name	Type	Description
`ctx`	WebpackLoaderContext
`source`	string
`map`	any
`meta`	any

Source: loaders/wpw-task-loader/lib/task.js, line 53

Returns:

Type:: Promise.<WpwLoaderResult>

ts(_tsopt) → {WebpackRuleSetUseItem}

Parameters:

Name	Type	Attributes	Description
`_ts`	boolean	<optional>

Source: exports/rules.js, line 372

Returns:

Type:: WebpackRuleSetUseItem

tsLoader(opts, logger) → {boolean}

Parameters:

Name	Type	Description
`opts`	any
`logger`	WpwLogger

Source: utils/vendormod.js, line 211

Returns:

Type:: boolean

value(msg, val, lvlopt, padopt) → {void}

Parameters:

Name	Type	Attributes
`msg`	string
`val`	any
`lvl`	WpwLoggerLevel	<optional>
`pad`	string \| number	<optional>

Source: core/module.js, line 227

Returns:

Type:: void

values(values, lvlopt, padopt, blankopt, hdropt)

Parameters:

Name	Type	Attributes	Description
`values`	SpmhLogValuesParam		message/value pairs
`lvl`	SpmhLogLevel	<optional>	logging level
`pad`	string \| number	<optional>	message pre-padding
`blank`	boolean \| null \| 0	<optional>
`hdr`	string \| null \| 0 \| false	<optional>	header / title / 1st line text

Source: core/module.js, line 235

webpackDefaultExports(build) → {WpwWebpackConfig}

Parameters:

Name	Type	Description
`build`	WpwBuild

Source: exports/index.js, line 40

Returns:

Type:: WpwWebpackConfig

webpackExports(build, lPad) → {WpwWebpackConfig}

Parameters:

Name	Type	Description
`build`	WpwBuild
`lPad`	string

Source: exports/index.js, line 131

Throws:

Error

Returns:

Type:: WpwWebpackConfig

wpwNodeModulesPath() → {string}

Since: 1.12.0
Source: utils/utils.js, line 276

Returns:

Type:: string

wpwPath() → {string}

Source: utils/utils.js, line 256

Returns:

Type:: string

wrapHookHandler(name, async, plugin, options) → {R}

Parameters:

Name	Type	Description
`name`	string
`async`	A
`plugin`	WpwModule
`options`	WpwPluginBaseTapOptions.<any, any, A>

Source: utils/hook.js, line 243

Returns:

Type:: R

write(msg, lvlopt, padopt) → {WpwLogger}

Parameters:

Name	Type	Attributes
`msg`	string
`lvl`	WpwLoggerLevel	<optional>
`pad`	string \| number	<optional>

Source: core/module.js, line 219

Returns:

Type:: WpwLogger

Members

(constant) SpmhWebpackConsole

(constant) WpwAnalyzePlugin

(constant) WpwAnalyzePlugin

(constant) WpwAnalyzePlugin

(constant) WpwBase

(constant) WpwBase

(constant) WpwBaseTaskPlugin

(constant) WpwCache

(constant) WpwDocPlugin

(constant) WpwDocPlugin

(constant) WpwDocPlugin

(constant) WpwIsoReleasePlugin

(constant) WpwIsoReleasePlugin

(constant) WpwIsoReleasePlugin

(constant) WpwModule

(constant) WpwModule

(constant) WpwModule

(constant) WpwPlugin

(constant) WpwPlugin

(constant) WpwPlugin

(constant) WpwPlugin

(constant) WpwPlugin

(constant) WpwPlugin

(constant) WpwPlugin

(constant) WpwPlugin

(constant) WpwPlugin

(constant) WpwPlugin

(constant) WpwPlugin

(constant) WpwPlugin

(constant) WpwPlugin

(constant) WpwPlugin

(constant) WpwPlugin

(constant) WpwPlugin

(constant) WpwPlugin

(constant) WpwPlugin

(constant) WpwPlugin

(constant) WpwPlugin

(constant) WpwService

(constant) WpwService

(constant) WpwService

(constant) WpwTaskPlugin

(constant) WpwTaskPlugin

(constant) WpwTaskPlugin

(constant) WpwTsProgram

(constant) WpwWebpackExport

(constant) WpwWebpackExport

(constant) WpwWebpackExport

(constant) WpwWebpackExport

(constant) WpwWebpackExport

(constant) WpwWebpackExport

(constant) WpwWebpackExport

(constant) WpwWebpackExport

(constant) WpwWebpackExport

(constant) WpwWebpackExport

(constant) cache

(constant) cliArgMap :ISpmhArgParserMap

(constant) cliOptions :ISpmhArgParserOptions

(constant) globalEnv

(constant) globalEnv :IWpwGlobalEnvironment

logger :WpwLogger

(constant) os

(constant) plugins

(constant) schema :SpmhJsonSchema

terserOptions :MinifyOptions

(constant) webpack

(constant) wpwBuildOptionsKeys

(constant) wpwBuildOptionsRootKeys

Methods

_printQ(b, txt, q, failed, last)

angular(opts, logger) → {boolean}

(async) applyVendorMods(opts, logger) → {Promise.<boolean>}

babel(tsopt) → {WebpackRuleSetUseItem}

breakProp(prop, wpwMod) → {string}

cleanupBuildDone(build, loggeropt)

createEntryObjFromDir(dir, ext, recurseopt, ignoreopt) → {any}

defaultProcessFn(builtPolicy, pluginData, $)

error(e, padopt) → {SpmhLogErrorFnResult.<E>}

esbuild(tsopt) → {WebpackRuleSetUseItem}

exportConfig(name, createFn, build, wpc) → {any}