Class: WpwRulesExport

new WpwRulesExport(options)

Parameters:

Name	Type	Description
`options`	WpwExportOptions

Implements: WpwWebpackExport
Source: exports/rules.js, line 18

Extends

WpwWebpackExport

Members

(protected) _arr_

Utility shortcut to @spmhome/type-utils/array set of functions

Overrides: WpwWebpackExport#_arr_
Implements: WpwWebpackExport#_arr_
Source: core/base.js, line 180

(protected) _async_

Utility shortcut to @spmhome/cmn-utils/path set of functions

Overrides: WpwWebpackExport#_async_
Implements: WpwWebpackExport#_async_
Source: core/base.js, line 122

(protected) _cmn_

Utility shortcut to @spmhome/cmn-utils/path set of functions

Overrides: WpwWebpackExport#_cmn_
Implements: WpwWebpackExport#_cmn_
Source: core/base.js, line 128

(protected) _crypto_

Utility shortcut to @spmhome/type-utils/crypto set of functions

Overrides: WpwWebpackExport#_crypto_
Implements: WpwWebpackExport#_crypto_
Source: core/base.js, line 186

(protected) _date_

Utility shortcut to @spmhome/type-utils/date set of functions

Overrides: WpwWebpackExport#_date_
Implements: WpwWebpackExport#_date_
Source: core/base.js, line 192

(protected) _fs_

Utility shortcut to @spmhome/cmn-utils/fs set of functions

Overrides: WpwWebpackExport#_fs_
Implements: WpwWebpackExport#_fs_
Source: core/base.js, line 141

(protected) _io_

Utility shortcut to @spmhome/cmn-utils/io set of functions

Overrides: WpwWebpackExport#_io_
Implements: WpwWebpackExport#_io_
Source: core/base.js, line 198

(protected) _json_

Utility shortcut to @spmhome/type-utils/json set of functions

Overrides: WpwWebpackExport#_json_
Implements: WpwWebpackExport#_json_
Source: core/base.js, line 204

(protected) _mime_

Utility shortcut to @spmhome/type-utils/mime set of functions

Overrides: WpwWebpackExport#_mime_
Implements: WpwWebpackExport#_mime_
Source: core/base.js, line 210

(protected) _node_

Utility shortcut to @spmhome/cmn-utils/node set of functions

Overrides: WpwWebpackExport#_node_
Implements: WpwWebpackExport#_node_
Source: core/base.js, line 147

(protected) _num_

Utility shortcut to @spmhome/type-utils/number set of functions

Overrides: WpwWebpackExport#_num_
Implements: WpwWebpackExport#_num_
Source: core/base.js, line 216

(protected) _obj_

Utility shortcut to @spmhome/type-utils/object set of functions

Overrides: WpwWebpackExport#_obj_
Implements: WpwWebpackExport#_obj_
Source: core/base.js, line 222

(protected) _path_

Utility shortcut to @spmhome/cmn-utils/path set of functions

Overrides: WpwWebpackExport#_path_
Implements: WpwWebpackExport#_path_
Source: core/base.js, line 135

(protected) _pms_

Utility shortcut to @spmhome/type-utils/promise set of functions

Overrides: WpwWebpackExport#_pms_
Implements: WpwWebpackExport#_pms_
Source: core/base.js, line 228

(protected) _rgx_

Utility shortcut to @spmhome/type-utils/regex set of functions

Overrides: WpwWebpackExport#_rgx_
Implements: WpwWebpackExport#_rgx_
Source: core/base.js, line 234

(protected) _str_

Utility shortcut to @spmhome/type-utils/string set of functions

Overrides: WpwWebpackExport#_str_
Implements: WpwWebpackExport#_str_
Source: core/base.js, line 240

(protected) _ts_

Utility shortcut to @spmhome/cmn-utils/ts set of functions

Overrides: WpwWebpackExport#_ts_
Implements: WpwWebpackExport#_ts_
Source: core/base.js, line 153

(protected) _types_

Utility shortcut to @spmhome/type-utils/type set of functions

Overrides: WpwWebpackExport#_types_
Implements: WpwWebpackExport#_types_
Source: core/base.js, line 246

(protected) _ver_

Utility shortcut to @spmhome/cmn-utils/version set of functions

Overrides: WpwWebpackExport#_ver_
Implements: WpwWebpackExport#_ver_
Source: core/base.js, line 159

(protected) _www_

Utility shortcut to @spmhome/cmn-utils/fetch set of functions

Overrides: WpwWebpackExport#_www_
Implements: WpwWebpackExport#_www_
Source: core/base.js, line 165

build :WpwBuild

Type:

WpwBuild

Overrides: WpwWebpackExport#build
Implements: WpwWebpackExport#build
Source: core/module.js, line 35

buildOptions :WpwBuildOptionsExportConfig.<"rules">

Type:

WpwBuildOptionsExportConfig.<"rules">

Overrides: WpwWebpackExport#buildOptions
Implements: WpwWebpackExport#buildOptions
Source: exports/rules.js, line 26

cacheMap :Record.<WpwBuildOptionsKey, WpwCache>

Type:

Record.<WpwBuildOptionsKey, WpwCache>

Overrides: WpwWebpackExport#cacheMap
Implements: WpwWebpackExport#cacheMap
Source: core/module.js, line 31

compilation :WebpackCompilation

Type:

WebpackCompilation

Overrides: WpwWebpackExport#compilation
Implements: WpwWebpackExport#compilation
Source: core/module.js, line 47

compiler :WebpackCompiler

Type:

WebpackCompiler

Overrides: WpwWebpackExport#compiler
Implements: WpwWebpackExport#compiler
Source: core/module.js, line 43

(protected) disposables :Array.<IDisposable>

Type:

Array.<IDisposable>

Overrides: WpwWebpackExport#disposables
Implements: WpwWebpackExport#disposables
Source: core/base.js, line 27

(protected) disposed :boolean

Type:

boolean

Overrides: WpwWebpackExport#disposed
Implements: WpwWebpackExport#disposed
Source: core/base.js, line 22

global

Overrides: WpwWebpackExport#global
Implements: WpwWebpackExport#global
Source: core/base.js, line 71

hasPluginHooks :boolean|undefined

Type:

boolean | undefined

Overrides: WpwWebpackExport#hasPluginHooks
Implements: WpwWebpackExport#hasPluginHooks
Source: exports/base.js, line 27

hookCurrent :string|undefined

Type:

string | undefined

Overrides: WpwWebpackExport#hookCurrent
Implements: WpwWebpackExport#hookCurrent
Source: core/module.js, line 56

hookMessages :Record.<string, {start: string, done: string, fail: string}>

Type:

Record.<string, {start: string, done: string, fail: string}>

Overrides: WpwWebpackExport#hookMessages
Implements: WpwWebpackExport#hookMessages
Source: core/module.js, line 60

(protected) initialConfig :any

cloned initial configuration object prior to any runtime modifications

Type:

Overrides: WpwWebpackExport#initialConfig
Implements: WpwWebpackExport#initialConfig
Source: core/base.js, line 33

(protected) name :string

module name

Type:

string

Overrides: WpwWebpackExport#name
Implements: WpwWebpackExport#name
Source: core/base.js, line 39

(protected) slug :string

url/path friendly module name

Type:

string

Overrides: WpwWebpackExport#slug
Implements: WpwWebpackExport#slug
Source: core/base.js, line 45

(protected) spmh

Top level export of spmh shared library packages ...{ cls, type, util }...

Overrides: WpwWebpackExport#spmh
Implements: WpwWebpackExport#spmh
Source: core/base.js, line 102

(protected) store :WpwCache

Type:

WpwCache

Overrides: WpwWebpackExport#store
Implements: WpwWebpackExport#store
Source: core/module.js, line 52

subtype :WpwModuleSubType

Type:

WpwModuleSubType

Overrides: WpwWebpackExport#subtype
Implements: WpwWebpackExport#subtype
Source: core/module.js, line 68

Methods

addMessage(info, ifFirstopt) → {SpmhError}

Parameters:

Name	Type	Attributes	Description
`info`	Partial.<SpmhMessageInfo> \| SpmhError
`ifFirst`	boolean \| undefined	<optional>

Overrides: WpwWebpackExport#addMessage
Implements: WpwWebpackExport#addMessage
Source: core/module.js, line 254

Returns:

Type:: SpmhError

(protected) app(build)

Parameters:

Name	Type	Description
`build`	WpwBuild

Overrides: WpwWebpackExport#app
Implements: WpwWebpackExport#app
Source: exports/rules.js, line 43

(protected) base(_build)

Parameters:

Name	Type	Description
`_build`	WpwBuild

Overrides: WpwWebpackExport#base
Implements: WpwWebpackExport#base
Source: exports/base.js, line 54

(protected) baseDone(_build)

Parameters:

Name	Type	Description
`_build`	WpwBuild

Overrides: WpwWebpackExport#baseDone
Implements: WpwWebpackExport#baseDone
Source: exports/base.js, line 61

(protected) doxygen(_build)

Parameters:

Name	Type	Description
`_build`	WpwBuild

Overrides: WpwWebpackExport#doxygen
Implements: WpwWebpackExport#doxygen
Source: exports/rules.js, line 168

exec(command, program, asyncopt, optionsopt) → {WpwExecResultKind.<P>}

Parameters:

Name	Type	Attributes
`command`	string
`program`	string
`async`	P	<optional>
`options`	WpwModuleExecOptions	<optional>

Overrides: WpwWebpackExport#exec
Implements: WpwWebpackExport#exec
Source: core/module.js, line 287

Returns:

Type:: WpwExecResultKind.<P>

exec2(async, options) → {WpwExecResultKind.<P>}

Parameters:

Name	Type	Description
`async`	P
`options`	WpwExecOptions

Overrides: WpwWebpackExport#exec2
Implements: WpwWebpackExport#exec2
Source: core/module.js, line 306

Returns:

Type:: WpwExecResultKind.<P>

(protected) extjsdoc(_build)

Parameters:

Name	Type	Description
`_build`	WpwBuild

Overrides: WpwWebpackExport#extjsdoc
Implements: WpwWebpackExport#extjsdoc
Source: exports/rules.js, line 174

(protected) getErrorMessageCfg(message, codeopt, exceptionopt) → {WpwBaseMessageInfo}

Parameters:

Name	Type	Attributes
`message`	string
`code`	SpmhMessageCode \| null	<optional>
`exception`	SpmhError \| WebpackError \| Error \| undefined	<optional>

Overrides: WpwWebpackExport#getErrorMessageCfg
Implements: WpwWebpackExport#getErrorMessageCfg
Source: core/module.js, line 337

Returns:

Type:: WpwBaseMessageInfo

getExcludes(loader, allowTestopt, allowNodeModulesopt, allowTypesopt, allowDtsopt) → {Array.<RegExp>}

Parameters:

Name	Type	Attributes
`loader`	*
`allowTest`	boolean	<optional>
`allowNodeModules`	boolean	<optional>
`allowTypes`	boolean	<optional>
`allowDts`	boolean	<optional>

Since: 1.11.0
Source: exports/rules.js, line 187

Returns:

Type:: Array.<RegExp>

getStore(moduleKeyopt) → {WpwCache}

Parameters:

Name	Type	Attributes	Description
`moduleKey`	WpwBuildOptionsKey	<optional>

Overrides: WpwWebpackExport#getStore
Implements: WpwWebpackExport#getStore
Source: core/module.js, line 356

Returns:

Type:: WpwCache

hashLength() → {number}

Since: 1.10.1
Overrides: WpwWebpackExport#hashLength
Implements: WpwWebpackExport#hashLength
Source: core/module.js, line 423

Returns:

Type:: number

hookdone(msgopt, rtnopt) → {T}

Parameters:

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

Since: 1.11.0
Overrides: WpwWebpackExport#hookdone
Implements: WpwWebpackExport#hookdone
Source: core/module.js, line 436

Returns:

Type:: T

hookstart(msgopt, writePluginOptsopt) → {WpwLogger}

Parameters:

Name	Type	Attributes	Description
`msg`	string \| number	<optional>
`writePluginOpts`	boolean	<optional>

Since: 1.11.0
Overrides: WpwWebpackExport#hookstart
Implements: WpwWebpackExport#hookstart
Source: core/module.js, line 455

Returns:

Type:: WpwLogger

(protected) invalidHookConfig(hookName, hookType, configDsc) → {SpmhMessage}

Parameters:

Name	Type	Default
`hookName`	string
`hookType`	"compiler" \| "compilation"	compilation
`configDsc`	string	async/sync

Overrides: WpwWebpackExport#invalidHookConfig
Implements: WpwWebpackExport#invalidHookConfig
Source: core/module.js, line 480

Returns:

Type:: SpmhMessage

isAsyncHook(hook)

Parameters:

Name	Type	Description
`hook`	any

Overrides: WpwWebpackExport#isAsyncHook
Implements: WpwWebpackExport#isAsyncHook
Source: core/module.js, line 494

(protected) isCompilationHook(hook)

Parameters:

Name	Type	Description
`hook`	any

Overrides: WpwWebpackExport#isCompilationHook
Implements: WpwWebpackExport#isCompilationHook
Source: core/module.js, line 521

(protected) isSyncHook(hook, strictopt)

Parameters:

Name	Type	Attributes	Description
`hook`	any
`strict`	boolean	<optional>

Overrides: WpwWebpackExport#isSyncHook
Implements: WpwWebpackExport#isSyncHook
Source: core/module.js, line 508

(protected) isTapableHook(hook) → {boolean}

Parameters:

Name	Type	Description
`hook`	WpwWebpackCompilerHook \| WebpackCompilationHookName

Overrides: WpwWebpackExport#isTapableHook
Implements: WpwWebpackExport#isTapableHook
Source: core/module.js, line 535

Returns:

hook is WebpackHook

Type:: boolean

(protected) jsdoc(_build)

The jsdoc module is a WpwBaseTaskPlugin type module, using a virtual file so that
Webpack runs through it's normal process as if it going to bundle ts/js code.

The jsdoc module is a WpwBaseTaskPlugin type module, using a virtual file so that
Webpack runs through it's normal process as if it going to bundle ts/js code. This scenario
is used when the build really isn't a Webpack bundling, but more of something that usually
a task runner would handle, e.g this jsdoc build or the types build. They are implemented
here in an effort to condense all tasks to Webpack only, where something like Gulp, Grunt, Ant,
etc is not needed, especially for several smaller projects.

Parameters:

Name	Type	Description
`_build`	WpwBuild

Overrides: WpwWebpackExport#jsdoc
Implements: WpwWebpackExport#jsdoc
Source: exports/rules.js, line 242

Throws:

SpmhError

(protected) lib(build)

Parameters:

Name	Type	Description
`build`	WpwBuild

Overrides: WpwWebpackExport#lib
Implements: WpwWebpackExport#lib
Source: exports/rules.js, line 249

(protected) plugin(build)

Parameters:

Name	Type	Description
`build`	WpwBuild

Overrides: WpwWebpackExport#plugin
Implements: WpwWebpackExport#plugin
Source: exports/rules.js, line 256

(protected) resource(_build)

Parameters:

Name	Type	Description
`_build`	WpwBuild

Overrides: WpwWebpackExport#resource
Implements: WpwWebpackExport#resource
Source: exports/rules.js, line 262

(protected) schema(_build)

Parameters:

Name	Type	Description
`_build`	WpwBuild

Overrides: WpwWebpackExport#schema
Implements: WpwWebpackExport#schema
Source: exports/rules.js, line 272

(protected) script(_build)

Parameters:

Name	Type	Description
`_build`	WpwBuild

Overrides: WpwWebpackExport#script
Implements: WpwWebpackExport#script
Source: exports/rules.js, line 278

(protected) tapCompilationHooks(optionsArray)

Parameters:

Name	Type	Description
`optionsArray`	Array.<WpwPluginCompilationTapOptionsPair.<any, any, boolean>>

Overrides: WpwWebpackExport#tapCompilationHooks
Implements: WpwWebpackExport#tapCompilationHooks
Source: core/module.js, line 543

(protected) tests(build)

Parameters:

Name	Type	Description
`build`	WpwBuild

Overrides: WpwWebpackExport#tests
Implements: WpwWebpackExport#tests
Source: exports/rules.js, line 468

(protected) types(build)

The types module is a WpwBaseTaskPlugin type module, using a virtual file so that
Webpack runs through it's normal process as if it going to bundle ts/js code.

The types module is a WpwBaseTaskPlugin type module, using a virtual file so that
Webpack runs through it's normal process as if it going to bundle ts/js code. This scenario
is used when the build really isn't a Webpack bundling, but more of something that usually
a task runner would handle, e.g this types build or the jsdoc build. They are implemented
here in an effort to condense all tasks to Webpack only, where something like Gulp, Grunt, Ant,
etc is not needed, especially for several smaller projects.

Parameters:

Name	Type	Description
`build`	WpwBuild

Overrides: WpwWebpackExport#types
Implements: WpwWebpackExport#types
Source: exports/rules.js, line 491

(protected) webapp(build)

Parameters:

Name	Type	Description
`build`	WpwBuild

Overrides: WpwWebpackExport#webapp
Implements: WpwWebpackExport#webapp
Source: exports/rules.js, line 515

new WpwRulesExport(options)

Extends

Members

(protected) ErrorCode

(protected) InfoCode

(protected) Msg

(protected) MsgCode

(protected) WarningCode

(protected) _arr_

(protected) _async_

(protected) _cmn_

(protected) _crypto_

(protected) _date_

(protected) _fs_

(protected) _io_

(protected) _json_

(protected) _mime_

(protected) _node_

(protected) _num_

(protected) _obj_

(protected) _path_

(protected) _pms_

(protected) _rgx_

(protected) _str_

(protected) _ts_

(protected) _types_

(protected) _ver_

(protected) _www_

build :WpwBuild

buildOptions :WpwBuildOptionsExportConfig.<"rules">

cacheMap :Record.<WpwBuildOptionsKey, WpwCache>

compilation :WebpackCompilation

compiler :WebpackCompiler

(protected) disposables :Array.<IDisposable>

(protected) disposed :boolean

global

hasPluginHooks :boolean|undefined

hookCurrent :string|undefined

hookMessages :Record.<string, {start: string, done: string, fail: string}>

(protected) initialConfig :any

(protected) name :string

(protected) slug :string

(protected) spmh

(protected) store :WpwCache

subtype :WpwModuleSubType

Methods

addMessage(info, ifFirstopt) → {SpmhError}

(protected) app(build)

(protected) base(_build)

(protected) baseDone(_build)

(protected) doxygen(_build)

exec(command, program, asyncopt, optionsopt) → {WpwExecResultKind.<P>}

exec2(async, options) → {WpwExecResultKind.<P>}

(protected) extjsdoc(_build)

(protected) getErrorMessageCfg(message, codeopt, exceptionopt) → {WpwBaseMessageInfo}

getExcludes(loader, allowTestopt, allowNodeModulesopt, allowTypesopt, allowDtsopt) → {Array.<RegExp>}

getStore(moduleKeyopt) → {WpwCache}

hashLength() → {number}

hookdone(msgopt, rtnopt) → {T}

hookstart(msgopt, writePluginOptsopt) → {WpwLogger}

(protected) invalidHookConfig(hookName, hookType, configDsc) → {SpmhMessage}

isAsyncHook(hook)

(protected) isCompilationHook(hook)

(protected) isSyncHook(hook, strictopt)

(protected) isTapableHook(hook) → {boolean}

(protected) jsdoc(_build)

(protected) lib(build)

(protected) plugin(build)

(protected) resource(_build)

(protected) schema(_build)

(protected) script(_build)

(protected) tapCompilationHooks(optionsArray)

(protected) tests(build)

(protected) types(build)

(protected) webapp(build)