Repository: neutrinojs/webpack-chain
Branch: main
Commit: da73fab944e5
Files: 45
Total size: 170.2 KB
Directory structure:
gitextract_gz5flbuo/
├── .eslintrc.js
├── .github/
│ └── workflows/
│ └── ci.yml
├── .gitignore
├── .prettierignore
├── .prettierrc.js
├── CHANGELOG.md
├── LICENSE
├── README.md
├── jest.config.js
├── package.json
├── renovate.json
├── src/
│ ├── Chainable.js
│ ├── ChainedMap.js
│ ├── ChainedSet.js
│ ├── Config.js
│ ├── DevServer.js
│ ├── Module.js
│ ├── Optimization.js
│ ├── Orderable.js
│ ├── Output.js
│ ├── Performance.js
│ ├── Plugin.js
│ ├── Resolve.js
│ ├── ResolveLoader.js
│ ├── Rule.js
│ └── Use.js
├── test/
│ ├── Chainable.js
│ ├── ChainedMap.js
│ ├── ChainedSet.js
│ ├── Config.js
│ ├── DevServer.js
│ ├── Module.js
│ ├── Optimization.js
│ ├── Orderable.js
│ ├── Output.js
│ ├── Performance.js
│ ├── Plugin.js
│ ├── Resolve.js
│ ├── ResolveLoader.js
│ ├── Rule.js
│ └── Use.js
└── types/
├── index.d.ts
├── test/
│ ├── tsconfig.json
│ └── webpack-chain-tests.ts
└── typings.json
================================================
FILE CONTENTS
================================================
================================================
FILE: .eslintrc.js
================================================
module.exports = {
root: true,
extends: [
'eslint-config-airbnb-base',
'eslint-config-prettier',
'plugin:jest/recommended',
'plugin:jest/style',
],
// Force dotfiles to be checked, since by default ESLint ignores them.
ignorePatterns: ['!.*.js'],
reportUnusedDisableDirectives: true,
rules: {
'class-methods-use-this': 'off',
'no-shadow': 'off',
'no-underscore-dangle': 'off',
},
};
================================================
FILE: .github/workflows/ci.yml
================================================
name: 'ci'
on: [push, pull_request]
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: bahmutov/npm-install@v1
- name: Run lint
run: yarn lint
style:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: bahmutov/npm-install@v1
- name: Run code style lint
run: yarn style
test:
runs-on: ubuntu-latest
strategy:
matrix:
node: ['12', '14', '16']
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node }}
- uses: bahmutov/npm-install@v1
- name: Run unit tests
run: yarn test
test-types:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: bahmutov/npm-install@v1
- name: Run type declaration tests
run: yarn test:types
================================================
FILE: .gitignore
================================================
# Logs
logs
*.log
npm-debug.log*
lerna-debug.log
# Build directories
build
# Runtime data
pids
*.pid
*.seed
*.pid.lock
# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov
# Coverage directory used by tools like istanbul
coverage
# nyc test coverage
.nyc_output
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt
# node-waf configuration
.lock-wscript
# Dependency directories
node_modules
jspm_packages
# Optional npm cache directory
.npm
# Optional eslint cache
.eslintcache
# Optional REPL history
.node_repl_history
# Webstorm project metadata
.idea
================================================
FILE: .prettierignore
================================================
# Since autogenerated file
CHANGELOG.md
# Since it formats the inline code blocks, worsening readability
README.md
================================================
FILE: .prettierrc.js
================================================
module.exports = {
singleQuote: true,
trailingComma: 'all',
};
================================================
FILE: CHANGELOG.md
================================================
### Changelog
All notable changes to this project will be documented in this file. Dates are displayed in UTC.
Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
#### [v6.5.1](https://github.com/neutrinojs/webpack-chain/compare/v6.5.0...v6.5.1)
> 25 July 2020
- Improve error message when .tap() used on an undefined plugin [`#271`](https://github.com/neutrinojs/webpack-chain/pull/271)
- Improve error message when .use() not called for a Plugin [`#270`](https://github.com/neutrinojs/webpack-chain/pull/270)
- Clean up linting configuration [`#268`](https://github.com/neutrinojs/webpack-chain/pull/268)
- Remove unused dev-dependency @types/node [`#269`](https://github.com/neutrinojs/webpack-chain/pull/269)
- Lock file maintenance [`#259`](https://github.com/neutrinojs/webpack-chain/pull/259)
- Travis: Test against Node 14 [`#267`](https://github.com/neutrinojs/webpack-chain/pull/267)
- Improve error message when .tap() used on an undefined plugin (#271) [`#125`](https://github.com/neutrinojs/webpack-chain/issues/125)
#### [v6.5.0](https://github.com/neutrinojs/webpack-chain/compare/v6.4.0...v6.5.0)
> 1 July 2020
- Add rule.resolve [`#265`](https://github.com/neutrinojs/webpack-chain/pull/265)
- Update dependency eslint to v7 [`#263`](https://github.com/neutrinojs/webpack-chain/pull/263)
- Switch from Ava to Jest [`#258`](https://github.com/neutrinojs/webpack-chain/pull/258)
- Update dependency prettier to v2 [`#250`](https://github.com/neutrinojs/webpack-chain/pull/250)
- Update dependency auto-changelog to v2 [`#257`](https://github.com/neutrinojs/webpack-chain/pull/257)
- Lock file maintenance [`#244`](https://github.com/neutrinojs/webpack-chain/pull/244)
- Test against Node 13 [`#254`](https://github.com/neutrinojs/webpack-chain/pull/254)
- Switch to a newer Travis base image [`#253`](https://github.com/neutrinojs/webpack-chain/pull/253)
#### [v6.4.0](https://github.com/neutrinojs/webpack-chain/compare/v6.3.1...v6.4.0)
> 3 February 2020
- Fix Rule.merge() when include or exclude are strings [`#243`](https://github.com/neutrinojs/webpack-chain/pull/243)
- Add Types to Plugin Arguments [`#241`](https://github.com/neutrinojs/webpack-chain/pull/241)
- Add devServer shorthands for sockHost, sockPort, sockPath [`#238`](https://github.com/neutrinojs/webpack-chain/pull/238)
- Add `devtoolNamespace` TypeScript declaration [`#232`](https://github.com/neutrinojs/webpack-chain/pull/232)
- Fix Rule.merge() when include or exclude are strings (#243) [`#228`](https://github.com/neutrinojs/webpack-chain/issues/228)
- Add devServer shorthands for sockHost, sockPort, sockPath (#238) [`#231`](https://github.com/neutrinojs/webpack-chain/issues/231)
#### [v6.3.1](https://github.com/neutrinojs/webpack-chain/compare/v6.3.0...v6.3.1)
> 28 January 2020
- Lock file maintenance [`#217`](https://github.com/neutrinojs/webpack-chain/pull/217)
- docs: Emphasise that merge() doesn't accept webpack config objects [`#225`](https://github.com/neutrinojs/webpack-chain/pull/225)
- Update types and documentation for DevServer [`#233`](https://github.com/neutrinojs/webpack-chain/pull/233)
- Validate that Plugin 'args' is an array [`#229`](https://github.com/neutrinojs/webpack-chain/pull/229)
- Improve error message when legacy minimizer syntax used [`#226`](https://github.com/neutrinojs/webpack-chain/pull/226)
- Add missing engines definition to package.json [`#227`](https://github.com/neutrinojs/webpack-chain/pull/227)
- docs: Correct the .merge() example for optimization.minimizer [`#224`](https://github.com/neutrinojs/webpack-chain/pull/224)
- docs: Fix formatting typos in README [`#223`](https://github.com/neutrinojs/webpack-chain/pull/223)
- Validate that Plugin 'args' is an array (#229) [`#121`](https://github.com/neutrinojs/webpack-chain/issues/121)
#### [v6.3.0](https://github.com/neutrinojs/webpack-chain/compare/v6.2.0...v6.3.0)
> 22 December 2019
- Add support for nested rules (rule.rules) [`#220`](https://github.com/neutrinojs/webpack-chain/pull/220)
- Fix missing type TypedChainedMap.getOrCompute [`#221`](https://github.com/neutrinojs/webpack-chain/pull/221)
- fix: fix type definition for Rule#oneOf [`#218`](https://github.com/neutrinojs/webpack-chain/pull/218)
- fix: fix type definition for Rule#oneOf (#218) [`#216`](https://github.com/neutrinojs/webpack-chain/issues/216)
#### [v6.2.0](https://github.com/neutrinojs/webpack-chain/compare/v6.1.0...v6.2.0)
> 22 December 2019
- Add support for module.strictExportPresence and output.futureEmitAssets [`#207`](https://github.com/neutrinojs/webpack-chain/pull/207)
- Add support for module.strictExportPresence and output.futureEmitAssets (#207) [`#205`](https://github.com/neutrinojs/webpack-chain/issues/205) [`#206`](https://github.com/neutrinojs/webpack-chain/issues/206)
#### [v6.1.0](https://github.com/neutrinojs/webpack-chain/compare/v6.0.0...v6.1.0)
> 13 December 2019
- README: Update Travis badge to point to travis-ci.com [`#215`](https://github.com/neutrinojs/webpack-chain/pull/215)
- Lock file maintenance [`#199`](https://github.com/neutrinojs/webpack-chain/pull/199)
- Fix types for Config.resolve plugins and improve Plugin types [`#213`](https://github.com/neutrinojs/webpack-chain/pull/213)
- Update dependency eslint-plugin-ava to v9 [`#203`](https://github.com/neutrinojs/webpack-chain/pull/203)
- Add Chinese docs link to README [`#136`](https://github.com/neutrinojs/webpack-chain/pull/136)
- Lock file maintenance [`#196`](https://github.com/neutrinojs/webpack-chain/pull/196)
- Update dependency eslint to v6 [`#186`](https://github.com/neutrinojs/webpack-chain/pull/186)
- Update dependency eslint-config-airbnb-base to v14 [`#192`](https://github.com/neutrinojs/webpack-chain/pull/192)
- Lock file maintenance [`#184`](https://github.com/neutrinojs/webpack-chain/pull/184)
- Update dependency eslint-config-prettier to v6 [`#187`](https://github.com/neutrinojs/webpack-chain/pull/187)
- Lock file maintenance [`#180`](https://github.com/neutrinojs/webpack-chain/pull/180)
- Update dependency eslint-plugin-ava to v7 [`#178`](https://github.com/neutrinojs/webpack-chain/pull/178)
- Lock file maintenance [`#177`](https://github.com/neutrinojs/webpack-chain/pull/177)
- Lock file maintenance [`#176`](https://github.com/neutrinojs/webpack-chain/pull/176)
- Lock file maintenance [`#174`](https://github.com/neutrinojs/webpack-chain/pull/174)
- feat: rule test supports function [`#172`](https://github.com/neutrinojs/webpack-chain/pull/172)
- Lock file maintenance [`#170`](https://github.com/neutrinojs/webpack-chain/pull/170)
### [v6.0.0](https://github.com/neutrinojs/webpack-chain/compare/v5.2.4...v6.0.0)
> 3 May 2019
- Lock file maintenance [`#169`](https://github.com/neutrinojs/webpack-chain/pull/169)
- Update linting configuration, support Node.js 12 in CI [`#168`](https://github.com/neutrinojs/webpack-chain/pull/168)
- Extended DevServer method [`#167`](https://github.com/neutrinojs/webpack-chain/pull/167)
- Lock file maintenance [`#165`](https://github.com/neutrinojs/webpack-chain/pull/165)
- Update dependency eslint-plugin-ava to v6 [`#161`](https://github.com/neutrinojs/webpack-chain/pull/161)
- Point docs to v6 [`37201a2`](https://github.com/neutrinojs/webpack-chain/commit/37201a2974c078c3494243ff03342ba16910db21)
#### [v5.2.4](https://github.com/neutrinojs/webpack-chain/compare/v5.2.3...v5.2.4)
> 25 March 2019
- fix Use#end return type in OneOf [`#158`](https://github.com/neutrinojs/webpack-chain/pull/158)
- make __expression property works in any object [`#157`](https://github.com/neutrinojs/webpack-chain/pull/157)
- Lock file maintenance [`#160`](https://github.com/neutrinojs/webpack-chain/pull/160)
- docs: Fix typo in config.optimization example [`#159`](https://github.com/neutrinojs/webpack-chain/pull/159)
#### [v5.2.3](https://github.com/neutrinojs/webpack-chain/compare/v5.2.2...v5.2.3)
> 22 March 2019
- optimize type definitions [`#156`](https://github.com/neutrinojs/webpack-chain/pull/156)
- Lock file maintenance [`#155`](https://github.com/neutrinojs/webpack-chain/pull/155)
#### [v5.2.2](https://github.com/neutrinojs/webpack-chain/compare/v5.2.1...v5.2.2)
> 12 March 2019
- Fix README comment rendering [`#154`](https://github.com/neutrinojs/webpack-chain/pull/154)
- Lock file maintenance [`#153`](https://github.com/neutrinojs/webpack-chain/pull/153)
- Update dependency javascript-stringify to v2 [`#151`](https://github.com/neutrinojs/webpack-chain/pull/151)
- Fix stringify master bustage [`55f6a5d`](https://github.com/neutrinojs/webpack-chain/commit/55f6a5d25b58d03fbc57a17d8c2e09de310fa068)
#### [v5.2.1](https://github.com/neutrinojs/webpack-chain/compare/v5.2.0...v5.2.1)
> 7 March 2019
- Lock file maintenance [`#145`](https://github.com/neutrinojs/webpack-chain/pull/145)
- Add `config.output.globalObject` type [`#147`](https://github.com/neutrinojs/webpack-chain/pull/147)
- add module-rule-type [`#148`](https://github.com/neutrinojs/webpack-chain/pull/148)
- Update `config.mode` type [`#146`](https://github.com/neutrinojs/webpack-chain/pull/146)
- Update dependency eslint-config-prettier to v4 [`75aa60b`](https://github.com/neutrinojs/webpack-chain/commit/75aa60b760947cd8eb438691158dd9db52f4f9f5)
#### [v5.2.0](https://github.com/neutrinojs/webpack-chain/compare/v5.1.0...v5.2.0)
> 23 January 2019
- Add `config.name` type [`#143`](https://github.com/neutrinojs/webpack-chain/pull/143)
- Add TypeScript type definitions [`#132`](https://github.com/neutrinojs/webpack-chain/pull/132)
- docs: Fix typo of 'optimization' [`#139`](https://github.com/neutrinojs/webpack-chain/pull/139)
- Add TypeScript type definitions (#132) [`#62`](https://github.com/neutrinojs/webpack-chain/issues/62)
#### [v5.1.0](https://github.com/neutrinojs/webpack-chain/compare/v5.0.1...v5.1.0)
> 16 January 2019
- Support config.name() setter [`#131`](https://github.com/neutrinojs/webpack-chain/pull/131)
- Allow use of before() and after() with oneOf rules [`#133`](https://github.com/neutrinojs/webpack-chain/pull/133)
- Travis: Test against Node 11 [`#118`](https://github.com/neutrinojs/webpack-chain/pull/118)
- docs: Fix typo in devServer options [`#117`](https://github.com/neutrinojs/webpack-chain/pull/117)
- Allow use of before() and after() with oneOf rules (#133) [`#119`](https://github.com/neutrinojs/webpack-chain/issues/119)
- Update dependency ava to v1 [`ce9e884`](https://github.com/neutrinojs/webpack-chain/commit/ce9e884f988a01ac6297d167dfd013cab8d8c24a)
- Lock file maintenance [`d124b5d`](https://github.com/neutrinojs/webpack-chain/commit/d124b5df6648257092becae81ceece9bef5485b8)
#### [v5.0.1](https://github.com/neutrinojs/webpack-chain/compare/v5.0.0...v5.0.1)
> 22 October 2018
- Fix toString() output for alternative types of plugin [`#116`](https://github.com/neutrinojs/webpack-chain/pull/116)
- Fix toString() output for alternative types of plugin (#116) [`#115`](https://github.com/neutrinojs/webpack-chain/issues/115)
### [v5.0.0](https://github.com/neutrinojs/webpack-chain/compare/v4.12.1...v5.0.0)
> 8 October 2018
- README: Add NPM/Travis badges [`#112`](https://github.com/neutrinojs/webpack-chain/pull/112)
- Provide the same API for config.optimization.minimizer as config.plugins [`#84`](https://github.com/neutrinojs/webpack-chain/pull/84)
- README: Add NPM/Travis badges (#112) [`#110`](https://github.com/neutrinojs/webpack-chain/issues/110)
- Provide the same API for config.optimization.minimizer as config.plugins (#84) [`#95`](https://github.com/neutrinojs/webpack-chain/issues/95)
#### [v4.12.1](https://github.com/neutrinojs/webpack-chain/compare/v4.12.0...v4.12.1)
> 3 October 2018
- Switch from changelog to auto-changelog [`#109`](https://github.com/neutrinojs/webpack-chain/pull/109)
- Allow passing entry as a string to config.merge() [`#107`](https://github.com/neutrinojs/webpack-chain/pull/107)
- Lock file maintenance [`#101`](https://github.com/neutrinojs/webpack-chain/pull/101)
- Update dependency eslint-plugin-prettier to v3 [`e42d8bd`](https://github.com/neutrinojs/webpack-chain/commit/e42d8bd2f6f70841c4d1ab7a2926c26d3ec828ed)
#### [v4.12.0](https://github.com/neutrinojs/webpack-chain/compare/v4.11.0...v4.12.0)
> 3 October 2018
- merge resolve plugins just like config [`c47ee2d`](https://github.com/neutrinojs/webpack-chain/commit/c47ee2d52c1be4fcdbe10adef865e45d6fd729ef)
- linted [`dff82f8`](https://github.com/neutrinojs/webpack-chain/commit/dff82f8494394dcf8c97bff324f877513f44fa56)
- Revert changes to gitignore [`c1250a0`](https://github.com/neutrinojs/webpack-chain/commit/c1250a0fe7ffafa82f529ac8e7262e2c3cdd4729)
#### [v4.11.0](https://github.com/neutrinojs/webpack-chain/compare/v4.10.0...v4.11.0)
> 13 September 2018
- Support specifying plugins by path [`#102`](https://github.com/neutrinojs/webpack-chain/pull/102)
- Lock file maintenance [`#100`](https://github.com/neutrinojs/webpack-chain/pull/100)
- Lock file maintenance [`#96`](https://github.com/neutrinojs/webpack-chain/pull/96)
#### [v4.10.0](https://github.com/neutrinojs/webpack-chain/compare/v4.9.0...v4.10.0)
> 6 September 2018
- Use the Resolve API to define ResolveLoader according to webpack [`#99`](https://github.com/neutrinojs/webpack-chain/pull/99)
- Migrate to new org [`#92`](https://github.com/neutrinojs/webpack-chain/pull/92)
- test: 'clean' in 'ChainedMap' [`#93`](https://github.com/neutrinojs/webpack-chain/pull/93)
- Lock file maintenance [`3a4b3e1`](https://github.com/neutrinojs/webpack-chain/commit/3a4b3e10032856ab7f01afa67a23dd9e4e68161a)
- Lock file maintenance [`815bfd1`](https://github.com/neutrinojs/webpack-chain/commit/815bfd173a2dc6f802b66a48cdb2c4d2ff47df9f)
#### [v4.9.0](https://github.com/neutrinojs/webpack-chain/compare/v4.8.0...v4.9.0)
> 15 August 2018
- Update to ESLint 5 [`#89`](https://github.com/neutrinojs/webpack-chain/pull/89)
- Lock file maintenance [`#85`](https://github.com/neutrinojs/webpack-chain/pull/85)
- Implement ChainedMap.getOrCompute [`#63`](https://github.com/neutrinojs/webpack-chain/pull/63)
- Support Object literal plugin usage [`#86`](https://github.com/neutrinojs/webpack-chain/pull/86)
- Lock file maintenance [`#61`](https://github.com/neutrinojs/webpack-chain/pull/61)
- Lock file maintenance [`#60`](https://github.com/neutrinojs/webpack-chain/pull/60)
- Update to ESLint 5 (#89) [`#69`](https://github.com/neutrinojs/webpack-chain/issues/69) [`#77`](https://github.com/neutrinojs/webpack-chain/issues/77) [`#87`](https://github.com/neutrinojs/webpack-chain/issues/87) [`#88`](https://github.com/neutrinojs/webpack-chain/issues/88)
- Update dependency eslint-config-airbnb-base to v13 [`7370962`](https://github.com/neutrinojs/webpack-chain/commit/73709628a6ff6661e478c652d0ff03b99b6c2abb)
- Fix linting :/ [`30cc11d`](https://github.com/neutrinojs/webpack-chain/commit/30cc11d0d35a5676069a623b180c8e7b00e099e4)
- Fix README bug, test in Node.js v6 [`4a37c74`](https://github.com/neutrinojs/webpack-chain/commit/4a37c74e1f790e118034154da9c32d0e36164f74)
- Run yarn lint --fix [`9384537`](https://github.com/neutrinojs/webpack-chain/commit/9384537269d60bb80b3330cf44ddbdd9d528c454)
#### [v4.8.0](https://github.com/neutrinojs/webpack-chain/compare/v4.7.0...v4.8.0)
> 16 May 2018
- Expose toString as a static method on Config [`#57`](https://github.com/neutrinojs/webpack-chain/pull/57)
- Add test for Config.toString, add README note [`0107aef`](https://github.com/neutrinojs/webpack-chain/commit/0107aef203202aef069190723b04ec4f6ac80b9f)
#### [v4.7.0](https://github.com/neutrinojs/webpack-chain/compare/v4.6.0...v4.7.0)
> 15 May 2018
- Lint with eslint, prettier, airbnb [`#52`](https://github.com/neutrinojs/webpack-chain/pull/52)
- Support Config.toString() with name hints [`#53`](https://github.com/neutrinojs/webpack-chain/pull/53)
- Configure Renovate [`#54`](https://github.com/neutrinojs/webpack-chain/pull/54)
- Lock file maintenance [`50d4db8`](https://github.com/neutrinojs/webpack-chain/commit/50d4db81ab5fe62a55435720f5c78ddc40309a88)
#### [v4.6.0](https://github.com/neutrinojs/webpack-chain/compare/v4.5.0...v4.6.0)
> 16 April 2018
- Support Webpack 4.x [`#51`](https://github.com/neutrinojs/webpack-chain/pull/51)
- Update devDependencies [`#50`](https://github.com/neutrinojs/webpack-chain/pull/50)
#### [v4.5.0](https://github.com/neutrinojs/webpack-chain/compare/v4.4.2...v4.5.0)
> 22 November 2017
- Introduce method for performing a batch of operations against a context [`#43`](https://github.com/neutrinojs/webpack-chain/pull/43)
#### [v4.4.2](https://github.com/neutrinojs/webpack-chain/compare/v4.4.1...v4.4.2)
> 10 October 2017
- Update changelog [`1bb3da1`](https://github.com/neutrinojs/webpack-chain/commit/1bb3da1fec04a158f68762e57aff33a0172a298f)
- Hotfix - guard against non-defined entries when ordering chainedmap [`76be81f`](https://github.com/neutrinojs/webpack-chain/commit/76be81f4509b9652bef25cc55747df87850b858e)
- Updating changelog [`a71fc4b`](https://github.com/neutrinojs/webpack-chain/commit/a71fc4b70ccce358aacc29ed7dc5d8cdacdd4cc1)
#### [v4.4.1](https://github.com/neutrinojs/webpack-chain/compare/v4.4.0...v4.4.1)
> 6 October 2017
- Updating changelog [`97a2fab`](https://github.com/neutrinojs/webpack-chain/commit/97a2fabf6e51f1b03cacb0991ba02e236be983fa)
- Missing schema before/after [`8d8f26d`](https://github.com/neutrinojs/webpack-chain/commit/8d8f26dd0e6db375dbabb8e8dfe784e6c50408d5)
#### [v4.4.0](https://github.com/neutrinojs/webpack-chain/compare/v4.3.0...v4.4.0)
> 6 October 2017
- Feature: allow specifying to use before or after other use [`#42`](https://github.com/neutrinojs/webpack-chain/pull/42)
- Docs: Upstream fixes made to Neutrino's webpack-chain docs [`#41`](https://github.com/neutrinojs/webpack-chain/pull/41)
- Improve documentation for plugin configuration [`#40`](https://github.com/neutrinojs/webpack-chain/pull/40)
- Allow omitting keys from source merge object [`fb6ea2f`](https://github.com/neutrinojs/webpack-chain/commit/fb6ea2fad931c13e7516a3e9354215a78cb5c4ff)
- Feature: allow specifying .before or .after to order plugins and uses [`b0040bf`](https://github.com/neutrinojs/webpack-chain/commit/b0040bff73b3b9e55d53192ac4a447a2ac8c02d1)
- Rename when arguments to be clearer [`d15e895`](https://github.com/neutrinojs/webpack-chain/commit/d15e895669ce0a44c704755af39290700e73e85f)
- Bumping deps [`c15be4a`](https://github.com/neutrinojs/webpack-chain/commit/c15be4ab99d232126bbf18666f4f20f80df21f90)
- Update changelog [`5aec63a`](https://github.com/neutrinojs/webpack-chain/commit/5aec63a424c71a9a603540b33e576999c839f074)
#### [v4.3.0](https://github.com/neutrinojs/webpack-chain/compare/v4.2.0...v4.3.0)
> 13 September 2017
- Update API for base config, dev server, and output [`#38`](https://github.com/neutrinojs/webpack-chain/pull/38)
- Update changelog [`6260f49`](https://github.com/neutrinojs/webpack-chain/commit/6260f49edbcab301988b7b2c6c8a77e07707c010)
#### [v4.2.0](https://github.com/neutrinojs/webpack-chain/compare/v4.1.0...v4.2.0)
> 13 September 2017
- Add new shorthands from resolve and output [`#37`](https://github.com/neutrinojs/webpack-chain/pull/37)
- changelog [`0374e51`](https://github.com/neutrinojs/webpack-chain/commit/0374e518a4b465c73b5097eff6e4c77768319e4f)
- Updating README with shorthands [`ae5e75a`](https://github.com/neutrinojs/webpack-chain/commit/ae5e75ae619d0399bcbf8e588a48759b0e590b6e)
#### [v4.1.0](https://github.com/neutrinojs/webpack-chain/compare/v4.0.0...v4.1.0)
> 12 September 2017
- Updating rule definition shortcuts, adding oneOf [`#36`](https://github.com/neutrinojs/webpack-chain/pull/36)
### [v4.0.0](https://github.com/neutrinojs/webpack-chain/compare/v3.3.0...v4.0.0)
> 3 October 2018
- Switch noParse to getter/setter to allow webpack v3 function argument [`#32`](https://github.com/neutrinojs/webpack-chain/pull/32)
- Serialize performance into config output [`#31`](https://github.com/neutrinojs/webpack-chain/pull/31)
- Release v4.0.0 [`e84b002`](https://github.com/neutrinojs/webpack-chain/commit/e84b00207f6d4f4dc37c43ffffc65d8a34f63a75)
#### [v3.3.0](https://github.com/neutrinojs/webpack-chain/compare/v3.2.0...v3.3.0)
> 3 October 2018
- Adding noParse on module [`#27`](https://github.com/neutrinojs/webpack-chain/pull/27)
- Releasing v3.3.0 [`4a59bef`](https://github.com/neutrinojs/webpack-chain/commit/4a59bef687f273503945e638fefe1f6ab29857d1)
#### [v3.2.0](https://github.com/neutrinojs/webpack-chain/compare/v3.1.0...v3.2.0)
> 3 October 2018
- Adding updated shorthand methods for devServer [`#23`](https://github.com/neutrinojs/webpack-chain/pull/23)
#### [v3.1.0](https://github.com/neutrinojs/webpack-chain/compare/v3.0.0...v3.1.0)
> 3 October 2018
- Allow conditional configuration via when [`#22`](https://github.com/neutrinojs/webpack-chain/pull/22)
- Update README with links to previous docs versions [`0dc3984`](https://github.com/neutrinojs/webpack-chain/commit/0dc39841b76c5e4d9493fa86d7f65e66145a6964)
- Update README with links to previous docs versions [`bcc2362`](https://github.com/neutrinojs/webpack-chain/commit/bcc2362d396cee736feaa5e4537150b4a1fa2d4a)
### [v3.0.0](https://github.com/neutrinojs/webpack-chain/compare/v2.0.1...v3.0.0)
> 3 October 2018
- Make rule.include, rule.exclude, loaders and plugins more extensible [`#16`](https://github.com/neutrinojs/webpack-chain/pull/16)
#### [v2.0.1](https://github.com/neutrinojs/webpack-chain/compare/v2.0.0...v2.0.1)
> 3 October 2018
- undefined plugin [`#17`](https://github.com/neutrinojs/webpack-chain/pull/17)
### [v2.0.0](https://github.com/neutrinojs/webpack-chain/compare/v1.4.3...v2.0.0)
> 3 October 2018
- Adding testing, which informed v2 API, updated docs to reflect [`#14`](https://github.com/neutrinojs/webpack-chain/pull/14)
- Make Plugin API consistent with Loader API [`#13`](https://github.com/neutrinojs/webpack-chain/pull/13)
- MPL license, moving to mozilla-neutrino [`f122edd`](https://github.com/neutrinojs/webpack-chain/commit/f122eddccb9f7af9742f5c447c651172700b4c50)
#### [v1.4.3](https://github.com/neutrinojs/webpack-chain/compare/v1.4.2...v1.4.3)
> 6 March 2017
- Adding ChainedMap and ChainedSet documentation [`b071f82`](https://github.com/neutrinojs/webpack-chain/commit/b071f82042c7806f6d2df412a0154c1b985c4763)
- Removing empty entities from cluttering configuration object [`b428e55`](https://github.com/neutrinojs/webpack-chain/commit/b428e55a671a033c133ba2e225796845307dee12)
- Docs: getConfig -> toConfig [`2468eaa`](https://github.com/neutrinojs/webpack-chain/commit/2468eaac7e4c2f74cae244a4af6d2a517483db7b)
#### [v1.4.2](https://github.com/neutrinojs/webpack-chain/compare/v1.4.1...v1.4.2)
> 3 October 2018
- Fix bug where `exclude` doesn't return `this` [`#7`](https://github.com/neutrinojs/webpack-chain/pull/7)
- Bumping to v1.4.2 [`38d1412`](https://github.com/neutrinojs/webpack-chain/commit/38d1412037780b815c537de2abd5f02443b80502)
#### [v1.4.1](https://github.com/neutrinojs/webpack-chain/compare/v1.4.0...v1.4.1)
> 3 October 2018
- Allowing config merge to append to existing rule loaders [`#3`](https://github.com/neutrinojs/webpack-chain/pull/3)
- docs(readme): fix typo in devtool option [`#1`](https://github.com/neutrinojs/webpack-chain/pull/1)
#### [v1.4.0](https://github.com/neutrinojs/webpack-chain/compare/v1.3.0...v1.4.0)
> 3 October 2018
- Adds rule test merge via string to regex, fixes externals not chainable [`a15b49e`](https://github.com/neutrinojs/webpack-chain/commit/a15b49ec28903708c04665d0c6cac3a956558a99)
#### [v1.3.0](https://github.com/neutrinojs/webpack-chain/compare/v1.2.0...v1.3.0)
> 3 October 2018
- Adding functionality for merging and object into a Config instance [`5f0b0c6`](https://github.com/neutrinojs/webpack-chain/commit/5f0b0c670e6ad946e0232a208abb667f749aeba4)
#### [v1.2.0](https://github.com/neutrinojs/webpack-chain/compare/v1.1.0...v1.2.0)
> 3 October 2018
- Adds hot flag for Config.DevServer [`c64a155`](https://github.com/neutrinojs/webpack-chain/commit/c64a1558188ab2a4982a7b3f2aba95ced50c9756)
#### [v1.1.0](https://github.com/neutrinojs/webpack-chain/compare/v1.0.3...v1.1.0)
> 3 October 2018
- Adding ChainedSet#prepend functionality [`cc86e7b`](https://github.com/neutrinojs/webpack-chain/commit/cc86e7bdbdcaca7610255039dcb31adfacb4952b)
#### [v1.0.3](https://github.com/neutrinojs/webpack-chain/compare/v1.0.2...v1.0.3)
> 3 October 2018
- Fixes exception with empty rule entries with loader only [`7964b34`](https://github.com/neutrinojs/webpack-chain/commit/7964b347ed613c7dc18e54f912467abad2956b8b)
#### [v1.0.2](https://github.com/neutrinojs/webpack-chain/compare/v1.0.1...v1.0.2)
> 3 October 2018
- Fixes plugin methods not chaining [`7cc56ed`](https://github.com/neutrinojs/webpack-chain/commit/7cc56ed5e331c7cc0ccd58f25feb3b1b0398829a)
#### [v1.0.1](https://github.com/neutrinojs/webpack-chain/compare/v1.0.0...v1.0.1)
> 3 October 2018
- Shared configuration documentation [`5c6a65b`](https://github.com/neutrinojs/webpack-chain/commit/5c6a65b344113ff3522d5f7d66dfacbc0ad7fa69)
- Avoid exceptions in empty config [`ab46ee0`](https://github.com/neutrinojs/webpack-chain/commit/ab46ee0234a04eb2b89190df32ea4287c499dd39)
#### v1.0.0
> 3 October 2018
- initial commit [`9e2a87c`](https://github.com/neutrinojs/webpack-chain/commit/9e2a87c5f6a1f1aac3eedbd4102e40dc47a8f7f4)
================================================
FILE: LICENSE
================================================
Mozilla Public License Version 2.0
==================================
1. Definitions
--------------
1.1. "Contributor"
means each individual or legal entity that creates, contributes to
the creation of, or owns Covered Software.
1.2. "Contributor Version"
means the combination of the Contributions of others (if any) used
by a Contributor and that particular Contributor's Contribution.
1.3. "Contribution"
means Covered Software of a particular Contributor.
1.4. "Covered Software"
means Source Code Form to which the initial Contributor has attached
the notice in Exhibit A, the Executable Form of such Source Code
Form, and Modifications of such Source Code Form, in each case
including portions thereof.
1.5. "Incompatible With Secondary Licenses"
means
(a) that the initial Contributor has attached the notice described
in Exhibit B to the Covered Software; or
(b) that the Covered Software was made available under the terms of
version 1.1 or earlier of the License, but not also under the
terms of a Secondary License.
1.6. "Executable Form"
means any form of the work other than Source Code Form.
1.7. "Larger Work"
means a work that combines Covered Software with other material, in
a separate file or files, that is not Covered Software.
1.8. "License"
means this document.
1.9. "Licensable"
means having the right to grant, to the maximum extent possible,
whether at the time of the initial grant or subsequently, any and
all of the rights conveyed by this License.
1.10. "Modifications"
means any of the following:
(a) any file in Source Code Form that results from an addition to,
deletion from, or modification of the contents of Covered
Software; or
(b) any new file in Source Code Form that contains any Covered
Software.
1.11. "Patent Claims" of a Contributor
means any patent claim(s), including without limitation, method,
process, and apparatus claims, in any patent Licensable by such
Contributor that would be infringed, but for the grant of the
License, by the making, using, selling, offering for sale, having
made, import, or transfer of either its Contributions or its
Contributor Version.
1.12. "Secondary License"
means either the GNU General Public License, Version 2.0, the GNU
Lesser General Public License, Version 2.1, the GNU Affero General
Public License, Version 3.0, or any later versions of those
licenses.
1.13. "Source Code Form"
means the form of the work preferred for making modifications.
1.14. "You" (or "Your")
means an individual or a legal entity exercising rights under this
License. For legal entities, "You" includes any entity that
controls, is controlled by, or is under common control with You. For
purposes of this definition, "control" means (a) the power, direct
or indirect, to cause the direction or management of such entity,
whether by contract or otherwise, or (b) ownership of more than
fifty percent (50%) of the outstanding shares or beneficial
ownership of such entity.
2. License Grants and Conditions
--------------------------------
2.1. Grants
Each Contributor hereby grants You a world-wide, royalty-free,
non-exclusive license:
(a) under intellectual property rights (other than patent or trademark)
Licensable by such Contributor to use, reproduce, make available,
modify, display, perform, distribute, and otherwise exploit its
Contributions, either on an unmodified basis, with Modifications, or
as part of a Larger Work; and
(b) under Patent Claims of such Contributor to make, use, sell, offer
for sale, have made, import, and otherwise transfer either its
Contributions or its Contributor Version.
2.2. Effective Date
The licenses granted in Section 2.1 with respect to any Contribution
become effective for each Contribution on the date the Contributor first
distributes such Contribution.
2.3. Limitations on Grant Scope
The licenses granted in this Section 2 are the only rights granted under
this License. No additional rights or licenses will be implied from the
distribution or licensing of Covered Software under this License.
Notwithstanding Section 2.1(b) above, no patent license is granted by a
Contributor:
(a) for any code that a Contributor has removed from Covered Software;
or
(b) for infringements caused by: (i) Your and any other third party's
modifications of Covered Software, or (ii) the combination of its
Contributions with other software (except as part of its Contributor
Version); or
(c) under Patent Claims infringed by Covered Software in the absence of
its Contributions.
This License does not grant any rights in the trademarks, service marks,
or logos of any Contributor (except as may be necessary to comply with
the notice requirements in Section 3.4).
2.4. Subsequent Licenses
No Contributor makes additional grants as a result of Your choice to
distribute the Covered Software under a subsequent version of this
License (see Section 10.2) or under the terms of a Secondary License (if
permitted under the terms of Section 3.3).
2.5. Representation
Each Contributor represents that the Contributor believes its
Contributions are its original creation(s) or it has sufficient rights
to grant the rights to its Contributions conveyed by this License.
2.6. Fair Use
This License is not intended to limit any rights You have under
applicable copyright doctrines of fair use, fair dealing, or other
equivalents.
2.7. Conditions
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
in Section 2.1.
3. Responsibilities
-------------------
3.1. Distribution of Source Form
All distribution of Covered Software in Source Code Form, including any
Modifications that You create or to which You contribute, must be under
the terms of this License. You must inform recipients that the Source
Code Form of the Covered Software is governed by the terms of this
License, and how they can obtain a copy of this License. You may not
attempt to alter or restrict the recipients' rights in the Source Code
Form.
3.2. Distribution of Executable Form
If You distribute Covered Software in Executable Form then:
(a) such Covered Software must also be made available in Source Code
Form, as described in Section 3.1, and You must inform recipients of
the Executable Form how they can obtain a copy of such Source Code
Form by reasonable means in a timely manner, at a charge no more
than the cost of distribution to the recipient; and
(b) You may distribute such Executable Form under the terms of this
License, or sublicense it under different terms, provided that the
license for the Executable Form does not attempt to limit or alter
the recipients' rights in the Source Code Form under this License.
3.3. Distribution of a Larger Work
You may create and distribute a Larger Work under terms of Your choice,
provided that You also comply with the requirements of this License for
the Covered Software. If the Larger Work is a combination of Covered
Software with a work governed by one or more Secondary Licenses, and the
Covered Software is not Incompatible With Secondary Licenses, this
License permits You to additionally distribute such Covered Software
under the terms of such Secondary License(s), so that the recipient of
the Larger Work may, at their option, further distribute the Covered
Software under the terms of either this License or such Secondary
License(s).
3.4. Notices
You may not remove or alter the substance of any license notices
(including copyright notices, patent notices, disclaimers of warranty,
or limitations of liability) contained within the Source Code Form of
the Covered Software, except that You may alter any license notices to
the extent required to remedy known factual inaccuracies.
3.5. Application of Additional Terms
You may choose to offer, and to charge a fee for, warranty, support,
indemnity or liability obligations to one or more recipients of Covered
Software. However, You may do so only on Your own behalf, and not on
behalf of any Contributor. You must make it absolutely clear that any
such warranty, support, indemnity, or liability obligation is offered by
You alone, and You hereby agree to indemnify every Contributor for any
liability incurred by such Contributor as a result of warranty, support,
indemnity or liability terms You offer. You may include additional
disclaimers of warranty and limitations of liability specific to any
jurisdiction.
4. Inability to Comply Due to Statute or Regulation
---------------------------------------------------
If it is impossible for You to comply with any of the terms of this
License with respect to some or all of the Covered Software due to
statute, judicial order, or regulation then You must: (a) comply with
the terms of this License to the maximum extent possible; and (b)
describe the limitations and the code they affect. Such description must
be placed in a text file included with all distributions of the Covered
Software under this License. Except to the extent prohibited by statute
or regulation, such description must be sufficiently detailed for a
recipient of ordinary skill to be able to understand it.
5. Termination
--------------
5.1. The rights granted under this License will terminate automatically
if You fail to comply with any of its terms. However, if You become
compliant, then the rights granted under this License from a particular
Contributor are reinstated (a) provisionally, unless and until such
Contributor explicitly and finally terminates Your grants, and (b) on an
ongoing basis, if such Contributor fails to notify You of the
non-compliance by some reasonable means prior to 60 days after You have
come back into compliance. Moreover, Your grants from a particular
Contributor are reinstated on an ongoing basis if such Contributor
notifies You of the non-compliance by some reasonable means, this is the
first time You have received notice of non-compliance with this License
from such Contributor, and You become compliant prior to 30 days after
Your receipt of the notice.
5.2. If You initiate litigation against any entity by asserting a patent
infringement claim (excluding declaratory judgment actions,
counter-claims, and cross-claims) alleging that a Contributor Version
directly or indirectly infringes any patent, then the rights granted to
You by any and all Contributors for the Covered Software under Section
2.1 of this License shall terminate.
5.3. In the event of termination under Sections 5.1 or 5.2 above, all
end user license agreements (excluding distributors and resellers) which
have been validly granted by You or Your distributors under this License
prior to termination shall survive termination.
************************************************************************
* *
* 6. Disclaimer of Warranty *
* ------------------------- *
* *
* Covered Software is provided under this License on an "as is" *
* basis, without warranty of any kind, either expressed, implied, or *
* statutory, including, without limitation, warranties that the *
* Covered Software is free of defects, merchantable, fit for a *
* particular purpose or non-infringing. The entire risk as to the *
* quality and performance of the Covered Software is with You. *
* Should any Covered Software prove defective in any respect, You *
* (not any Contributor) assume the cost of any necessary servicing, *
* repair, or correction. This disclaimer of warranty constitutes an *
* essential part of this License. No use of any Covered Software is *
* authorized under this License except under this disclaimer. *
* *
************************************************************************
************************************************************************
* *
* 7. Limitation of Liability *
* -------------------------- *
* *
* Under no circumstances and under no legal theory, whether tort *
* (including negligence), contract, or otherwise, shall any *
* Contributor, or anyone who distributes Covered Software as *
* permitted above, be liable to You for any direct, indirect, *
* special, incidental, or consequential damages of any character *
* including, without limitation, damages for lost profits, loss of *
* goodwill, work stoppage, computer failure or malfunction, or any *
* and all other commercial damages or losses, even if such party *
* shall have been informed of the possibility of such damages. This *
* limitation of liability shall not apply to liability for death or *
* personal injury resulting from such party's negligence to the *
* extent applicable law prohibits such limitation. Some *
* jurisdictions do not allow the exclusion or limitation of *
* incidental or consequential damages, so this exclusion and *
* limitation may not apply to You. *
* *
************************************************************************
8. Litigation
-------------
Any litigation relating to this License may be brought only in the
courts of a jurisdiction where the defendant maintains its principal
place of business and such litigation shall be governed by laws of that
jurisdiction, without reference to its conflict-of-law provisions.
Nothing in this Section shall prevent a party's ability to bring
cross-claims or counter-claims.
9. Miscellaneous
----------------
This License represents the complete agreement concerning the subject
matter hereof. If any provision of this License is held to be
unenforceable, such provision shall be reformed only to the extent
necessary to make it enforceable. Any law or regulation which provides
that the language of a contract shall be construed against the drafter
shall not be used to construe this License against a Contributor.
10. Versions of the License
---------------------------
10.1. New Versions
Mozilla Foundation is the license steward. Except as provided in Section
10.3, no one other than the license steward has the right to modify or
publish new versions of this License. Each version will be given a
distinguishing version number.
10.2. Effect of New Versions
You may distribute the Covered Software under the terms of the version
of the License under which You originally received the Covered Software,
or under the terms of any subsequent version published by the license
steward.
10.3. Modified Versions
If you create software not governed by this License, and you want to
create a new license for such software, you may create and use a
modified version of this License if you rename the license and remove
any references to the name of the license steward (except to note that
such modified license differs from this License).
10.4. Distributing Source Code Form that is Incompatible With Secondary
Licenses
If You choose to distribute Source Code Form that is Incompatible With
Secondary Licenses under the terms of this version of the License, the
notice described in Exhibit B of this License must be attached.
Exhibit A - Source Code Form License Notice
-------------------------------------------
This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/.
If it is not possible or desirable to put the notice in a particular
file, then You may include the notice in a location (such as a LICENSE
file in a relevant directory) where a recipient would be likely to look
for such a notice.
You may add additional accurate notices of copyright ownership.
Exhibit B - "Incompatible With Secondary Licenses" Notice
---------------------------------------------------------
This Source Code Form is "Incompatible With Secondary Licenses", as
defined by the Mozilla Public License, v. 2.0.
================================================
FILE: README.md
================================================
# webpack-chain
[![NPM version][npm-image]][npm-url]
[![NPM downloads][npm-downloads]][npm-url]
[![CI Status][ci-image]][ci-url]
Use a chaining API to generate and simplify the modification of webpack 4 configurations.
This documentation corresponds to v7 of webpack-chain. For previous versions, see:
* [v6 docs](https://github.com/neutrinojs/webpack-chain/tree/v6)
* [v5 docs](https://github.com/neutrinojs/webpack-chain/tree/v5)
* [v4 docs](https://github.com/neutrinojs/webpack-chain/tree/v4)
* [v3 docs](https://github.com/neutrinojs/webpack-chain/tree/v3)
* [v2 docs](https://github.com/neutrinojs/webpack-chain/tree/v2)
* [v1 docs](https://github.com/neutrinojs/webpack-chain/tree/v1)
_Note: while webpack-chain is utilized extensively in Neutrino, this package is
completely standalone and can be used by any project._
**[Chinese docs(中文文档)](https://github.com/Yatoo2018/webpack-chain/tree/zh-cmn-Hans)**
## Introduction
webpack's core configuration is based on creating and modifying a
potentially unwieldy JavaScript object. While this is OK for configurations
on individual projects, trying to share these objects across projects and
make subsequent modifications gets messy, as you need to have a deep
understanding of the underlying object structure to make those changes.
`webpack-chain` attempts to improve this process by providing a chainable or
fluent API for creating and modifying webpack configurations. Key portions
of the API can be referenced by user-specified names, which helps to
standardize how to modify a configuration across projects.
This is easier explained through the examples following.
## Installation
`webpack-chain` requires Node.js 12 or higher. `webpack-chain` also only creates
configuration objects designed for use with webpack 4.
You may install this package using either Yarn or npm (choose one):
**Yarn**
```bash
yarn add --dev webpack-chain
```
**npm**
```bash
npm install --save-dev webpack-chain
```
## Getting Started
Once you have `webpack-chain` installed, you can start creating a
webpack configuration. For this guide, our example base configuration will
be `webpack.config.js` in the root of our project directory.
```js
// Require the webpack-chain module. This module exports a single
// constructor function for creating a configuration API.
const Config = require('webpack-chain');
// Instantiate the configuration with a new API
const config = new Config();
// Make configuration changes using the chain API.
// Every API call tracks a change to the stored configuration.
config
// Interact with entry points
.entry('index')
.add('src/index.js')
.end()
// Modify output settings
.output
.path('dist')
.filename('[name].bundle.js');
// Create named rules which can be modified later
config.module
.rule('lint')
.test(/\.js$/)
.pre()
.include
.add('src')
.end()
// Even create named uses (loaders)
.use('eslint')
.loader('eslint-loader')
.options({
rules: {
semi: 'off'
}
});
config.module
.rule('compile')
.test(/\.js$/)
.include
.add('src')
.add('test')
.end()
.use('babel')
.loader('babel-loader')
.options({
presets: [
['@babel/preset-env', { modules: false }]
]
});
// Create named plugins too!
config
.plugin('clean')
.use(CleanPlugin, [['dist'], { root: '/dir' }]);
// Export the completed configuration object to be consumed by webpack
module.exports = config.toConfig();
```
Having shared configurations is also simple. Just export the configuration
and call `.toConfig()` prior to passing to webpack.
```js
// webpack.core.js
const Config = require('webpack-chain');
const config = new Config();
// Make configuration shared across targets
// ...
module.exports = config;
// webpack.dev.js
const config = require('./webpack.core');
// Dev-specific configuration
// ...
module.exports = config.toConfig();
// webpack.prod.js
const config = require('./webpack.core');
// Production-specific configuration
// ...
module.exports = config.toConfig();
```
## ChainedMap
One of the core API interfaces in webpack-chain is a `ChainedMap`. A
`ChainedMap` operates similar to a JavaScript Map, with some conveniences for
chaining and generating configuration. If a property is marked as being a
`ChainedMap`, it will have an API and methods as described below:
**Unless stated otherwise, these methods will return the `ChainedMap`, allowing
you to chain these methods.**
```js
// Remove all entries from a Map.
clear()
```
```js
// Remove a single entry from a Map given its key.
// key: *
delete(key)
```
```js
// Fetch the value from a Map located at the corresponding key.
// key: *
// returns: value
get(key)
```
```js
// Fetch the value from a Map located at the corresponding key.
// If the key is missing, the key is set to the result of function fn.
// key: *
// fn: Function () -> value
// returns: value
getOrCompute(key, fn)
```
```js
// Set a value on the Map stored at the `key` location.
// key: *
// value: *
set(key, value)
```
```js
// Returns `true` or `false` based on whether a Map as has a value set at a
// particular key.
// key: *
// returns: Boolean
has(key)
```
```js
// Returns an array of all the values stored in the Map.
// returns: Array
values()
```
```js
// Returns an object of all the entries in the backing Map
// where the key is the object property, and the value
// corresponding to the key. Will return `undefined` if the backing
// Map is empty.
// This will order properties by their name if the value is
// a ChainedMap that used .before() or .after().
// returns: Object, undefined if empty
entries()
```
```js
// Provide an object which maps its properties and values
// into the backing Map as keys and values.
// You can also provide an array as the second argument
// for property names to omit from being merged.
// obj: Object
// omit: Optional Array
merge(obj, omit)
```
```js
// Execute a function against the current configuration context
// handler: Function -> ChainedMap
// A function which is given a single argument of the ChainedMap instance
batch(handler)
```
```js
// Conditionally execute a function to continue configuration
// condition: Boolean
// whenTruthy: Function -> ChainedMap
// invoked when condition is truthy, given a single argument of the ChainedMap instance
// whenFalsy: Optional Function -> ChainedMap
// invoked when condition is falsy, given a single argument of the ChainedMap instance
when(condition, whenTruthy, whenFalsy)
```
## ChainedSet
Another of the core API interfaces in webpack-chain is a `ChainedSet`. A
`ChainedSet` operates similar to a JavaScript Set, with some conveniences for
chaining and generating configuration. If a property is marked as being a
`ChainedSet`, it will have an API and methods as described below:
**Unless stated otherwise, these methods will return the `ChainedSet`, allowing
you to chain these methods.**
```js
// Add/append a value to the end of a Set.
// value: *
add(value)
```
```js
// Add a value to the beginning of a Set.
// value: *
prepend(value)
```
```js
// Remove all values from a Set.
clear()
```
```js
// Remove a specific value from a Set.
// value: *
delete(value)
```
```js
// Returns `true` or `false` based on whether or not the
// backing Set contains the specified value.
// value: *
// returns: Boolean
has(value)
```
```js
// Returns an array of values contained in the backing Set.
// returns: Array
values()
```
```js
// Concatenates the given array to the end of the backing Set.
// arr: Array
merge(arr)
```
```js
// Execute a function against the current configuration context
// handler: Function -> ChainedSet
// A function which is given a single argument of the ChainedSet instance
batch(handler)
```
```js
// Conditionally execute a function to continue configuration
// condition: Boolean
// whenTruthy: Function -> ChainedSet
// invoked when condition is truthy, given a single argument of the ChainedSet instance
// whenFalsy: Optional Function -> ChainedSet
// invoked when condition is falsy, given a single argument of the ChainedSet instance
when(condition, whenTruthy, whenFalsy)
```
## Shorthand methods
A number of shorthand methods exist for setting a value on a `ChainedMap`
with the same key as the shorthand method name.
For example, `devServer.hot` is a shorthand method, so it can be used as:
```js
// A shorthand method for setting a value on a ChainedMap
devServer.hot(true);
// This would be equivalent to:
devServer.set('hot', true);
```
A shorthand method is chainable, so calling it will return the original
instance, allowing you to continue to chain.
### Config
Create a new configuration object.
```js
const Config = require('webpack-chain');
const config = new Config();
```
Moving to deeper points in the API will change the context of what you
are modifying. You can move back to the higher context by either referencing
the top-level `config` again, or by calling `.end()` to move up one level.
If you are familiar with jQuery, `.end()` works similarly. All API calls
will return the API instance at the current context unless otherwise
specified. This is so you may chain API calls continuously if desired.
For details on the specific values that are valid for all shorthand and
low-level methods, please refer to their corresponding name in the
[webpack docs hierarchy](https://webpack.js.org/configuration/).
```js
Config : ChainedMap
```
#### Config shorthand methods
```js
config
.amd(amd)
.bail(bail)
.cache(cache)
.devtool(devtool)
.context(context)
.externals(externals)
.loader(loader)
.name(name)
.mode(mode)
.parallelism(parallelism)
.profile(profile)
.recordsPath(recordsPath)
.recordsInputPath(recordsInputPath)
.recordsOutputPath(recordsOutputPath)
.stats(stats)
.target(target)
.watch(watch)
.watchOptions(watchOptions)
```
#### Config entryPoints
```js
// Backed at config.entryPoints : ChainedMap
config.entry(name) : ChainedSet
config
.entry(name)
.add(value)
.add(value)
config
.entry(name)
.clear()
// Using low-level config.entryPoints:
config.entryPoints
.get(name)
.add(value)
.add(value)
config.entryPoints
.get(name)
.clear()
```
#### Config output: shorthand methods
```js
config.output : ChainedMap
config.output
.auxiliaryComment(auxiliaryComment)
.chunkFilename(chunkFilename)
.chunkLoadTimeout(chunkLoadTimeout)
.crossOriginLoading(crossOriginLoading)
.devtoolFallbackModuleFilenameTemplate(devtoolFallbackModuleFilenameTemplate)
.devtoolLineToLine(devtoolLineToLine)
.devtoolModuleFilenameTemplate(devtoolModuleFilenameTemplate)
.devtoolNamespace(devtoolNamespace)
.filename(filename)
.hashFunction(hashFunction)
.hashDigest(hashDigest)
.hashDigestLength(hashDigestLength)
.hashSalt(hashSalt)
.hotUpdateChunkFilename(hotUpdateChunkFilename)
.hotUpdateFunction(hotUpdateFunction)
.hotUpdateMainFilename(hotUpdateMainFilename)
.jsonpFunction(jsonpFunction)
.library(library)
.libraryExport(libraryExport)
.libraryTarget(libraryTarget)
.path(path)
.pathinfo(pathinfo)
.publicPath(publicPath)
.sourceMapFilename(sourceMapFilename)
.sourcePrefix(sourcePrefix)
.strictModuleExceptionHandling(strictModuleExceptionHandling)
.umdNamedDefine(umdNamedDefine)
```
#### Config resolve: shorthand methods
```js
config.resolve : ChainedMap
config.resolve
.cachePredicate(cachePredicate)
.cacheWithContext(cacheWithContext)
.enforceExtension(enforceExtension)
.enforceModuleExtension(enforceModuleExtension)
.unsafeCache(unsafeCache)
.symlinks(symlinks)
```
#### Config resolve alias
```js
config.resolve.alias : ChainedMap
config.resolve.alias
.set(key, value)
.set(key, value)
.delete(key)
.clear()
```
#### Config resolve modules
```js
config.resolve.modules : ChainedSet
config.resolve.modules
.add(value)
.prepend(value)
.clear()
```
#### Config resolve aliasFields
```js
config.resolve.aliasFields : ChainedSet
config.resolve.aliasFields
.add(value)
.prepend(value)
.clear()
```
#### Config resolve descriptionFields
```js
config.resolve.descriptionFields : ChainedSet
config.resolve.descriptionFields
.add(value)
.prepend(value)
.clear()
```
#### Config resolve extensions
```js
config.resolve.extensions : ChainedSet
config.resolve.extensions
.add(value)
.prepend(value)
.clear()
```
#### Config resolve mainFields
```js
config.resolve.mainFields : ChainedSet
config.resolve.mainFields
.add(value)
.prepend(value)
.clear()
```
#### Config resolve mainFiles
```js
config.resolve.mainFiles : ChainedSet
config.resolve.mainFiles
.add(value)
.prepend(value)
.clear()
```
#### Config resolveLoader
The API for `config.resolveLoader` is identical to `config.resolve` with
the following additions:
#### Config resolveLoader moduleExtensions
```js
config.resolveLoader.moduleExtensions : ChainedSet
config.resolveLoader.moduleExtensions
.add(value)
.prepend(value)
.clear()
```
#### Config resolveLoader packageMains
```js
config.resolveLoader.packageMains : ChainedSet
config.resolveLoader.packageMains
.add(value)
.prepend(value)
.clear()
```
#### Config performance: shorthand methods
```js
config.performance : ChainedMap
config.performance
.hints(hints)
.maxEntrypointSize(maxEntrypointSize)
.maxAssetSize(maxAssetSize)
.assetFilter(assetFilter)
```
#### Configuring optimizations: shorthand methods
```js
config.optimization : ChainedMap
config.optimization
.concatenateModules(concatenateModules)
.flagIncludedChunks(flagIncludedChunks)
.mergeDuplicateChunks(mergeDuplicateChunks)
.minimize(minimize)
.namedChunks(namedChunks)
.namedModules(namedModules)
.nodeEnv(nodeEnv)
.noEmitOnErrors(noEmitOnErrors)
.occurrenceOrder(occurrenceOrder)
.portableRecords(portableRecords)
.providedExports(providedExports)
.removeAvailableModules(removeAvailableModules)
.removeEmptyChunks(removeEmptyChunks)
.runtimeChunk(runtimeChunk)
.sideEffects(sideEffects)
.splitChunks(splitChunks)
.usedExports(usedExports)
```
#### Config optimization minimizers
```js
// Backed at config.optimization.minimizers
config.optimization
.minimizer(name) : ChainedMap
```
#### Config optimization minimizers: adding
_NOTE: Do not use `new` to create the minimizer plugin, as this will be done for you._
```js
config.optimization
.minimizer(name)
.use(WebpackPlugin, args)
// Examples
config.optimization
.minimizer('css')
.use(OptimizeCSSAssetsPlugin, [{ cssProcessorOptions: { safe: true } }])
// Minimizer plugins can also be specified by their path, allowing the expensive require()s to be
// skipped in cases where the plugin or webpack configuration won't end up being used.
config.optimization
.minimizer('css')
.use(require.resolve('optimize-css-assets-webpack-plugin'), [{ cssProcessorOptions: { safe: true } }])
```
#### Config optimization minimizers: modify arguments
```js
config.optimization
.minimizer(name)
.tap(args => newArgs)
// Example
config.optimization
.minimizer('css')
.tap(args => [...args, { cssProcessorOptions: { safe: false } }])
```
#### Config optimization minimizers: modify instantiation
```js
config.optimization
.minimizer(name)
.init((Plugin, args) => new Plugin(...args));
```
#### Config optimization minimizers: removing
```js
config.optimization.minimizers.delete(name)
```
#### Config plugins
```js
// Backed at config.plugins
config.plugin(name) : ChainedMap
```
#### Config plugins: adding
_NOTE: Do not use `new` to create the plugin, as this will be done for you._
```js
config
.plugin(name)
.use(WebpackPlugin, args)
// Examples
config
.plugin('hot')
.use(webpack.HotModuleReplacementPlugin);
// Plugins can also be specified by their path, allowing the expensive require()s to be
// skipped in cases where the plugin or webpack configuration won't end up being used.
config
.plugin('env')
.use(require.resolve('webpack/lib/EnvironmentPlugin'), [{ 'VAR': false }]);
```
#### Config plugins: modify arguments
```js
config
.plugin(name)
.tap(args => newArgs)
// Example
config
.plugin('env')
.tap(args => [...args, 'SECRET_KEY']);
```
#### Config plugins: modify instantiation
```js
config
.plugin(name)
.init((Plugin, args) => new Plugin(...args));
```
#### Config plugins: removing
```js
config.plugins.delete(name)
```
#### Config plugins: ordering before
Specify that the current `plugin` context should operate before another named
`plugin`. You cannot use both `.before()` and `.after()` on the same plugin.
```js
config
.plugin(name)
.before(otherName)
// Example
config
.plugin('html-template')
.use(HtmlWebpackTemplate)
.end()
.plugin('script-ext')
.use(ScriptExtWebpackPlugin)
.before('html-template');
```
#### Config plugins: ordering after
Specify that the current `plugin` context should operate after another named
`plugin`. You cannot use both `.before()` and `.after()` on the same plugin.
```js
config
.plugin(name)
.after(otherName)
// Example
config
.plugin('html-template')
.after('script-ext')
.use(HtmlWebpackTemplate)
.end()
.plugin('script-ext')
.use(ScriptExtWebpackPlugin);
```
#### Config resolve plugins
```js
// Backed at config.resolve.plugins
config.resolve.plugin(name) : ChainedMap
```
#### Config resolve plugins: adding
_NOTE: Do not use `new` to create the plugin, as this will be done for you._
```js
config.resolve
.plugin(name)
.use(WebpackPlugin, args)
```
#### Config resolve plugins: modify arguments
```js
config.resolve
.plugin(name)
.tap(args => newArgs)
```
#### Config resolve plugins: modify instantiation
```js
config.resolve
.plugin(name)
.init((Plugin, args) => new Plugin(...args))
```
#### Config resolve plugins: removing
```js
config.resolve.plugins.delete(name)
```
#### Config resolve plugins: ordering before
Specify that the current `plugin` context should operate before another named
`plugin`. You cannot use both `.before()` and `.after()` on the same resolve
plugin.
```js
config.resolve
.plugin(name)
.before(otherName)
// Example
config.resolve
.plugin('beta')
.use(BetaWebpackPlugin)
.end()
.plugin('alpha')
.use(AlphaWebpackPlugin)
.before('beta');
```
#### Config resolve plugins: ordering after
Specify that the current `plugin` context should operate after another named
`plugin`. You cannot use both `.before()` and `.after()` on the same resolve
plugin.
```js
config.resolve
.plugin(name)
.after(otherName)
// Example
config.resolve
.plugin('beta')
.after('alpha')
.use(BetaWebpackTemplate)
.end()
.plugin('alpha')
.use(AlphaWebpackPlugin);
```
#### Config node
```js
config.node : ChainedMap
config.node
.set('__dirname', 'mock')
.set('__filename', 'mock');
```
#### Config devServer
```js
config.devServer : ChainedMap
```
#### Config devServer allowedHosts
```js
config.devServer.allowedHosts : ChainedSet
config.devServer.allowedHosts
.add(value)
.prepend(value)
.clear()
```
#### Config devServer: shorthand methods
```js
config.devServer
.after(after)
.before(before)
.bonjour(bonjour)
.clientLogLevel(clientLogLevel)
.color(color)
.compress(compress)
.contentBase(contentBase)
.disableHostCheck(disableHostCheck)
.filename(filename)
.headers(headers)
.historyApiFallback(historyApiFallback)
.host(host)
.hot(hot)
.hotOnly(hotOnly)
.http2(http2)
.https(https)
.index(index)
.info(info)
.inline(inline)
.lazy(lazy)
.mimeTypes(mimeTypes)
.noInfo(noInfo)
.open(open)
.openPage(openPage)
.overlay(overlay)
.pfx(pfx)
.pfxPassphrase(pfxPassphrase)
.port(port)
.progress(progress)
.proxy(proxy)
.public(public)
.publicPath(publicPath)
.quiet(quiet)
.setup(setup)
.socket(socket)
.sockHost(sockHost)
.sockPath(sockPath)
.sockPort(sockPort)
.staticOptions(staticOptions)
.stats(stats)
.stdin(stdin)
.useLocalIp(useLocalIp)
.watchContentBase(watchContentBase)
.watchOptions(watchOptions)
.writeToDisk(writeToDisk)
```
#### Config module
```js
config.module : ChainedMap
```
#### Config module: shorthand methods
```js
config.module : ChainedMap
config.module
.noParse(noParse)
```
#### Config module rules: shorthand methods
```js
config.module.rules : ChainedMap
config.module
.rule(name)
.test(test)
.pre()
.post()
.enforce(preOrPost)
```
#### Config module rules uses (loaders): creating
```js
config.module.rules{}.uses : ChainedMap
config.module
.rule(name)
.use(name)
.loader(loader)
.options(options)
// Example
config.module
.rule('compile')
.use('babel')
.loader('babel-loader')
.options({ presets: ['@babel/preset-env'] });
```
#### Config module rules uses (loaders): modifying options
```js
config.module
.rule(name)
.use(name)
.tap(options => newOptions)
// Example
config.module
.rule('compile')
.use('babel')
.tap(options => merge(options, {
plugins: ['@babel/plugin-proposal-class-properties']
}));
```
#### Config module rules nested rules:
```js
config.module.rules{}.rules : ChainedMap<Rule>
config.module
.rule(name)
.rule(name)
// Example
config.module
.rule('css')
.test(/\.css$/)
.use('style')
.loader('style-loader')
.end()
.rule('postcss')
.resourceQuery(/postcss/)
.use('postcss')
.loader('postcss-loader')
```
#### Config module rules nested rules: ordering before
Specify that the current `rule` context should operate before another named
`rule`. You cannot use both `.before()` and `.after()` on the same `rule`.
```js
config.module.rules{}.rules : ChainedMap<Rule>
config.module
.rule(name)
.rule(name)
.before(otherName)
// Example
config.module
.rule('css')
.use('style')
.loader('style-loader')
.end()
.rule('postcss')
.resourceQuery(/postcss/)
.use('postcss')
.loader('postcss-loader')
.end()
.end()
.rule('css-loader')
.resourceQuery(/css-loader/)
.before('postcss')
.use('css-loader')
.loader('css-loader')
```
#### Config module rules nested rules: ordering after
Specify that the current `rule` context should operate after another named
`rule`. You cannot use both `.before()` and `.after()` on the same `rule`.
```js
config.module.rules{}.rules : ChainedMap<Rule>
config.module
.rule(name)
.rule(name)
.after(otherName)
// Example
config.module
.rule('css')
.use('style')
.loader('style-loader')
.end()
.rule('postcss')
.resourceQuery(/postcss/)
.after('css-loader')
.use('postcss')
.loader('postcss-loader')
.end()
.end()
.rule('css-loader')
.resourceQuery(/css-loader/)
.use('css-loader')
.loader('css-loader')
```
#### Config module rules oneOfs (conditional rules):
```js
config.module.rules{}.oneOfs : ChainedMap<Rule>
config.module
.rule(name)
.oneOf(name)
// Example
config.module
.rule('css')
.oneOf('inline')
.resourceQuery(/inline/)
.use('url')
.loader('url-loader')
.end()
.end()
.oneOf('external')
.resourceQuery(/external/)
.use('file')
.loader('file-loader')
```
#### Config module rules oneOfs (conditional rules): ordering before
Specify that the current `oneOf` context should operate before another named
`oneOf`. You cannot use both `.before()` and `.after()` on the same `oneOf`.
```js
config.module
.rule(name)
.oneOf(name)
.before()
// Example
config.module
.rule('scss')
.test(/\.scss$/)
.oneOf('normal')
.use('sass')
.loader('sass-loader')
.end()
.end()
.oneOf('sass-vars')
.before('normal')
.resourceQuery(/\?sassvars/)
.use('sass-vars')
.loader('sass-vars-to-js-loader')
```
#### Config module rules oneOfs (conditional rules): ordering after
Specify that the current `oneOf` context should operate after another named
`oneOf`. You cannot use both `.before()` and `.after()` on the same `oneOf`.
```js
config.module
.rule(name)
.oneOf(name)
.after()
// Example
config.module
.rule('scss')
.test(/\.scss$/)
.oneOf('vue')
.resourceQuery(/\?vue/)
.use('vue-style')
.loader('vue-style-loader')
.end()
.end()
.oneOf('normal')
.use('sass')
.loader('sass-loader')
.end()
.end()
.oneOf('sass-vars')
.after('vue')
.resourceQuery(/\?sassvars/)
.use('sass-vars')
.loader('sass-vars-to-js-loader')
```
#### Config module rules resolve
Specify a resolve configuration to be merged over the default `config.resolve`
for modules that match the rule.
See "Config resolve" sections above for full syntax.
**Note:** This option is supported by webpack since 4.36.1.
```js
config.module
.rule(name)
.resolve
// Example
config.module
.rule('scss')
.test(/\.scss$/)
.resolve
.symlinks(true)
```
---
### Merging Config
webpack-chain supports merging in an object to the configuration instance which
matches a layout similar to how the webpack-chain schema is laid out.
**Note:** This object does not match the webpack configuration schema exactly
(for example the `[name]` keys for entry/rules/plugins), so you may need to transform
webpack configuration objects (such as those output by webpack-chain's `.toConfig()`)
to match the layout below prior to passing to `.merge()`.
```js
config.merge({ devtool: 'source-map' });
config.get('devtool') // "source-map"
```
```js
config.merge({
[key]: value,
amd,
bail,
cache,
context,
devtool,
externals,
loader,
mode,
parallelism,
profile,
recordsPath,
recordsInputPath,
recordsOutputPath,
stats,
target,
watch,
watchOptions,
entry: {
[name]: [...values]
},
plugin: {
[name]: {
plugin: WebpackPlugin,
args: [...args],
before,
after
}
},
devServer: {
[key]: value,
clientLogLevel,
compress,
contentBase,
filename,
headers,
historyApiFallback,
host,
hot,
hotOnly,
https,
inline,
lazy,
noInfo,
overlay,
port,
proxy,
quiet,
setup,
stats,
watchContentBase
},
node: {
[key]: value
},
optimization: {
concatenateModules,
flagIncludedChunks,
mergeDuplicateChunks,
minimize,
minimizer: {
[name]: {
plugin: WebpackPlugin,
args: [...args],
before,
after
}
},
namedChunks,
namedModules,
nodeEnv,
noEmitOnErrors,
occurrenceOrder,
portableRecords,
providedExports,
removeAvailableModules,
removeEmptyChunks,
runtimeChunk,
sideEffects,
splitChunks,
usedExports,
},
performance: {
[key]: value,
hints,
maxEntrypointSize,
maxAssetSize,
assetFilter
},
resolve: {
[key]: value,
alias: {
[key]: value
},
aliasFields: [...values],
descriptionFields: [...values],
extensions: [...values],
mainFields: [...values],
mainFiles: [...values],
modules: [...values],
plugin: {
[name]: {
plugin: WebpackPlugin,
args: [...args],
before,
after
}
}
},
resolveLoader: {
[key]: value,
alias: {
[key]: value
},
aliasFields: [...values],
descriptionFields: [...values],
extensions: [...values],
mainFields: [...values],
mainFiles: [...values],
modules: [...values],
moduleExtensions: [...values],
packageMains: [...values],
plugin: {
[name]: {
plugin: WebpackPlugin,
args: [...args],
before,
after
}
}
},
module: {
[key]: value,
rule: {
[name]: {
[key]: value,
enforce,
issuer,
parser,
resource,
resourceQuery,
test,
include: [...paths],
exclude: [...paths],
rules: {
[name]: Rule
},
oneOf: {
[name]: Rule
},
use: {
[name]: {
loader: LoaderString,
options: LoaderOptions,
before,
after
}
}
}
}
}
})
```
### Conditional configuration
When working with instances of `ChainedMap` and `ChainedSet`, you can perform
conditional configuration using `when`. You must specify an expression to
`when()` which will be evaluated for truthiness or falsiness. If the expression
is truthy, the first function argument will be invoked with an instance of the
current chained instance. You can optionally provide a second function to be
invoked when the condition is falsy, which is also given the current chained
instance.
```js
// Example: Only add minify plugin during production
config
.when(process.env.NODE_ENV === 'production', config => {
config
.plugin('minify')
.use(BabiliWebpackPlugin);
});
```
```js
// Example: Only add minify plugin during production,
// otherwise set devtool to source-map
config
.when(process.env.NODE_ENV === 'production',
config => config.plugin('minify').use(BabiliWebpackPlugin),
config => config.devtool('source-map')
);
```
### Inspecting generated configuration
You can inspect the generated webpack config using `config.toString()`. This
will generate a stringified version of the config with comment hints for named
rules, uses and plugins:
```js
config
.module
.rule('compile')
.test(/\.js$/)
.use('babel')
.loader('babel-loader');
config.toString();
/*
{
module: {
rules: [
/* config.module.rule('compile') */
{
test: /\.js$/,
use: [
/* config.module.rule('compile').use('babel') */
{
loader: 'babel-loader'
}
]
}
]
}
}
*/
```
By default the generated string cannot be used directly as real webpack config
if it contains objects and plugins that need to be required. In order to
generate usable config, you can customize how objects and plugins are
stringified by setting a special `__expression` property on them:
```js
const sass = require('sass');
sass.__expression = `require('sass')`;
class MyPlugin {}
MyPlugin.__expression = `require('my-plugin')`;
function myFunction () {}
myFunction.__expression = `require('my-function')`;
config
.plugin('example')
.use(MyPlugin, [{ fn: myFunction, implementation: sass, }]);
config.toString();
/*
{
plugins: [
new (require('my-plugin'))({
fn: require('my-function'),
implementation: require('sass')
})
]
}
*/
```
Plugins specified via their path will have their `require()` statement generated
automatically:
```js
config
.plugin('env')
.use(require.resolve('webpack/lib/ProvidePlugin'), [{ jQuery: 'jquery' }])
config.toString();
/*
{
plugins: [
new (require('/foo/bar/src/node_modules/webpack/lib/EnvironmentPlugin.js'))(
{
jQuery: 'jquery'
}
)
]
}
*/
```
You can also call `toString` as a static method on `Config` in order to
modify the configuration object prior to stringifying.
```js
Config.toString({
...config.toConfig(),
module: {
defaultRules: [
{
use: [
{
loader: 'banner-loader',
options: { prefix: 'banner-prefix.txt' },
},
],
},
],
},
})
```
```
{
plugins: [
/* config.plugin('foo') */
new TestPlugin()
],
module: {
defaultRules: [
{
use: [
{
loader: 'banner-loader',
options: {
prefix: 'banner-prefix.txt'
}
}
]
}
]
}
}
```
[npm-image]: https://img.shields.io/npm/v/webpack-chain.svg
[npm-downloads]: https://img.shields.io/npm/dt/webpack-chain.svg
[npm-url]: https://www.npmjs.com/package/webpack-chain
[ci-image]: https://github.com/neutrinojs/webpack-chain/actions/workflows/ci.yml/badge.svg
[ci-url]: https://github.com/neutrinojs/webpack-chain/actions/workflows/ci.yml
================================================
FILE: jest.config.js
================================================
module.exports = {
testEnvironment: 'node',
testMatch: ['**/test/**/*.js'],
};
================================================
FILE: package.json
================================================
{
"name": "webpack-chain",
"version": "7.0.0-dev",
"main": "src/Config.js",
"typings": "types/index.d.ts",
"repository": "neutrinojs/webpack-chain",
"keywords": [
"webpack",
"config",
"chain",
"fluent",
"api"
],
"engines": {
"node": ">=12"
},
"files": [
"src",
"types/*.d.ts"
],
"author": "Eli Perelman <eli@eliperelman.com>",
"license": "MPL-2.0",
"scripts": {
"fix": "yarn lint:fix && yarn style:fix",
"lint": "eslint --cache --max-warnings 0 --format codeframe .",
"lint:fix": "yarn lint --fix",
"style": "prettier --check .",
"style:fix": "prettier --write .",
"test": "jest",
"test:types": "tsc -p ./types/test/tsconfig.json",
"changelog": "auto-changelog --remote upstream --commit-limit false",
"version": "yarn changelog --package && git add CHANGELOG.md"
},
"dependencies": {
"deepmerge": "^1.5.2",
"javascript-stringify": "^2.0.1"
},
"devDependencies": {
"@types/enhanced-resolve": "^3.0.6",
"@types/tapable": "^1.0.6",
"@types/webpack": "^4.41.21",
"auto-changelog": "^2.2.0",
"eslint": "^8.0.0",
"eslint-config-airbnb-base": "^14.2.0",
"eslint-config-prettier": "^8.0.0",
"eslint-formatter-codeframe": "^7.32.1",
"eslint-plugin-import": "^2.22.0",
"eslint-plugin-jest": "^25.0.0",
"jest": "^27.0.0",
"prettier": "^2.0.5",
"typescript": "^4.0.0",
"webpack": "^4.43.0"
}
}
================================================
FILE: renovate.json
================================================
{
"extends": [
"config:base",
":maintainLockFilesWeekly",
":prNotPending",
":semanticCommitsDisabled",
":unpublishSafe"
],
"reviewers": ["neutrinojs/core-contributors"],
"pinVersions": false
}
================================================
FILE: src/Chainable.js
================================================
module.exports = class {
constructor(parent) {
this.parent = parent;
}
batch(handler) {
handler(this);
return this;
}
end() {
return this.parent;
}
};
================================================
FILE: src/ChainedMap.js
================================================
const merge = require('deepmerge');
const Chainable = require('./Chainable');
module.exports = class extends Chainable {
constructor(parent) {
super(parent);
this.store = new Map();
}
extend(methods) {
this.shorthands = methods;
methods.forEach((method) => {
this[method] = (value) => this.set(method, value);
});
return this;
}
clear() {
this.store.clear();
return this;
}
delete(key) {
this.store.delete(key);
return this;
}
order() {
const entries = [...this.store].reduce((acc, [key, value]) => {
acc[key] = value;
return acc;
}, {});
const names = Object.keys(entries);
const order = [...names];
names.forEach((name) => {
if (!entries[name]) {
return;
}
const { __before, __after } = entries[name];
if (__before && order.includes(__before)) {
order.splice(order.indexOf(name), 1);
order.splice(order.indexOf(__before), 0, name);
} else if (__after && order.includes(__after)) {
order.splice(order.indexOf(name), 1);
order.splice(order.indexOf(__after) + 1, 0, name);
}
});
return { entries, order };
}
entries() {
const { entries, order } = this.order();
if (order.length) {
return entries;
}
return undefined;
}
values() {
const { entries, order } = this.order();
return order.map((name) => entries[name]);
}
get(key) {
return this.store.get(key);
}
getOrCompute(key, fn) {
if (!this.has(key)) {
this.set(key, fn());
}
return this.get(key);
}
has(key) {
return this.store.has(key);
}
set(key, value) {
this.store.set(key, value);
return this;
}
merge(obj, omit = []) {
Object.keys(obj).forEach((key) => {
if (omit.includes(key)) {
return;
}
const value = obj[key];
if (
(!Array.isArray(value) && typeof value !== 'object') ||
value === null ||
!this.has(key)
) {
this.set(key, value);
} else {
this.set(key, merge(this.get(key), value));
}
});
return this;
}
clean(obj) {
return Object.keys(obj).reduce((acc, key) => {
const value = obj[key];
if (value === undefined) {
return acc;
}
if (Array.isArray(value) && !value.length) {
return acc;
}
if (
Object.prototype.toString.call(value) === '[object Object]' &&
!Object.keys(value).length
) {
return acc;
}
acc[key] = value;
return acc;
}, {});
}
when(
condition,
whenTruthy = Function.prototype,
whenFalsy = Function.prototype,
) {
if (condition) {
whenTruthy(this);
} else {
whenFalsy(this);
}
return this;
}
};
================================================
FILE: src/ChainedSet.js
================================================
const Chainable = require('./Chainable');
module.exports = class extends Chainable {
constructor(parent) {
super(parent);
this.store = new Set();
}
add(value) {
this.store.add(value);
return this;
}
prepend(value) {
this.store = new Set([value, ...this.store]);
return this;
}
clear() {
this.store.clear();
return this;
}
delete(value) {
this.store.delete(value);
return this;
}
values() {
return [...this.store];
}
has(value) {
return this.store.has(value);
}
merge(arr) {
this.store = new Set([...this.store, ...arr]);
return this;
}
when(
condition,
whenTruthy = Function.prototype,
whenFalsy = Function.prototype,
) {
if (condition) {
whenTruthy(this);
} else {
whenFalsy(this);
}
return this;
}
};
================================================
FILE: src/Config.js
================================================
const ChainedMap = require('./ChainedMap');
const ChainedSet = require('./ChainedSet');
const Resolve = require('./Resolve');
const ResolveLoader = require('./ResolveLoader');
const Output = require('./Output');
const DevServer = require('./DevServer');
const Plugin = require('./Plugin');
const Module = require('./Module');
const Optimization = require('./Optimization');
const Performance = require('./Performance');
module.exports = class extends ChainedMap {
constructor() {
super();
this.devServer = new DevServer(this);
this.entryPoints = new ChainedMap(this);
this.module = new Module(this);
this.node = new ChainedMap(this);
this.optimization = new Optimization(this);
this.output = new Output(this);
this.performance = new Performance(this);
this.plugins = new ChainedMap(this);
this.resolve = new Resolve(this);
this.resolveLoader = new ResolveLoader(this);
this.extend([
'amd',
'bail',
'cache',
'context',
'devtool',
'externals',
'loader',
'mode',
'name',
'parallelism',
'profile',
'recordsInputPath',
'recordsPath',
'recordsOutputPath',
'stats',
'target',
'watch',
'watchOptions',
]);
}
static toString(config, { verbose = false, configPrefix = 'config' } = {}) {
// eslint-disable-next-line global-require
const { stringify } = require('javascript-stringify');
return stringify(
config,
(value, indent, stringify) => {
// improve plugin output
if (value && value.__pluginName) {
const prefix = `/* ${configPrefix}.${value.__pluginType}('${value.__pluginName}') */\n`;
const constructorExpression = value.__pluginPath
? // The path is stringified to ensure special characters are escaped
// (such as the backslashes in Windows-style paths).
`(require(${stringify(value.__pluginPath)}))`
: value.__pluginConstructorName;
if (constructorExpression) {
// get correct indentation for args by stringifying the args array and
// discarding the square brackets.
const args = stringify(value.__pluginArgs).slice(1, -1);
return `${prefix}new ${constructorExpression}(${args})`;
}
return (
prefix +
stringify(
value.__pluginArgs && value.__pluginArgs.length
? { args: value.__pluginArgs }
: {},
)
);
}
// improve rule/use output
if (value && value.__ruleNames) {
const ruleTypes = value.__ruleTypes;
const prefix = `/* ${configPrefix}.module${value.__ruleNames
.map(
(r, index) => `.${ruleTypes ? ruleTypes[index] : 'rule'}('${r}')`,
)
.join('')}${
value.__useName ? `.use('${value.__useName}')` : ``
} */\n`;
return prefix + stringify(value);
}
if (value && value.__expression) {
return value.__expression;
}
// shorten long functions
if (typeof value === 'function') {
if (!verbose && value.toString().length > 100) {
return `function () { /* omitted long function */ }`;
}
}
return stringify(value);
},
2,
);
}
entry(name) {
return this.entryPoints.getOrCompute(name, () => new ChainedSet(this));
}
plugin(name) {
return this.plugins.getOrCompute(name, () => new Plugin(this, name));
}
toConfig() {
const entryPoints = this.entryPoints.entries() || {};
return this.clean(
Object.assign(this.entries() || {}, {
node: this.node.entries(),
output: this.output.entries(),
resolve: this.resolve.toConfig(),
resolveLoader: this.resolveLoader.toConfig(),
devServer: this.devServer.toConfig(),
module: this.module.toConfig(),
optimization: this.optimization.toConfig(),
plugins: this.plugins.values().map((plugin) => plugin.toConfig()),
performance: this.performance.entries(),
entry: Object.keys(entryPoints).reduce(
(acc, key) =>
Object.assign(acc, { [key]: entryPoints[key].values() }),
{},
),
}),
);
}
toString(options) {
return module.exports.toString(this.toConfig(), options);
}
merge(obj = {}, omit = []) {
const omissions = [
'node',
'output',
'resolve',
'resolveLoader',
'devServer',
'optimization',
'performance',
'module',
];
if (!omit.includes('entry') && 'entry' in obj) {
Object.keys(obj.entry).forEach((name) =>
this.entry(name).merge([].concat(obj.entry[name])),
);
}
if (!omit.includes('plugin') && 'plugin' in obj) {
Object.keys(obj.plugin).forEach((name) =>
this.plugin(name).merge(obj.plugin[name]),
);
}
omissions.forEach((key) => {
if (!omit.includes(key) && key in obj) {
this[key].merge(obj[key]);
}
});
return super.merge(obj, [...omit, ...omissions, 'entry', 'plugin']);
}
};
================================================
FILE: src/DevServer.js
================================================
const ChainedMap = require('./ChainedMap');
const ChainedSet = require('./ChainedSet');
module.exports = class extends ChainedMap {
constructor(parent) {
super(parent);
this.allowedHosts = new ChainedSet(this);
this.extend([
'after',
'before',
'bonjour',
'clientLogLevel',
'color',
'compress',
'contentBase',
'disableHostCheck',
'filename',
'headers',
'historyApiFallback',
'host',
'hot',
'hotOnly',
'http2',
'https',
'index',
'info',
'inline',
'lazy',
'mimeTypes',
'noInfo',
'open',
'openPage',
'overlay',
'pfx',
'pfxPassphrase',
'port',
'proxy',
'progress',
'public',
'publicPath',
'quiet',
'setup',
'socket',
'sockHost',
'sockPath',
'sockPort',
'staticOptions',
'stats',
'stdin',
'useLocalIp',
'watchContentBase',
'watchOptions',
'writeToDisk',
]);
}
toConfig() {
return this.clean({
allowedHosts: this.allowedHosts.values(),
...(this.entries() || {}),
});
}
merge(obj, omit = []) {
if (!omit.includes('allowedHosts') && 'allowedHosts' in obj) {
this.allowedHosts.merge(obj.allowedHosts);
}
return super.merge(obj, ['allowedHosts']);
}
};
================================================
FILE: src/Module.js
================================================
const ChainedMap = require('./ChainedMap');
const Rule = require('./Rule');
module.exports = class extends ChainedMap {
constructor(parent) {
super(parent);
this.rules = new ChainedMap(this);
this.defaultRules = new ChainedMap(this);
this.extend(['noParse', 'strictExportPresence']);
}
defaultRule(name) {
return this.defaultRules.getOrCompute(
name,
() => new Rule(this, name, 'defaultRule'),
);
}
rule(name) {
return this.rules.getOrCompute(name, () => new Rule(this, name, 'rule'));
}
toConfig() {
return this.clean(
Object.assign(this.entries() || {}, {
defaultRules: this.defaultRules.values().map((r) => r.toConfig()),
rules: this.rules.values().map((r) => r.toConfig()),
}),
);
}
merge(obj, omit = []) {
if (!omit.includes('rule') && 'rule' in obj) {
Object.keys(obj.rule).forEach((name) =>
this.rule(name).merge(obj.rule[name]),
);
}
if (!omit.includes('defaultRule') && 'defaultRule' in obj) {
Object.keys(obj.defaultRule).forEach((name) =>
this.defaultRule(name).merge(obj.defaultRule[name]),
);
}
return super.merge(obj, ['rule', 'defaultRule']);
}
};
================================================
FILE: src/Optimization.js
================================================
const ChainedMap = require('./ChainedMap');
const Plugin = require('./Plugin');
module.exports = class extends ChainedMap {
constructor(parent) {
super(parent);
this.minimizers = new ChainedMap(this);
this.extend([
'concatenateModules',
'flagIncludedChunks',
'mergeDuplicateChunks',
'minimize',
'namedChunks',
'namedModules',
'nodeEnv',
'noEmitOnErrors',
'occurrenceOrder',
'portableRecords',
'providedExports',
'removeAvailableModules',
'removeEmptyChunks',
'runtimeChunk',
'sideEffects',
'splitChunks',
'usedExports',
]);
}
minimizer(name) {
if (Array.isArray(name)) {
throw new Error(
'optimization.minimizer() no longer supports being passed an array. ' +
'Either switch to the new syntax (https://github.com/neutrinojs/webpack-chain#config-optimization-minimizers-adding) or downgrade to webpack-chain 4. ' +
'If using Vue this likely means a Vue plugin has not yet been updated to support Vue CLI 4+.',
);
}
return this.minimizers.getOrCompute(
name,
() => new Plugin(this, name, 'optimization.minimizer'),
);
}
toConfig() {
return this.clean(
Object.assign(this.entries() || {}, {
minimizer: this.minimizers.values().map((plugin) => plugin.toConfig()),
}),
);
}
merge(obj, omit = []) {
if (!omit.includes('minimizer') && 'minimizer' in obj) {
Object.keys(obj.minimizer).forEach((name) =>
this.minimizer(name).merge(obj.minimizer[name]),
);
}
return super.merge(obj, [...omit, 'minimizer']);
}
};
================================================
FILE: src/Orderable.js
================================================
module.exports = (Class) =>
class extends Class {
before(name) {
if (this.__after) {
throw new Error(
`Unable to set .before(${JSON.stringify(
name,
)}) with existing value for .after()`,
);
}
this.__before = name;
return this;
}
after(name) {
if (this.__before) {
throw new Error(
`Unable to set .after(${JSON.stringify(
name,
)}) with existing value for .before()`,
);
}
this.__after = name;
return this;
}
merge(obj, omit = []) {
if (obj.before) {
this.before(obj.before);
}
if (obj.after) {
this.after(obj.after);
}
return super.merge(obj, [...omit, 'before', 'after']);
}
};
================================================
FILE: src/Output.js
================================================
const ChainedMap = require('./ChainedMap');
module.exports = class extends ChainedMap {
constructor(parent) {
super(parent);
this.extend([
'auxiliaryComment',
'chunkCallbackName',
'chunkFilename',
'chunkLoadTimeout',
'crossOriginLoading',
'devtoolFallbackModuleFilenameTemplate',
'devtoolLineToLine',
'devtoolModuleFilenameTemplate',
'devtoolNamespace',
'filename',
'futureEmitAssets',
'globalObject',
'hashDigest',
'hashDigestLength',
'hashFunction',
'hashSalt',
'hotUpdateChunkFilename',
'hotUpdateFunction',
'hotUpdateMainFilename',
'jsonpFunction',
'library',
'libraryExport',
'libraryTarget',
'path',
'pathinfo',
'publicPath',
'sourceMapFilename',
'sourcePrefix',
'strictModuleExceptionHandling',
'umdNamedDefine',
'webassemblyModuleFilename',
]);
}
};
================================================
FILE: src/Performance.js
================================================
const ChainedMap = require('./ChainedMap');
module.exports = class extends ChainedMap {
constructor(parent) {
super(parent);
this.extend(['assetFilter', 'hints', 'maxAssetSize', 'maxEntrypointSize']);
}
};
================================================
FILE: src/Plugin.js
================================================
const ChainedMap = require('./ChainedMap');
const Orderable = require('./Orderable');
module.exports = Orderable(
class extends ChainedMap {
constructor(parent, name, type = 'plugin') {
super(parent);
this.name = name;
this.type = type;
this.extend(['init']);
this.init((Plugin, args = []) => {
if (typeof Plugin === 'function') {
return new Plugin(...args);
}
return Plugin;
});
}
use(plugin, args = []) {
return this.set('plugin', plugin).set('args', args);
}
tap(f) {
if (!this.has('plugin')) {
throw new Error(
`Cannot call .tap() on a plugin that has not yet been defined. Call ${this.type}('${this.name}').use(<Plugin>) first.`,
);
}
this.set('args', f(this.get('args') || []));
return this;
}
set(key, value) {
if (key === 'args' && !Array.isArray(value)) {
throw new Error('args must be an array of arguments');
}
return super.set(key, value);
}
merge(obj, omit = []) {
if ('plugin' in obj) {
this.set('plugin', obj.plugin);
}
if ('args' in obj) {
this.set('args', obj.args);
}
return super.merge(obj, [...omit, 'args', 'plugin']);
}
toConfig() {
const init = this.get('init');
let plugin = this.get('plugin');
const args = this.get('args');
let pluginPath = null;
if (plugin === undefined) {
throw new Error(
`Invalid ${this.type} configuration: ${this.type}('${this.name}').use(<Plugin>) was not called to specify the plugin`,
);
}
// Support using the path to a plugin rather than the plugin itself,
// allowing expensive require()s to be skipped in cases where the plugin
// or webpack configuration won't end up being used.
if (typeof plugin === 'string') {
pluginPath = plugin;
// eslint-disable-next-line global-require, import/no-dynamic-require
plugin = require(pluginPath);
}
const constructorName = plugin.__expression
? `(${plugin.__expression})`
: plugin.name;
const config = init(plugin, args);
Object.defineProperties(config, {
__pluginName: { value: this.name },
__pluginType: { value: this.type },
__pluginArgs: { value: args },
__pluginConstructorName: { value: constructorName },
__pluginPath: { value: pluginPath },
});
return config;
}
},
);
================================================
FILE: src/Resolve.js
================================================
const ChainedMap = require('./ChainedMap');
const ChainedSet = require('./ChainedSet');
const Plugin = require('./Plugin');
module.exports = class extends ChainedMap {
constructor(parent) {
super(parent);
this.alias = new ChainedMap(this);
this.aliasFields = new ChainedSet(this);
this.descriptionFiles = new ChainedSet(this);
this.extensions = new ChainedSet(this);
this.mainFields = new ChainedSet(this);
this.mainFiles = new ChainedSet(this);
this.modules = new ChainedSet(this);
this.plugins = new ChainedMap(this);
this.extend([
'cachePredicate',
'cacheWithContext',
'concord',
'enforceExtension',
'enforceModuleExtension',
'symlinks',
'unsafeCache',
]);
}
plugin(name) {
return this.plugins.getOrCompute(
name,
() => new Plugin(this, name, 'resolve.plugin'),
);
}
toConfig() {
return this.clean(
Object.assign(this.entries() || {}, {
alias: this.alias.entries(),
aliasFields: this.aliasFields.values(),
descriptionFiles: this.descriptionFiles.values(),
extensions: this.extensions.values(),
mainFields: this.mainFields.values(),
mainFiles: this.mainFiles.values(),
modules: this.modules.values(),
plugins: this.plugins.values().map((plugin) => plugin.toConfig()),
}),
);
}
merge(obj, omit = []) {
const omissions = [
'alias',
'aliasFields',
'descriptionFiles',
'extensions',
'mainFields',
'mainFiles',
'modules',
];
if (!omit.includes('plugin') && 'plugin' in obj) {
Object.keys(obj.plugin).forEach((name) =>
this.plugin(name).merge(obj.plugin[name]),
);
}
omissions.forEach((key) => {
if (!omit.includes(key) && key in obj) {
this[key].merge(obj[key]);
}
});
return super.merge(obj, [...omit, ...omissions, 'plugin']);
}
};
================================================
FILE: src/ResolveLoader.js
================================================
const Resolve = require('./Resolve');
const ChainedSet = require('./ChainedSet');
module.exports = class extends Resolve {
constructor(parent) {
super(parent);
this.moduleExtensions = new ChainedSet(this);
this.packageMains = new ChainedSet(this);
}
toConfig() {
return this.clean({
moduleExtensions: this.moduleExtensions.values(),
packageMains: this.packageMains.values(),
...super.toConfig(),
});
}
merge(obj, omit = []) {
const omissions = ['moduleExtensions', 'packageMains'];
omissions.forEach((key) => {
if (!omit.includes(key) && key in obj) {
this[key].merge(obj[key]);
}
});
return super.merge(obj, [...omit, ...omissions]);
}
};
================================================
FILE: src/Rule.js
================================================
const ChainedMap = require('./ChainedMap');
const ChainedSet = require('./ChainedSet');
const Orderable = require('./Orderable');
const Use = require('./Use');
const Resolve = require('./Resolve');
function toArray(arr) {
return Array.isArray(arr) ? arr : [arr];
}
const Rule = Orderable(
class extends ChainedMap {
constructor(parent, name, ruleType = 'rule') {
super(parent);
this.name = name;
this.names = [];
this.ruleType = ruleType;
this.ruleTypes = [];
let rule = this;
while (rule instanceof Rule) {
this.names.unshift(rule.name);
this.ruleTypes.unshift(rule.ruleType);
rule = rule.parent;
}
this.uses = new ChainedMap(this);
this.include = new ChainedSet(this);
this.exclude = new ChainedSet(this);
this.rules = new ChainedMap(this);
this.oneOfs = new ChainedMap(this);
this.resolve = new Resolve(this);
this.extend([
'enforce',
'issuer',
'parser',
'resource',
'resourceQuery',
'sideEffects',
'test',
'type',
]);
}
use(name) {
return this.uses.getOrCompute(name, () => new Use(this, name));
}
rule(name) {
return this.rules.getOrCompute(name, () => new Rule(this, name, 'rule'));
}
oneOf(name) {
return this.oneOfs.getOrCompute(
name,
() => new Rule(this, name, 'oneOf'),
);
}
pre() {
return this.enforce('pre');
}
post() {
return this.enforce('post');
}
toConfig() {
const config = this.clean(
Object.assign(this.entries() || {}, {
include: this.include.values(),
exclude: this.exclude.values(),
rules: this.rules.values().map((rule) => rule.toConfig()),
oneOf: this.oneOfs.values().map((oneOf) => oneOf.toConfig()),
use: this.uses.values().map((use) => use.toConfig()),
resolve: this.resolve.toConfig(),
}),
);
Object.defineProperties(config, {
__ruleNames: { value: this.names },
__ruleTypes: { value: this.ruleTypes },
});
return config;
}
merge(obj, omit = []) {
if (!omit.includes('include') && 'include' in obj) {
this.include.merge(toArray(obj.include));
}
if (!omit.includes('exclude') && 'exclude' in obj) {
this.exclude.merge(toArray(obj.exclude));
}
if (!omit.includes('use') && 'use' in obj) {
Object.keys(obj.use).forEach((name) =>
this.use(name).merge(obj.use[name]),
);
}
if (!omit.includes('rules') && 'rules' in obj) {
Object.keys(obj.rules).forEach((name) =>
this.rule(name).merge(obj.rules[name]),
);
}
if (!omit.includes('oneOf') && 'oneOf' in obj) {
Object.keys(obj.oneOf).forEach((name) =>
this.oneOf(name).merge(obj.oneOf[name]),
);
}
if (!omit.includes('resolve') && 'resolve' in obj) {
this.resolve.merge(obj.resolve);
}
if (!omit.includes('test') && 'test' in obj) {
this.test(
obj.test instanceof RegExp || typeof obj.test === 'function'
? obj.test
: new RegExp(obj.test),
);
}
return super.merge(obj, [
...omit,
'include',
'exclude',
'use',
'rules',
'oneOf',
'resolve',
'test',
]);
}
},
);
module.exports = Rule;
================================================
FILE: src/Use.js
================================================
const merge = require('deepmerge');
const ChainedMap = require('./ChainedMap');
const Orderable = require('./Orderable');
module.exports = Orderable(
class extends ChainedMap {
constructor(parent, name) {
super(parent);
this.name = name;
this.extend(['loader', 'options']);
}
tap(f) {
this.options(f(this.get('options')));
return this;
}
merge(obj, omit = []) {
if (!omit.includes('loader') && 'loader' in obj) {
this.loader(obj.loader);
}
if (!omit.includes('options') && 'options' in obj) {
this.options(merge(this.store.get('options') || {}, obj.options));
}
return super.merge(obj, [...omit, 'loader', 'options']);
}
toConfig() {
const config = this.clean(this.entries() || {});
Object.defineProperties(config, {
__useName: { value: this.name },
__ruleNames: { value: this.parent && this.parent.names },
__ruleTypes: { value: this.parent && this.parent.ruleTypes },
});
return config;
}
},
);
================================================
FILE: test/Chainable.js
================================================
const Chainable = require('../src/Chainable');
test('calling .end() returns parent', () => {
const parent = { parent: true };
const chain = new Chainable(parent);
expect(chain.end()).toBe(parent);
});
test('using .batch() receives context', () => {
const chain = new Chainable();
const context = chain.batch((current) => {
expect(current).toBe(chain);
});
expect(context).toBe(chain);
});
================================================
FILE: test/ChainedMap.js
================================================
const ChainedMap = require('../src/ChainedMap');
test('is Chainable', () => {
const parent = { parent: true };
const map = new ChainedMap(parent);
expect(map.end()).toBe(parent);
});
test('creates a backing Map', () => {
const map = new ChainedMap();
expect(map.store instanceof Map).toBe(true);
});
test('set', () => {
const map = new ChainedMap();
expect(map.set('a', 'alpha')).toBe(map);
expect(map.store.get('a')).toBe('alpha');
});
test('get', () => {
const map = new ChainedMap();
expect(map.set('a', 'alpha')).toBe(map);
expect(map.get('a')).toBe('alpha');
});
test('getOrCompute', () => {
const map = new ChainedMap();
expect(map.get('a')).toBeUndefined();
expect(map.getOrCompute('a', () => 'alpha')).toBe('alpha');
expect(map.get('a')).toBe('alpha');
});
test('clear', () => {
const map = new ChainedMap();
map.set('a', 'alpha');
map.set('b', 'beta');
map.set('c', 'gamma');
expect(map.store.size).toBe(3);
expect(map.clear()).toBe(map);
expect(map.store.size).toBe(0);
});
test('delete', () => {
const map = new ChainedMap();
map.set('a', 'alpha');
map.set('b', 'beta');
map.set('c', 'gamma');
expect(map.delete('b')).toBe(map);
expect(map.store.size).toBe(2);
expect(map.store.has('b')).toBe(false);
});
test('has', () => {
const map = new ChainedMap();
map.set('a', 'alpha');
map.set('b', 'beta');
map.set('c', 'gamma');
expect(map.has('b')).toBe(true);
expect(map.has('d')).toBe(false);
expect(map.has('b')).toBe(map.store.has('b'));
});
test('values', () => {
const map = new ChainedMap();
map.set('a', 'alpha');
map.set('b', 'beta');
map.set('c', 'gamma');
expect(map.values()).toStrictEqual(['alpha', 'beta', 'gamma']);
});
test('entries with values', () => {
const map = new ChainedMap();
map.set('a', 'alpha');
map.set('b', 'beta');
map.set('c', 'gamma');
expect(map.entries()).toStrictEqual({ a: 'alpha', b: 'beta', c: 'gamma' });
});
test('entries with no values', () => {
const map = new ChainedMap();
expect(map.entries()).toBeUndefined();
});
test('merge with no values', () => {
const map = new ChainedMap();
const obj = { a: 'alpha', b: 'beta', c: 'gamma' };
expect(map.merge(obj)).toBe(map);
expect(map.entries()).toStrictEqual(obj);
});
test('merge with existing values', () => {
const map = new ChainedMap();
const obj = { a: 'alpha', b: 'beta', c: 'gamma' };
map.set('d', 'delta');
expect(map.merge(obj)).toBe(map);
expect(map.entries()).toStrictEqual({
a: 'alpha',
b: 'beta',
c: 'gamma',
d: 'delta',
});
});
test('merge with overriding values', () => {
const map = new ChainedMap();
const obj = { a: 'alpha', b: 'beta', c: 'gamma' };
map.set('b', 'delta');
expect(map.merge(obj)).toBe(map);
expect(map.entries()).toStrictEqual({ a: 'alpha', b: 'beta', c: 'gamma' });
});
test('merge with omitting keys', () => {
const map = new ChainedMap();
const obj = { a: 'alpha', b: 'beta', c: 'gamma' };
map.merge(obj, ['b']);
expect(map.entries()).toStrictEqual({ a: 'alpha', c: 'gamma' });
});
test('when true', () => {
const map = new ChainedMap();
const right = (instance) => {
expect(instance).toBe(map);
instance.set('alpha', 'a');
};
const left = (instance) => {
instance.set('beta', 'b');
};
expect(map.when(true, right, left)).toBe(map);
expect(map.has('alpha')).toBe(true);
expect(map.has('beta')).toBe(false);
});
test('when false', () => {
const map = new ChainedMap();
const right = (instance) => {
instance.set('alpha', 'a');
};
const left = (instance) => {
expect(instance).toBe(map);
instance.set('beta', 'b');
};
expect(map.when(false, right, left)).toBe(map);
expect(map.has('alpha')).toBe(false);
expect(map.has('beta')).toBe(true);
});
test('clean undefined', () => {
const map = new ChainedMap();
map.set('alpha', undefined);
map.set('beta', 'b');
expect('alpha' in map.entries()).toBe(true);
expect('alpha' in map.clean(map.entries())).toBe(false);
expect('beta' in map.clean(map.entries())).toBe(true);
});
test('clean empty array', () => {
const map = new ChainedMap();
map.set('alpha', []);
expect('alpha' in map.entries()).toBe(true);
expect('alpha' in map.clean(map.entries())).toBe(false);
});
test('clean empty object', () => {
const map = new ChainedMap();
map.set('alpha', {});
expect('alpha' in map.entries()).toBe(true);
expect('alpha' in map.clean(map.entries())).toBe(false);
});
================================================
FILE: test/ChainedSet.js
================================================
const ChainedSet = require('../src/ChainedSet');
test('is Chainable', () => {
const parent = { parent: true };
const set = new ChainedSet(parent);
expect(set.end()).toBe(parent);
});
test('creates a backing Set', () => {
const set = new ChainedSet();
expect(set.store instanceof Set).toBe(true);
});
test('add', () => {
const set = new ChainedSet();
expect(set.add('alpha')).toBe(set);
expect(set.store.has('alpha')).toBe(true);
expect(set.store.size).toBe(1);
});
test('prepend', () => {
const set = new ChainedSet();
set.add('alpha');
expect(set.prepend('beta')).toBe(set);
expect(set.store.has('beta')).toBe(true);
expect([...set.store]).toStrictEqual(['beta', 'alpha']);
});
test('clear', () => {
const set = new ChainedSet();
set.add('alpha');
set.add('beta');
set.add('gamma');
expect(set.store.size).toBe(3);
expect(set.clear()).toBe(set);
expect(set.store.size).toBe(0);
});
test('delete', () => {
const set = new ChainedSet();
set.add('alpha');
set.add('beta');
set.add('gamma');
expect(set.delete('beta')).toBe(set);
expect(set.store.size).toBe(2);
expect(set.store.has('beta')).toBe(false);
});
test('has', () => {
const set = new ChainedSet();
set.add('alpha');
set.add('beta');
set.add('gamma');
expect(set.has('beta')).toBe(true);
expect(set.has('delta')).toBe(false);
expect(set.has('beta')).toBe(set.store.has('beta'));
});
test('values', () => {
const set = new ChainedSet();
set.add('alpha');
set.add('beta');
set.add('gamma');
expect(set.values()).toStrictEqual(['alpha', 'beta', 'gamma']);
});
test('merge with no values', () => {
const set = new ChainedSet();
const arr = ['alpha', 'beta', 'gamma'];
expect(set.merge(arr)).toBe(set);
expect(set.values()).toStrictEqual(arr);
});
test('merge with existing values', () => {
const set = new ChainedSet();
const arr = ['alpha', 'beta', 'gamma'];
set.add('delta');
expect(set.merge(arr)).toBe(set);
expect(set.values()).toStrictEqual(['delta', 'alpha', 'beta', 'gamma']);
});
test('when true', () => {
const set = new ChainedSet();
const right = (instance) => {
expect(instance).toBe(set);
instance.add('alpha');
};
const left = (instance) => {
instance.add('beta');
};
expect(set.when(true, right, left)).toBe(set);
expect(set.has('alpha')).toBe(true);
expect(set.has('beta')).toBe(false);
});
test('when false', () => {
const set = new ChainedSet();
const right = (instance) => {
instance.add('alpha');
};
const left = (instance) => {
expect(instance).toBe(set);
instance.add('beta');
};
expect(set.when(false, right, left)).toBe(set);
expect(set.has('alpha')).toBe(false);
expect(set.has('beta')).toBe(true);
});
================================================
FILE: test/Config.js
================================================
/* eslint-disable max-classes-per-file */
const { validate } = require('webpack');
const { stringify } = require('javascript-stringify');
const EnvironmentPlugin = require('webpack/lib/EnvironmentPlugin');
const Config = require('../src/Config');
class StringifyPlugin {
constructor(...args) {
this.values = args;
}
apply() {
return JSON.stringify(this.values);
}
}
test('is ChainedMap', () => {
const config = new Config();
config.set('a', 'alpha');
expect(config.store.get('a')).toBe('alpha');
});
test('shorthand methods', () => {
const config = new Config();
const obj = {};
config.shorthands.forEach((method) => {
obj[method] = 'alpha';
expect(config[method]('alpha')).toBe(config);
});
expect(config.entries()).toStrictEqual(obj);
});
test('node', () => {
const config = new Config();
const instance = config.node
.set('__dirname', 'mock')
.set('__filename', 'mock')
.end();
expect(instance).toBe(config);
expect(config.node.entries()).toStrictEqual({
__dirname: 'mock',
__filename: 'mock',
});
});
test('entry', () => {
const config = new Config();
config.entry('index').add('babel-polyfill').add('src/index.js');
expect(config.entryPoints.has('index')).toBe(true);
expect(config.entryPoints.get('index').values()).toStrictEqual([
'babel-polyfill',
'src/index.js',
]);
});
test('plugin empty', () => {
const config = new Config();
const instance = config.plugin('stringify').use(StringifyPlugin).end();
expect(instance).toBe(config);
expect(config.plugins.has('stringify')).toBe(true);
expect(config.plugins.get('stringify').get('args')).toStrictEqual([]);
});
test('plugin with args', () => {
const config = new Config();
config.plugin('stringify').use(StringifyPlugin, ['alpha', 'beta']);
expect(config.plugins.has('stringify')).toBe(true);
expect(config.plugins.get('stringify').get('args')).toStrictEqual([
'alpha',
'beta',
]);
});
test('toConfig empty', () => {
const config = new Config();
expect(config.toConfig()).toStrictEqual({});
});
test('toConfig with values', () => {
const config = new Config();
config.output
.path('build')
.end()
.mode('development')
.node.set('__dirname', 'mock')
.end()
.optimization.nodeEnv('PRODUCTION')
.minimizer('stringify')
.use(StringifyPlugin)
.end()
.end()
.target('node')
.plugin('stringify')
.use(StringifyPlugin)
.end()
.plugin('env')
.use(require.resolve('webpack/lib/EnvironmentPlugin'))
.end()
.module.defaultRule('inline')
.use('banner')
.loader('banner-loader')
.options({ prefix: 'banner-prefix.txt' })
.end()
.end()
.rule('compile')
.include.add('alpha')
.add('beta')
.end()
.exclude.add('alpha')
.add('beta')
.end()
.post()
.pre()
.test(/\.js$/)
.use('babel')
.loader('babel-loader')
.options({ presets: ['alpha'] });
expect(config.toConfig()).toStrictEqual({
mode: 'development',
node: {
__dirname: 'mock',
},
optimization: {
nodeEnv: 'PRODUCTION',
minimizer: [new StringifyPlugin()],
},
output: {
path: 'build',
},
target: 'node',
plugins: [new StringifyPlugin(), new EnvironmentPlugin()],
module: {
defaultRules: [
{
use: [
{
loader: 'banner-loader',
options: { prefix: 'banner-prefix.txt' },
},
],
},
],
rules: [
{
include: ['alpha', 'beta'],
exclude: ['alpha', 'beta'],
enforce: 'pre',
test: /\.js$/,
use: [
{
loader: 'babel-loader',
options: { presets: ['alpha'] },
},
],
},
],
},
});
});
test('merge empty', () => {
const config = new Config();
const obj = {
mode: 'development',
node: {
__dirname: 'mock',
},
optimization: {
nodeEnv: 'PRODUCTION',
},
output: {
path: 'build',
},
target: 'node',
entry: {
index: ['babel-polyfill', 'src/index.js'],
},
plugin: { stringify: { plugin: new StringifyPlugin(), args: [] } },
};
const instance = config.merge(obj);
expect(instance).toBe(config);
expect(config.toConfig()).toStrictEqual({
mode: 'development',
node: {
__dirname: 'mock',
},
optimization: {
nodeEnv: 'PRODUCTION',
},
output: {
path: 'build',
},
target: 'node',
entry: {
index: ['babel-polyfill', 'src/index.js'],
},
plugins: [new StringifyPlugin()],
});
});
test('merge with values', () => {
const config = new Config();
config.output
.path('build')
.end()
.mode('development')
.node.set('__dirname', 'mock')
.end()
.optimization.nodeEnv('PRODUCTION')
.end()
.entry('index')
.add('babel-polyfill')
.end()
.target('node')
.plugin('stringify')
.use(StringifyPlugin)
.end();
const obj = {
mode: 'production',
output: {
path: 'build',
},
target: 'browser',
entry: {
index: 'src/index.js',
},
plugin: { env: { plugin: new EnvironmentPlugin() } },
};
const instance = config.merge(obj);
expect(instance).toBe(config);
expect(config.toConfig()).toStrictEqual({
mode: 'production',
node: {
__dirname: 'mock',
},
optimization: {
nodeEnv: 'PRODUCTION',
},
output: {
path: 'build',
},
target: 'browser',
entry: {
index: ['babel-polyfill', 'src/index.js'],
},
plugins: [new StringifyPlugin(), new EnvironmentPlugin()],
});
});
test('merge with omit', () => {
const config = new Config();
config.output
.path('build')
.end()
.mode('development')
.node.set('__dirname', 'mock')
.end()
.optimization.nodeEnv('PRODUCTION')
.end()
.entry('index')
.add('babel-polyfill')
.end()
.target('node')
.plugin('stringify')
.use(StringifyPlugin)
.end();
const obj = {
mode: 'production',
output: {
path: 'build',
},
target: 'browser',
entry: {
index: 'src/index.js',
},
plugin: { env: { plugin: new EnvironmentPlugin() } },
};
const instance = config.merge(obj, ['target']);
expect(instance).toBe(config);
expect(config.toConfig()).toStrictEqual({
mode: 'production',
node: {
__dirname: 'mock',
},
optimization: {
nodeEnv: 'PRODUCTION',
},
output: {
path: 'build',
},
target: 'node',
entry: {
index: ['babel-polyfill', 'src/index.js'],
},
plugins: [new StringifyPlugin(), new EnvironmentPlugin()],
});
});
test('validate empty', () => {
const config = new Config();
const errors = validate(config.toConfig());
expect(errors).toHaveLength(0);
});
test('validate with entry', () => {
const config = new Config();
config.entry('index').add('src/index.js');
const errors = validate(config.toConfig());
expect(errors).toHaveLength(0);
});
test('validate with values', () => {
const config = new Config();
config
.entry('index')
.add('babel-polyfill')
.add('src/index.js')
.end()
.output.path('/build')
.end()
.mode('development')
.optimization.nodeEnv('PRODUCTION')
.end()
.node.set('__dirname', 'mock')
.end()
.target('node')
.plugin('stringify')
.use(StringifyPlugin)
.end()
.plugin('env')
.use(require.resolve('webpack/lib/EnvironmentPlugin'), [{ VAR: false }])
.end()
.module.rule('compile')
.include.add('/alpha')
.add('/beta')
.end()
.exclude.add('/alpha')
.add('/beta')
.end()
.sideEffects(false)
.post()
.pre()
.test(/\.js$/)
.use('babel')
.loader('babel-loader')
.options({ presets: ['alpha'] });
const errors = validate(config.toConfig());
expect(errors).toHaveLength(0);
});
test('toString', () => {
const config = new Config();
config.module.rule('alpha').oneOf('beta').use('babel').loader('babel-loader');
// Nested rules
config.module
.rule('alpha')
.rule('nested')
.use('babel')
.loader('babel-loader');
// Default rules
config.module
.defaultRule('default')
.rule('nested')
.use('babel')
.loader('babel-loader');
const envPluginPath = require.resolve('webpack/lib/EnvironmentPlugin');
const stringifiedEnvPluginPath = stringify(envPluginPath);
class FooPlugin {}
FooPlugin.__expression = `require('foo-plugin')`;
config
.plugin('env')
.use(envPluginPath, [{ VAR: false }])
.end()
.plugin('gamma')
.use(FooPlugin)
.end()
.plugin('delta')
.use(class BarPlugin {}, ['bar'])
.end()
.plugin('epsilon')
.use(class BazPlugin {}, [{ n: 1 }, [2, 3]]);
config.resolve.plugin('resolver').use(FooPlugin);
config.optimization.minimizer('minifier').use(FooPlugin);
expect(config.toString().trim()).toBe(
`
{
resolve: {
plugins: [
/* config.resolve.plugin('resolver') */
new (require('foo-plugin'))()
]
},
module: {
defaultRules: [
/* config.module.defaultRule('default') */
{
rules: [
/* config.module.defaultRule('default').rule('nested') */
{
use: [
/* config.module.defaultRule('default').rule('nested').use('babel') */
{
loader: 'babel-loader'
}
]
}
]
}
],
rules: [
/* config.module.rule('alpha') */
{
rules: [
/* config.module.rule('alpha').rule('nested') */
{
use: [
/* config.module.rule('alpha').rule('nested').use('babel') */
{
loader: 'babel-loader'
}
]
}
],
oneOf: [
/* config.module.rule('alpha').oneOf('beta') */
{
use: [
/* config.module.rule('alpha').oneOf('beta').use('babel') */
{
loader: 'babel-loader'
}
]
}
]
}
]
},
optimization: {
minimizer: [
/* config.optimization.minimizer('minifier') */
new (require('foo-plugin'))()
]
},
plugins: [
/* config.plugin('env') */
new (require(${stringifiedEnvPluginPath}))(
{
VAR: false
}
),
/* config.plugin('gamma') */
new (require('foo-plugin'))(),
/* config.plugin('delta') */
new BarPlugin(
'bar'
),
/* config.plugin('epsilon') */
new BazPlugin(
{
n: 1
},
[
2,
3
]
)
]
}
`.trim(),
);
});
test('toString for functions with custom expression', () => {
const fn = function foo() {};
fn.__expression = `require('foo')`;
const config = new Config();
config.module.rule('alpha').include.add(fn);
expect(config.toString().trim()).toBe(
`
{
module: {
rules: [
/* config.module.rule('alpha') */
{
include: [
require('foo')
]
}
]
}
}
`.trim(),
);
});
test('toString with custom prefix', () => {
const config = new Config();
config.plugin('foo').use(class TestPlugin {});
expect(config.toString({ configPrefix: 'neutrino.config' }).trim()).toBe(
`
{
plugins: [
/* neutrino.config.plugin('foo') */
new TestPlugin()
]
}
`.trim(),
);
});
test('static Config.toString', () => {
const config = new Config();
const sass = {
__expression: `require('sass')`,
render() {},
};
config.plugin('foo').use(class TestPlugin {});
expect(
Config.toString(
Object.assign(config.toConfig(), {
module: {
defaultRules: [
{
use: [
{
loader: 'banner-loader',
options: {
prefix: 'banner-prefix.txt',
implementation: sass,
},
},
],
},
],
},
}),
).trim(),
).toBe(
`
{
plugins: [
/* config.plugin('foo') */
new TestPlugin()
],
module: {
defaultRules: [
{
use: [
{
loader: 'banner-loader',
options: {
prefix: 'banner-prefix.txt',
implementation: require('sass')
}
}
]
}
]
}
}
`.trim(),
);
});
================================================
FILE: test/DevServer.js
================================================
const DevServer = require('../src/DevServer');
test('is Chainable', () => {
const parent = { parent: true };
const devServer = new DevServer(parent);
expect(devServer.end()).toBe(parent);
});
test('sets allowed hosts', () => {
const devServer = new DevServer();
const instance = devServer.allowedHosts.add('https://github.com').end();
expect(instance).toBe(devServer);
expect(devServer.toConfig()).toStrictEqual({
allowedHosts: ['https://github.com'],
});
});
test('shorthand methods', () => {
const devServer = new DevServer();
const obj = {};
devServer.shorthands.forEach((method) => {
obj[method] = 'alpha';
expect(devServer[method]('alpha')).toBe(devServer);
});
expect(devServer.entries()).toStrictEqual(obj);
});
================================================
FILE: test/Module.js
================================================
const Module = require('../src/Module');
test('is Chainable', () => {
const parent = { parent: true };
const module = new Module(parent);
expect(module.end()).toBe(parent);
});
test('is ChainedMap', () => {
const module = new Module();
module.set('a', 'alpha');
expect(module.get('a')).toBe('alpha');
});
test('rule', () => {
const module = new Module();
const instance = module.rule('compile').end();
expect(instance).toBe(module);
expect(module.rules.has('compile')).toBe(true);
});
test('defaultRule', () => {
const module = new Module();
const instance = module.defaultRule('banner').end();
expect(instance).toBe(module);
expect(module.defaultRules.has('banner')).toBe(true);
});
test('toConfig empty', () => {
const module = new Module();
expect(module.toConfig()).toStrictEqual({});
});
test('toConfig with values', () => {
const module = new Module();
module.rule('compile').test(/\.js$/);
module.noParse(/.min.js/);
expect(module.toConfig()).toStrictEqual({
rules: [{ test: /\.js$/ }],
noParse: /.min.js/,
});
});
================================================
FILE: test/Optimization.js
================================================
const Optimization = require('../src/Optimization');
class StringifyPlugin {
constructor(...args) {
this.values = args;
}
apply() {
return JSON.stringify(this.values);
}
}
test('is Chainable', () => {
const parent = { parent: true };
const optimization = new Optimization(parent);
expect(optimization.end()).toBe(parent);
});
test('shorthand methods', () => {
const optimization = new Optimization();
const obj = {};
optimization.shorthands.forEach((method) => {
obj[method] = 'alpha';
expect(optimization[method]('alpha')).toBe(optimization);
});
expect(optimization.entries()).toStrictEqual(obj);
});
test('minimizer plugin with name', () => {
const optimization = new Optimization();
optimization.minimizer('alpha');
expect(optimization.minimizers.get('alpha').name).toBe('alpha');
expect(optimization.minimizers.get('alpha').type).toBe(
'optimization.minimizer',
);
});
test('minimizer plugin empty', () => {
const optimization = new Optimization();
const instance = optimization
.minimizer('stringify')
.use(StringifyPlugin)
.end();
expect(instance).toBe(optimization);
expect(optimization.minimizers.has('stringify')).toBe(true);
expect(optimization.minimizers.get('stringify').get('args')).toStrictEqual(
[],
);
});
test('minimizer plugin with args', () => {
const optimization = new Optimization();
optimization.minimizer('stringify').use(StringifyPlugin, ['alpha', 'beta']);
expect(optimization.minimizers.has('stringify')).toBe(true);
expect(optimization.minimizers.get('stringify').get('args')).toStrictEqual([
'alpha',
'beta',
]);
});
test('minimizer plugin legacy syntax', () => {
const optimization = new Optimization();
expect(() => optimization.minimizer([new StringifyPlugin()])).toThrow(
/optimization.minimizer\(\) no longer supports being passed an array/,
);
});
test('optimization merge', () => {
const optimization = new Optimization();
const obj = {
minimizer: {
stringify: {
plugin: StringifyPlugin,
args: ['alpha', 'beta'],
},
},
};
expect(optimization.merge(obj)).toBe(optimization);
expect(optimization.minimizers.has('stringify')).toBe(true);
expect(optimization.minimizers.get('stringify').get('args')).toStrictEqual([
'alpha',
'beta',
]);
});
test('toConfig empty', () => {
const optimization = new Optimization();
expect(optimization.toConfig()).toStrictEqual({});
});
test('toConfig with values', () => {
const optimization = new Optimization();
optimization.minimizer('foo').use(StringifyPlugin).end().splitChunks({
chunks: 'all',
});
expect(optimization.toConfig()).toStrictEqual({
minimizer: [new StringifyPlugin()],
splitChunks: {
chunks: 'all',
},
});
});
================================================
FILE: test/Orderable.js
================================================
const Orderable = require('../src/Orderable');
const ChainedMap = require('../src/ChainedMap');
const Ordered = Orderable(class Test extends ChainedMap {});
test('before', () => {
const ordered = new Ordered();
const instance = ordered.set('gamma').before('beta');
expect(instance).toBe(ordered);
expect(ordered.__before).toBe('beta');
});
test('after', () => {
const ordered = new Ordered();
const instance = ordered.set('gamma').after('alpha');
expect(instance).toBe(ordered);
expect(ordered.__after).toBe('alpha');
});
test('before throws with after', () => {
const ordered = new Ordered();
expect(() => ordered.after('alpha').before('beta')).toThrow();
});
test('after throws with before', () => {
const ordered = new Ordered();
expect(() => ordered.before('beta').after('alpha')).toThrow();
});
test('ordering before', () => {
const map = new ChainedMap();
map.set('beta', new Ordered().set('beta', 'beta'));
map.set('alpha', new Ordered().set('alpha', 'alpha').before('beta'));
expect(map.values().map((o) => o.values())).toStrictEqual([
['alpha'],
['beta'],
]);
});
test('ordering after', () => {
const map = new ChainedMap();
map.set('beta', new Ordered().set('beta', 'beta').after('alpha'));
map.set('alpha', new Ordered().set('alpha', 'alpha'));
expect(map.values().map((o) => o.values())).toStrictEqual([
['alpha'],
['beta'],
]);
});
test('ordering before and after', () => {
const map = new ChainedMap();
map.set('beta', new Ordered().set('beta', 'beta'));
map.set('gamma', new Ordered().set('gamma', 'gamma').after('beta'));
map.set('alpha', new Ordered().set('alpha', 'alpha').before('beta'));
expect(map.values().map((o) => o.values())).toStrictEqual([
['alpha'],
['beta'],
['gamma'],
]);
});
test('merge with before', () => {
const ordered = new Ordered();
const instance = ordered.set('gamma').merge({
before: 'beta',
});
expect(instance).toBe(ordered);
expect(ordered.__before).toBe('beta');
});
test('merge with after', () => {
const ordered = new Ordered();
const instance = ordered.set('gamma').merge({
after: 'alpha',
});
expect(instance).toBe(ordered);
expect(ordered.__after).toBe('alpha');
});
test('merging throws using before with after', () => {
expect(() =>
new Ordered().merge({ before: 'beta', after: 'alpha' }),
).toThrow();
});
================================================
FILE: test/Output.js
================================================
const Output = require('../src/Output');
test('is Chainable', () => {
const parent = { parent: true };
const output = new Output(parent);
expect(output.end()).toBe(parent);
});
test('shorthand methods', () => {
const output = new Output();
const obj = {};
output.shorthands.forEach((method) => {
obj[method] = 'alpha';
expect(output[method]('alpha')).toBe(output);
});
expect(output.entries()).toStrictEqual(obj);
});
================================================
FILE: test/Performance.js
================================================
const Performance = require('../src/Performance');
test('is Chainable', () => {
const parent = { parent: true };
const performance = new Performance(parent);
expect(performance.end()).toBe(parent);
});
test('shorthand methods', () => {
const performance = new Performance();
const obj = {};
performance.shorthands.forEach((method) => {
obj[method] = 'alpha';
expect(performance[method]('alpha')).toBe(performance);
});
expect(performance.entries()).toStrictEqual(obj);
});
================================================
FILE: test/Plugin.js
================================================
/* eslint-disable max-classes-per-file */
const EnvironmentPlugin = require('webpack/lib/EnvironmentPlugin');
const Plugin = require('../src/Plugin');
class StringifyPlugin {
constructor(...args) {
this.values = args;
}
apply() {
return JSON.stringify(this.values);
}
}
test('is Chainable', () => {
const parent = { parent: true };
const plugin = new Plugin(parent);
expect(plugin.end()).toBe(parent);
});
test('use', () => {
const plugin = new Plugin();
const instance = plugin.use(StringifyPlugin, ['alpha', 'beta']);
expect(instance).toBe(plugin);
expect(plugin.get('plugin')).toBe(StringifyPlugin);
expect(plugin.get('args')).toStrictEqual(['alpha', 'beta']);
});
test('tap', () => {
const plugin = new Plugin();
plugin.use(StringifyPlugin, ['alpha', 'beta']);
const instance = plugin.tap(() => ['gamma', 'delta']);
expect(instance).toBe(plugin);
expect(plugin.get('args')).toStrictEqual(['gamma', 'delta']);
});
test('init', () => {
const plugin = new Plugin();
plugin.use(StringifyPlugin);
const instance = plugin.init((Plugin, args) => {
expect(args).toStrictEqual([]);
return new Plugin('gamma', 'delta');
});
const initialized = plugin.get('init')(
plugin.get('plugin'),
plugin.get('args'),
);
expect(instance).toBe(plugin);
expect(initialized instanceof StringifyPlugin).toBe(true);
expect(initialized.values).toStrictEqual(['gamma', 'delta']);
});
test('args is validated as being an array', () => {
const plugin = new Plugin();
expect(() => plugin.use(StringifyPlugin, { foo: true })).toThrow(
'args must be an array of arguments',
);
plugin.use(StringifyPlugin);
expect(() => plugin.tap(() => ({ foo: true }))).toThrow(
'args must be an array of arguments',
);
expect(() => plugin.merge({ args: 5000 })).toThrow(
'args must be an array of arguments',
);
expect(() => plugin.set('args', null)).toThrow(
'args must be an array of arguments',
);
});
test('toConfig', () => {
const plugin = new Plugin(null, 'gamma');
plugin.use(StringifyPlugin, ['delta']);
const initialized = plugin.toConfig();
expect(initialized instanceof StringifyPlugin).toBe(true);
expect(initialized.values).toStrictEqual(['delta']);
expect(initialized.__pluginName).toBe('gamma');
expect(initialized.__pluginType).toBe('plugin');
expect(initialized.__pluginArgs).toStrictEqual(['delta']);
expect(initialized.__pluginConstructorName).toBe('StringifyPlugin');
});
test('toConfig with custom type', () => {
const plugin = new Plugin(null, 'gamma', 'optimization.minimizer');
plugin.use(StringifyPlugin);
expect(plugin.toConfig().__pluginType).toBe('optimization.minimizer');
});
test('toConfig with custom expression', () => {
const plugin = new Plugin(null, 'gamma');
class TestPlugin {}
TestPlugin.__expression = `require('my-plugin')`;
plugin.use(TestPlugin);
const initialized = plugin.toConfig();
expect(initialized.__pluginConstructorName).toBe(`(require('my-plugin'))`);
});
test('toConfig with object literal plugin', () => {
const plugin = new Plugin(null, 'gamma');
const TestPlugin = {
apply() {},
};
plugin.use(TestPlugin);
const initialized = plugin.toConfig();
expect(initialized).toBe(TestPlugin);
});
test('toConfig with plugin as path', () => {
const plugin = new Plugin(null, 'gamma');
const envPluginPath = require.resolve('webpack/lib/EnvironmentPlugin');
plugin.use(envPluginPath);
const initialized = plugin.toConfig();
expect(initialized instanceof EnvironmentPlugin).toBe(true);
expect(initialized.__pluginConstructorName).toBe('EnvironmentPlugin');
expect(initialized.__pluginPath).toBe(envPluginPath);
});
test('toConfig without having called use()', () => {
const plugin = new Plugin(null, 'gamma', 'optimization.minimizer');
expect(() => plugin.toConfig()).toThrow(
"Invalid optimization.minimizer configuration: optimization.minimizer('gamma').use(<Plugin>) was not called to specify the plugin",
);
});
test('tap() without having called use()', () => {
const plugin = new Plugin(null, 'gamma', 'optimization.minimizer');
expect(() => plugin.tap(() => [])).toThrow(
"Cannot call .tap() on a plugin that has not yet been defined. Call optimization.minimizer('gamma').use(<Plugin>) first.",
);
});
================================================
FILE: test/Resolve.js
================================================
const Resolve = require('../src/Resolve');
class StringifyPlugin {
constructor(...args) {
this.values = args;
}
apply() {
return JSON.stringify(this.values);
}
}
test('is Chainable', () => {
const parent = { parent: true };
const resolve = new Resolve(parent);
expect(resolve.end()).toBe(parent);
});
test('shorthand methods', () => {
const resolve = new Resolve();
const obj = {};
resolve.shorthands.forEach((method) => {
obj[method] = 'alpha';
expect(resolve[method]('alpha')).toBe(resolve);
});
expect(resolve.entries()).toStrictEqual(obj);
});
test('sets methods', () => {
const resolve = new Resolve();
const instance = resolve.modules.add('src').end().extensions.add('.js').end();
expect(instance).toBe(resolve);
});
test('toConfig empty', () => {
const resolve = new Resolve();
expect(resolve.toConfig()).toStrictEqual({});
});
test('toConfig with values', () => {
const resolve = new Resolve();
resolve
.plugin('stringify')
.use(StringifyPlugin)
.end()
.modules.add('src')
.end()
.extensions.add('.js')
.end()
.alias.set('React', 'src/react');
expect(resolve.toConfig()).toStrictEqual({
plugins: [new StringifyPlugin()],
modules: ['src'],
extensions: ['.js'],
alias: { React: 'src/react' },
});
});
test('merge empty', () => {
const resolve = new Resolve();
const obj = {
modules: ['src'],
extensions: ['.js'],
alias: { React: 'src/react' },
};
const instance = resolve.merge(obj);
expect(instance).toBe(resolve);
expect(resolve.toConfig()).toStrictEqual(obj);
});
test('merge with values', () => {
const resolve = new Resolve();
resolve.modules
.add('src')
.end()
.extensions.add('.js')
.end()
.alias.set('React', 'src/react');
resolve.merge({
modules: ['dist'],
extensions: ['.jsx'],
alias: { ReactDOM: 'src/react-dom' },
});
expect(resolve.toConfig()).toStrictEqual({
modules: ['src', 'dist'],
extensions: ['.js', '.jsx'],
alias: { React: 'src/react', ReactDOM: 'src/react-dom' },
});
});
test('merge with omit', () => {
const resolve = new Resolve();
resolve.modules
.add('src')
.end()
.extensions.add('.js')
.end()
.alias.set('React', 'src/react');
resolve.merge(
{
modules: ['dist'],
extensions: ['.jsx'],
alias: { ReactDOM: 'src/react-dom' },
},
['alias'],
);
expect(resolve.toConfig()).toStrictEqual({
modules: ['src', 'dist'],
extensions: ['.js', '.jsx'],
alias: { React: 'src/react' },
});
});
test('plugin with name', () => {
const resolve = new Resolve();
resolve.plugin('alpha');
expect(resolve.plugins.get('alpha').name).toBe('alpha');
expect(resolve.plugins.get('alpha').type).toBe('resolve.plugin');
});
test('plugin empty', () => {
const resolve = new Resolve();
const instance = resolve.plugin('stringify').use(StringifyPlugin).end();
expect(instance).toBe(resolve);
expect(resolve.plugins.has('stringify')).toBe(true);
expect(resolve.plugins.get('stringify').get('args')).toStrictEqual([]);
});
test('plugin with args', () => {
const resolve = new Resolve();
resolve.plugin('stringify').use(StringifyPlugin, ['alpha', 'beta']);
expect(resolve.plugins.has('stringify')).toBe(true);
expect(resolve.plugins.get('stringify').get('args')).toStrictEqual([
'alpha',
'beta',
]);
});
================================================
FILE: test/ResolveLoader.js
================================================
const ResolveLoader = require('../src/ResolveLoader');
test('is Chainable', () => {
const parent = { parent: true };
const resolveLoader = new ResolveLoader(parent);
expect(resolveLoader.end()).toBe(parent);
});
test('shorthand methods', () => {
const resolveLoader = new ResolveLoader();
const obj = {};
resolveLoader.shorthands.forEach((method) => {
obj[method] = 'alpha';
expect(resolveLoader[method]('alpha')).toBe(resolveLoader);
});
expect(resolveLoader.entries()).toStrictEqual(obj);
});
test('sets methods', () => {
const resolveLoader = new ResolveLoader();
const instance = resolveLoader.modules.add('src').end();
expect(instance).toBe(resolveLoader);
expect(resolveLoader.toConfig()).toStrictEqual({ modules: ['src'] });
});
test('toConfig empty', () => {
const resolveLoader = new ResolveLoader();
expect(resolveLoader.toConfig()).toStrictEqual({});
});
test('toConfig with values', () => {
const resolveLoader = new ResolveLoader();
resolveLoader.modules.add('src').end().set('moduleExtensions', ['-loader']);
expect(resolveLoader.toConfig()).toStrictEqual({
modules: ['src'],
moduleExtensions: ['-loader'],
});
});
test('merge empty', () => {
const resolveLoader = new ResolveLoader();
const obj = {
modules: ['src'],
moduleExtensions: ['-loader'],
};
const instance = resolveLoader.merge(obj);
expect(instance).toBe(resolveLoader);
expect(resolveLoader.toConfig()).toStrictEqual(obj);
});
test('merge with values', () => {
const resolveLoader = new ResolveLoader();
resolveLoader.modules.add('src').end().moduleExtensions.add('-loader');
resolveLoader.merge({
modules: ['dist'],
moduleExtensions: ['-fake'],
});
expect(resolveLoader.toConfig()).toStrictEqual({
modules: ['src', 'dist'],
moduleExtensions: ['-loader', '-fake'],
});
});
test('merge with omit', () => {
const resolveLoader = new ResolveLoader();
resolveLoader.modules.add('src').end().moduleExtensions.add('-loader');
resolveLoader.merge(
{
modules: ['dist'],
moduleExtensions: ['-fake'],
},
['moduleExtensions'],
);
expect(resolveLoader.toConfig()).toStrictEqual({
modules: ['src', 'dist'],
moduleExtensions: ['-loader'],
});
});
test('plugin with name', () => {
const resolveLoader = new ResolveLoader();
resolveLoader.plugin('alpha');
expect(resolveLoader.plugins.get('alpha').name).toBe('alpha');
});
================================================
FILE: test/Rule.js
================================================
const Rule = require('../src/Rule');
test('is Chainable', () => {
const parent = { parent: true };
const rule = new Rule(parent);
expect(rule.end()).toBe(parent);
});
test('shorthand methods', () => {
const rule = new Rule();
const obj = {};
rule.shorthands.forEach((method) => {
obj[method] = 'alpha';
expect(rule[method]('alpha')).toBe(rule);
});
expect(rule.entries()).toStrictEqual(obj);
});
test('use', () => {
const rule = new Rule();
const instance = rule.use('babel').end();
expect(instance).toBe(rule);
expect(rule.uses.has('babel')).toBe(true);
});
test('rule', () => {
const rule = new Rule();
const instance = rule.rule('babel').end();
expect(instance).toBe(rule);
expect(rule.rules.has('babel')).toBe(true);
});
test('oneOf', () => {
const rule = new Rule();
const instance = rule.oneOf('babel').end();
expect(instance).toBe(rule);
expect(rule.oneOfs.has('babel')).toBe(true);
});
test('resolve', () => {
const rule = new Rule();
const instance = rule.resolve.alias.set('foo', 'bar').end().end();
expect(instance).toBe(rule);
expect(rule.resolve.alias.has('foo')).toBe(true);
});
test('pre', () => {
const rule = new Rule();
const instance = rule.pre();
expect(instance).toBe(rule);
expect(rule.get('enforce')).toBe('pre');
});
test('post', () => {
const rule = new Rule();
const instance = rule.post();
expect(instance).toBe(rule);
expect(rule.get('enforce')).toBe('post');
});
test('sets methods', () => {
const rule = new Rule();
const instance = rule.include
.add('alpha')
.add('beta')
.end()
.exclude.add('alpha')
.add('beta')
.end();
expect(instance).toBe(rule);
expect(rule.include.values()).toStrictEqual(['alpha', 'beta']);
expect(rule.exclude.values()).toStrictEqual(['alpha', 'beta']);
});
test('toConfig empty', () => {
const rule = new Rule();
expect(rule.toConfig()).toStrictEqual({});
});
test('toConfig with name', () => {
const parent = new Rule(null, 'alpha');
const child = parent.oneOf('beta');
const grandChild = child.oneOf('gamma');
const ruleChild = parent.rule('delta');
expect(parent.toConfig().__ruleNames).toStrictEqual(['alpha']);
expect(parent.toConfig().__ruleTypes).toStrictEqual(['rule']);
expect(child.toConfig().__ruleNames).toStrictEqual(['alpha', 'beta']);
expect(child.toConfig().__ruleTypes).toStrictEqual(['rule', 'oneOf']);
expect(grandChild.toConfig().__ruleNames).toStrictEqual([
'alpha',
'beta',
'gamma',
]);
expect(grandChild.toConfig().__ruleTypes).toStrictEqual([
'rule',
'oneOf',
'oneOf',
]);
expect(ruleChild.toConfig().__ruleNames).toStrictEqual(['alpha', 'delta']);
expect(ruleChild.toConfig().__ruleTypes).toStrictEqual(['rule', 'rule']);
});
test('toConfig with values', () => {
const rule = new Rule();
rule.include
.add('alpha')
.add('beta')
.end()
.exclude.add('alpha')
.add('beta')
.end()
.post()
.pre()
.test(/\.js$/)
.use('babel')
.loader('babel-loader')
.options({ presets: ['alpha'] })
.end()
.rule('minifier')
.resourceQuery(/minify/)
.use('minifier')
.loader('minifier-loader')
.end()
.end()
.oneOf('inline')
.resourceQuery(/inline/)
.use('url')
.loader('url-loader');
expect(rule.toConfig()).toStrictEqual({
test: /\.js$/,
enforce: 'pre',
include: ['alpha', 'beta'],
exclude: ['alpha', 'beta'],
rules: [
{
resourceQuery: /minify/,
use: [
{
loader: 'minifier-loader',
},
],
},
],
oneOf: [
{
resourceQuery: /inline/,
use: [
{
loader: 'url-loader',
},
],
},
],
use: [
{
loader: 'babel-loader',
options: {
presets: ['alpha'],
},
},
],
});
});
test('toConfig with test function', () => {
const rule = new Rule();
const test = (s) => s.includes('.js');
rule.test(test);
expect(rule.toConfig()).toStrictEqual({ test });
});
test('merge empty', () => {
const rule = new Rule();
const obj = {
enforce: 'pre',
test: /\.js$/,
include: ['alpha', 'beta'],
exclude: ['alpha', 'beta'],
rules: {
minifier: {
resourceQuery: /minify/,
use: {
minifier: {
loader: 'minifier-loader',
},
},
},
},
oneOf: {
inline: {
resourceQuery: /inline/,
use: {
url: {
loader: 'url-loader',
},
},
},
},
use: {
babel: {
loader: 'babel-loader',
options: {
presets: ['alpha'],
},
},
},
};
const instance = rule.merge(obj);
expect(instance).toBe(rule);
expect(rule.toConfig()).toStrictEqual({
enforce: 'pre',
test: /\.js$/,
include: ['alpha', 'beta'],
exclude: ['alpha', 'beta'],
rules: [
{
resourceQuery: /minify/,
use: [
{
loader: 'minifier-loader',
},
],
},
],
oneOf: [
{
resourceQuery: /inline/,
use: [
{
loader: 'url-loader',
},
],
},
],
use: [
{
loader: 'babel-loader',
options: {
presets: ['alpha'],
},
},
],
});
});
test('merge with values', () => {
const rule = new Rule();
rule
.test(/\.js$/)
.post()
.include.add('gamma')
.add('delta')
.end()
.use('babel')
.loader('babel-loader')
.options({ presets: ['alpha'] });
rule.merge({
test: /\.jsx$/,
enforce: 'pre',
include: ['alpha', 'beta'],
exclude: ['alpha', 'beta'],
rules: {
minifier: {
resourceQuery: /minify/,
use: {
minifier: {
loader: 'minifier-loader',
},
},
},
},
oneOf: {
inline: {
resourceQuery: /inline/,
use: {
url: {
loader: 'url-loader',
},
},
},
},
use: {
babel: {
options: {
presets: ['beta'],
},
},
},
});
expect(rule.toConfig()).toStrictEqual({
test: /\.jsx$/,
enforce: 'pre',
include: ['gamma', 'delta', 'alpha', 'beta'],
exclude: ['alpha', 'beta'],
rules: [
{
resourceQuery: /minify/,
use: [
{
loader: 'minifier-loader',
},
],
},
],
oneOf: [
{
resourceQuery: /inline/,
use: [
{
loader: 'url-loader',
},
],
},
],
use: [
{
loader: 'babel-loader',
options: {
presets: ['alpha', 'beta'],
},
},
],
});
});
test('merge with omit', () => {
const rule = new Rule();
rule
.test(/\.js$/)
.post()
.include.add('gamma')
.add('delta')
.end()
.use('babel')
.loader('babel-loader')
.options({ presets: ['alpha'] });
rule.merge(
{
test: /\.jsx$/,
enforce: 'pre',
include: ['alpha', 'beta'],
exclude: ['alpha', 'beta'],
rules: {
minifier: {
resourceQuery: /minify/,
use: {
minifier: {
loader: 'minifier-loader',
},
},
},
},
oneOf: {
inline: {
resourceQuery: /inline/,
use: {
url: {
loader: 'url-loader',
},
},
},
},
use: {
babel: {
options: {
presets: ['beta'],
},
},
},
},
['use', 'oneOf', 'rules'],
);
expect(rule.toConfig()).toStrictEqual({
test: /\.jsx$/,
enforce: 'pre',
include: ['gamma', 'delta', 'alpha', 'beta'],
exclude: ['alpha', 'beta'],
use: [
{
loader: 'babel-loader',
options: {
presets: ['alpha'],
},
},
],
});
});
test('merge with include and exclude not of array type', () => {
const rule = new Rule();
rule.merge({
test: /\.jsx$/,
include: 'alpha',
exclude: 'alpha',
});
expect(rule.toConfig()).toStrictEqual({
test: /\.jsx$/,
include: ['alpha'],
exclude: ['alpha'],
});
});
test('merge with resolve', () => {
const rule = new Rule();
rule.merge({
resolve: {
alias: { foo: 'bar' },
},
});
rule.merge({
resolve: {
extensions: ['.js', '.mjs'],
},
});
expect(rule.toConfig()).toStrictEqual({
resolve: {
alias: { foo: 'bar' },
extensions: ['.js', '.mjs'],
},
});
});
test('ordered rules', () => {
const rule = new Rule();
rule
.rule('first')
.test(/\.first$/)
.end()
.rule('second')
.test(/\.second$/)
.end()
.rule('third')
.test(/\.third$/)
.end()
.rule('alpha')
.test(/\.alpha$/)
.before('first')
.end()
.rule('beta')
.test(/\.beta$/)
.after('second');
expect(rule.toConfig().rules.map((o) => o.test)).toStrictEqual([
/\.alpha$/,
/\.first$/,
/\.second$/,
/\.beta$/,
/\.third$/,
]);
});
test('ordered oneOfs', () => {
const rule = new Rule();
rule
.oneOf('first')
.test(/\.first$/)
.end()
.oneOf('second')
.test(/\.second$/)
.end()
.oneOf('third')
.test(/\.third$/)
.end()
.oneOf('alpha')
.test(/\.alpha$/)
.before('first')
.end()
.oneOf('beta')
.test(/\.beta$/)
.after('second');
expect(rule.toConfig().oneOf.map((o) => o.test)).toStrictEqual([
/\.alpha$/,
/\.first$/,
/\.second$/,
/\.beta$/,
/\.third$/,
]);
});
================================================
FILE: test/Use.js
================================================
const Rule = require('../src/Rule');
const Use = require('../src/Use');
test('is Chainable', () => {
const parent = { parent: true };
const use = new Use(parent);
expect(use.end()).toBe(parent);
});
test('shorthand methods', () => {
const use = new Use();
const obj = {};
use.shorthands.forEach((method) => {
obj[method] = 'alpha';
expect(use[method]('alpha')).toBe(use);
});
expect(use.entries()).toStrictEqual(obj);
});
test('tap', () => {
const use = new Use();
use.loader('babel-loader').options({ presets: ['alpha'] });
use.tap((options) => {
expect(options).toStrictEqual({ presets: ['alpha'] });
return { presets: ['beta'] };
});
expect(use.store.get('options')).toStrictEqual({ presets: ['beta'] });
});
test('toConfig', () => {
const rule = new Rule(null, 'alpha');
const use = rule
.use('beta')
.loader('babel-loader')
.options({ presets: ['alpha'] });
const config = use.toConfig();
expect(config).toStrictEqual({
loader: 'babel-loader',
options: { presets: ['alpha'] },
});
expect(config.__ruleNames).toStrictEqual(['alpha']);
expect(config.__ruleTypes).toStrictEqual(['rule']);
expect(config.__useName).toBe('beta');
});
================================================
FILE: types/index.d.ts
================================================
import { Tapable } from 'tapable';
import * as webpack from 'webpack';
import * as https from 'https';
export = Config;
declare namespace __Config {
class Chained<Parent> {
end(): Parent;
}
class TypedChainedMap<Parent, Value> extends Chained<Parent> {
clear(): this;
delete(key: string): this;
has(key: string): boolean;
get(key: string): Value;
getOrCompute(key: string, compute: () => Value): Value;
set(key: string, value: Value): this;
merge(obj: { [key: string]: Value }): this;
entries(): { [key: string]: Value };
values(): Value[];
when(
condition: boolean,
trueBrancher: (obj: this) => void,
falseBrancher?: (obj: this) => void,
): this;
}
class ChainedMap<Parent> extends TypedChainedMap<Parent, any> {}
class TypedChainedSet<Parent, Value> extends Chained<Parent> {
add(value: Value): this;
prepend(value: Value): this;
clear(): this;
delete(key: string): this;
has(key: string): boolean;
merge(arr: Value[]): this;
values(): Value[];
when(
condition: boolean,
trueBrancher: (obj: this) => void,
falseBrancher?: (obj: this) => void,
): this;
}
class ChainedSet<Parent> extends TypedChainedSet<Parent, any> {}
}
declare class Config extends __Config.ChainedMap<void> {
devServer: Config.DevServer;
entryPoints: Config.TypedChainedMap<Config, Config.EntryPoint>;
module: Config.Module;
node: Config.ChainedMap<this>;
output: Config.Output;
optimization: Config.Optimization;
performance: Config.Performance;
plugins: Config.Plugins<this, webpack.Plugin>;
resolve: Config.Resolve;
resolveLoader: Config.ResolveLoader;
amd(value: { [moduleName: string]: boolean }): this;
bail(value: boolean): this;
cache(value: boolean | any): this;
devtool(value: Config.DevTool): this;
context(value: string): this;
externals(value: webpack.ExternalsElement | webpack.ExternalsElement[]): this;
loader(value: any): this;
name(value: string): this;
mode(value: 'none' | 'development' | 'production'): this;
parallelism(value: number): this;
profile(value: boolean): this;
recordsPath(value: string): this;
recordsInputPath(value: string): this;
recordsOutputPath(value: string): this;
stats(value: webpack.Options.Stats): this;
target(value: string): this;
watch(value: boolean): this;
watchOptions(value: webpack.Options.WatchOptions): this;
entry(name: string): Config.EntryPoint;
plugin(name: string): Config.Plugin<this, webpack.Plugin>;
toConfig(): webpack.Configuration;
}
declare namespace Config {
class Chained<Parent> extends __Config.Chained<Parent> {}
class TypedChainedMap<Parent, Value> extends __Config.TypedChainedMap<
Parent,
Value
> {}
class ChainedMap<Parent> extends __Config.TypedChainedMap<Parent, any> {}
class TypedChainedSet<Parent, Value> extends __Config.TypedChainedSet<
Parent,
Value
> {}
class ChainedSet<Parent> extends __Config.TypedChainedSet<Parent, any> {}
class Plugins<
Parent,
PluginType extends Tapable.Plugin = webpack.Plugin,
> extends TypedChainedMap<Parent, Plugin<Parent, PluginType>> {}
class Plugin<Parent, PluginType extends Tapable.Plugin = webpack.Plugin>
extends ChainedMap<Parent>
implements Orderable
{
init<P extends PluginType | PluginClass<PluginType>>(
value: (
plugin: P,
args: P extends PluginClass ? ConstructorParameters<P> : any[],
) => PluginType,
): this;
use<P extends string | PluginType | PluginClass<PluginType>>(
plugin: P,
args?: P extends PluginClass ? ConstructorParameters<P> : any[],
): this;
tap<P extends PluginClass<PluginType>>(
f: (args: ConstructorParameters<P>) => ConstructorParameters<P>,
): this;
// Orderable
before(name: string): this;
after(name: string): this;
}
class Module extends ChainedMap<Config> {
rules: TypedChainedMap<this, Rule>;
rule(name: string): Rule;
noParse(
noParse: RegExp | RegExp[] | ((contentPath: string) => boolean),
): this;
strictExportPresence(value: boolean): this;
}
class Output extends ChainedMap<Config> {
auxiliaryComment(value: string | { [comment: string]: string }): this;
chunkFilename(value: string): this;
chunkLoadTimeout(value: number): this;
crossOriginLoading(value: boolean | string): this;
filename(value: string): this;
library(value: string): this;
libraryExport(value: string | string[]): this;
libraryTarget(value: string): this;
devtoolFallbackModuleFilenameTemplate(value: any): this;
devtoolLineToLine(value: any): this;
devtoolModuleFilenameTemplate(value: any): this;
devtoolNamespace(value: string): this;
globalObject(value: string): this;
hashFunction(value: string): this;
hashDigest(value: string): this;
hashDigestLength(value: number): this;
hashSalt(value: any): this;
hotUpdateChunkFilename(value: string): this;
hotUpdateFunction(value: any): this;
hotUpdateMainFilename(value: string): this;
jsonpFunction(value: string): this;
path(value: string): this;
pathinfo(value: boolean): this;
publicPath(value: string): this;
sourceMapFilename(value: string): this;
sourcePrefix(value: string): this;
strictModuleExceptionHandling(value: boolean): this;
umdNamedDefine(value: boolean): this;
futureEmitAssets(value: boolean): this;
}
class DevServer extends ChainedMap<Config> {
allowedHosts: TypedChainedSet<this, string>;
after(
value: (app: any, server: any, compiler: webpack.Compiler) => void,
): this;
before(
value: (app: any, server: any, compiler: webpack.Compiler) => void,
): this;
bonjour(value: boolean): this;
clientLogLevel(value: 'none' | 'error' | 'warning' | 'info'): this;
color(value: boolean): this;
compress(value: boolean): this;
contentBase(value: boolean | string | string[]): this;
disableHostCheck(value: boolean): this;
filename(value: string): this;
headers(value: { [header: string]: string }): this;
historyApiFallback(value: boolean | any): this;
host(value: string): this;
hot(value: boolean): this;
hotOnly(value: boolean): this;
http2(value: boolean): this;
https(value: boolean | https.ServerOptions): this;
index(value: string): this;
info(value: boolean): this;
inline(value: boolean): this;
lazy(value: boolean): this;
mimeTypes(value: Object): this;
noInfo(value: boolean): this;
open(value: boolean): this;
openPage(value: string | string[]): this;
overlay(value: boolean | { warnings?: boolean; errors?: boolean }): this;
pfx(value: string): this;
pfxPassphrase(value: string): this;
port(value: number): this;
progress(value: boolean): this;
proxy(value: any): this;
public(value: string): this;
publicPath(publicPath: string): this;
quiet(value: boolean): this;
setup(value: (expressApp: any) => void): this;
socket(value: string): this;
sockHost(value: string): this;
sockPath(value: string): this;
sockPort(value: number): this;
staticOptions(value: any): this;
stats(value: webpack.Options.Stats): this;
stdin(value: boolean): this;
useLocalIp(value: boolean): this;
watchContentBase(value: boolean): this;
watchOptions(value: any): this;
writeToDisk(value: boolean): this;
}
class Performance extends ChainedMap<Config> {
hints(value: boolean | 'error' | 'warning'): this;
maxEntrypointSize(value: number): this;
maxAssetSize(value: number): this;
assetFilter(value: (assetFilename: string) => boolean): this;
}
class EntryPoint extends TypedChainedSet<Config, string> {}
class Resolve<T = Config> extends ChainedMap<T> {
alias: TypedChainedMap<this, string>;
aliasFields: TypedChainedSet<this, string>;
descriptionFiles: TypedChainedSet<this, string>;
extensions: TypedChainedSet<this, string>;
mainFields: TypedChainedSet<this, string>;
mainFiles: TypedChainedSet<this, string>;
modules: TypedChainedSet<this, string>;
plugins: TypedChainedMap<this, Plugin<this, webpack.ResolvePlugin>>;
enforceExtension(value: boolean): this;
enforceModuleExtension(value: boolean): this;
unsafeCache(value: boolean | RegExp | RegExp[]): this;
symlinks(value: boolean): this;
cachePredicate(
value: (data: { path: string; request: string }) => boolean,
): this;
cacheWithContext(value: boolean): this;
plugin(name: string): Plugin<this, webpack.ResolvePlugin>;
}
class ResolveLoader extends Resolve {
moduleExtensions: ChainedSet<this>;
packageMains: ChainedSet<this>;
}
class Rule<T = Module> extends ChainedMap<T> implements Orderable {
rules: TypedChainedMap<this, Rule<Rule>>;
oneOfs: TypedChainedMap<this, Rule<Rule>>;
uses: TypedChainedMap<this, Use>;
include: TypedChainedSet<this, webpack.Condition>;
exclude: TypedChainedSet<this, webpack.Condition>;
resolve: Resolve<Rule<T>>;
parser(value: { [optName: string]: any }): this;
test(value: webpack.Condition | webpack.Condition[]): this;
type(
value:
| 'javascript/auto'
| 'javascript/dynamic'
| 'javascript/esm'
| 'json'
| 'webassembly/experimental',
): this;
enforce(value: 'pre' | 'post'): this;
use(name: string): Use<this>;
rule(name: string): Rule<Rule>;
oneOf(name: string): Rule<Rule>;
pre(): this;
post(): this;
before(name: string): this;
after(name: string): this;
resourceQuery(value: webpack.Condition | webpack.Condition[]): this;
}
class Optimization extends ChainedMap<Config> {
concatenateModules(value: boolean): this;
flagIncludedChunks(value: boolean): this;
mergeDuplicateChunks(value: boolean): this;
minimize(value: boolean): this;
minimizer(name: string): Config.Plugin<this, webpack.Plugin>;
namedChunks(value: boolean): this;
namedModules(value: boolean): this;
nodeEnv(value: boolean | string): this;
noEmitOnErrors(value: boolean): this;
occurrenceOrder(value: boolean): this;
portableRecords(value: boolean): this;
providedExports(value: boolean): this;
removeAvailableModules(value: boolean): this;
removeEmptyChunks(value: boolean): this;
runtimeChunk(value: boolean | 'single' | 'multiple' | RuntimeChunk): this;
sideEffects(value: boolean): this;
splitChunks(value: SplitChunksOptions): this;
usedExports(value: boolean): this;
}
interface RuntimeChunk {
name: string | RuntimeChunkFunction;
}
type RuntimeChunkFunction = (entryPoint: EntryPoint) => string;
interface SplitChunksOptions {
[name: string]: any;
}
interface LoaderOptions {
[name: string]: any;
}
class Use<Parent = Rule> extends ChainedMap<Parent> implements Orderable {
loader(value: string): this;
options(value: LoaderOptions): this;
tap(f: (options: LoaderOptions) => LoaderOptions): this;
// Orderable
before(name: string): this;
after(name: string): this;
}
type DevTool =
| 'eval'
| 'inline-source-map'
| 'cheap-eval-source-map'
| 'cheap-source-map'
| 'cheap-module-eval-source-map'
| 'cheap-module-source-map'
| 'eval-source-map'
| 'source-map'
| 'nosources-source-map'
| 'hidden-source-map'
| 'nosources-source-map'
| '@eval'
| '@inline-source-map'
| '@cheap-eval-source-map'
| '@cheap-source-map'
| '@cheap-module-eval-source-map'
| '@cheap-module-source-map'
| '@eval-source-map'
| '@source-map'
| '@nosources-source-map'
| '@hidden-source-map'
| '@nosources-source-map'
| '#eval'
| '#inline-source-map'
| '#cheap-eval-source-map'
| '#cheap-source-map'
| '#cheap-module-eval-source-map'
| '#cheap-module-source-map'
| '#eval-source-map'
| '#source-map'
| '#nosources-source-map'
| '#hidden-source-map'
| '#nosources-source-map'
| '#@eval'
| '#@inline-source-map'
| '#@cheap-eval-source-map'
| '#@cheap-source-map'
| '#@cheap-module-eval-source-map'
| '#@cheap-module-source-map'
| '#@eval-source-map'
| '#@source-map'
| '#@nosources-source-map'
| '#@hidden-source-map'
| '#@nosources-source-map'
| boolean;
interface PluginClass<PluginType extends Tapable.Plugin = webpack.Plugin> {
new (...opts: any[]): PluginType;
}
interface Orderable {
before(name: string): this;
after(name: string): this;
}
}
================================================
FILE: types/test/tsconfig.json
================================================
{
"compilerOptions": {
"module": "commonjs",
"lib": ["es6"],
"noImplicitAny": true,
"noImplicitThis": true,
"strictNullChecks": true,
"strictFunctionTypes": true,
"noEmit": true,
"baseUrl": ".",
"paths": {
"webpack-chain": ["../index.d.ts"]
}
},
"files": ["../index.d.ts", "webpack-chain-tests.ts"],
"compileOnSave": false
}
================================================
FILE: types/test/webpack-chain-tests.ts
================================================
/**
* Notes: The order structure of the type check follows the order
* of this document: https://github.com/neutrinojs/webpack-chain#config
*/
import Resolver = require('enhanced-resolve/lib/Resolver');
import Config = require('webpack-chain');
import * as webpack from 'webpack';
class ResolvePluginImpl extends webpack.ResolvePlugin {
apply(resolver: Resolver): void {}
}
function expectType<T>(value: T) {}
const config = new Config();
config
.amd({ foo: true })
.bail(true)
.cache(false)
.cache({})
.devtool('hidden-source-map')
.devtool(false)
.context('')
.externals('foo')
.externals(/node_modules/)
.externals({ test: false, foo: 'bar' })
.externals(['foo', 'bar'])
.externals((context, request, cb) => cb(null, 'foo'))
.loader({})
.name('config-name')
.mode('none')
.mode('development')
.mode('production')
.profile(false)
.parallelism(2)
.recordsPath('')
.recordsInputPath('')
.recordsOutputPath('')
.stats({
assets: false,
publicPath: true,
modules: false,
})
.target('web')
.watch(true)
.watchOptions({})
.when(
false,
(config) => config.watch(true),
(config) => config.watch(false),
)
.entry('main')
.add('index.js')
.delete('index.js')
.clear()
.when(
false,
(entry) => entry.clear(),
(entry) => entry.clear(),
)
.end()
.entryPoints.delete('main')
.end()
.output.futureEmitAssets(true)
.auxiliaryComment('Test Comment')
.auxiliaryComment({
root: 'Root Comment',
})
.chunkFilename('')
.chunkLoadTimeout(1000)
.crossOriginLoading(true)
.devtoolFallbackModuleFilenameTemplate('')
.devtoolNamespace('')
.devtoolLineToLine('')
.devtoolModuleFilenameTemplate('')
.filename('main.js')
.globalObject('global')
.hashFunction('md5')
.hashDigest('md5')
.hashDigestLength(15)
.hashSalt('')
.hotUpdateChunkFilename('update')
.hotUpdateFunction(() => {})
.hotUpdateMainFilename('main')
.jsonpFunction('callback')
.library('var')
.libraryExport(['MyModule', 'MySubModule'])
.libraryTarget('var')
.path('/')
.pathinfo(true)
.publicPath('/')
.sourceMapFilename('index.js.map')
.sourcePrefix('~')
.strictModuleExceptionHandling(true)
.umdNamedDefine(true)
.end()
.resolve.cachePredicate(({ path, request }) => true)
.cacheWithContext(true)
.enforceExtension(true)
.enforceModuleExtension(true)
.unsafeCache(false)
.unsafeCache(/foo/)
.symlinks(true)
.alias.set('foo', 'bar')
.end()
.modules.add('index.js')
.end()
.aliasFields.add('foo')
.end()
.descriptionFiles.add('foo')
.end()
.extensions.add('.js')
.end()
.mainFields.add('browser')
.end()
.mainFiles.add('index.js')
.end()
.plugin('foo')
.use(ResolvePluginImpl, [])
.end()
.plugins.delete('foo')
.end()
.end()
.resolveLoader.moduleExtensions.add('.js')
.end()
.packageMains.add('index.js')
.end()
.plugin('foo')
.use(webpack.DefinePlugin)
.end()
.end()
.performance.hints(true)
.hints('warning')
.maxEntrypointSize(20000)
.maxAssetSize(20000)
.assetFilter((filename) => true)
.end()
.optimization.concatenateModules(true)
.flagIncludedChunks(true)
.mergeDuplicateChunks(true)
.minimize(true)
.namedChunks(true)
.namedModules(true)
.nodeEnv(true)
.noEmitOnErrors(true)
.occurrenceOrder(true)
.portableRecords(true)
.providedExports(true)
.removeAvailableModules(true)
.removeEmptyChunks(true)
.runtimeChunk('single')
.runtimeChunk({ name: ({}) => 'hello' })
.sideEffects(true)
.splitChunks({})
.usedExports(true)
.minimizer('foo')
.use(webpack.DefinePlugin)
.tap((config) => [])
.end()
.end()
.plugin('foo')
.use(webpack.DefinePlugin, [
{
'process.env.NODE_ENV': '',
},
])
.end()
.plugin('bar')
.use(webpack.DefinePlugin, [
{
'process.env.NODE_ENV': '',
},
])
.before('foo')
.end()
.plugin('baz')
.use(webpack.DefinePlugin, [
{
'process.env.NODE_ENV': '',
},
])
.after('bar')
.end()
.plugin('asString')
.use('package-name-or-path')
.end()
.plugin('asObject')
.use({ apply: (compiler: webpack.Compiler) => {} })
.end()
.plugins.delete('foo')
.delete('bar')
.delete('baz')
.delete('asString')
.delete('asObject')
.end()
.node.set('__dirname', true)
.delete('__dirname')
.clear()
.end()
.devServer.allowedHosts.add('host.com')
.clear()
.end()
.after(() => {})
.before(() => {})
.bonjour(true)
.clientLogLevel('error')
.color(true)
.compress(false)
.contentBase('/')
.contentBase(['foo', 'bar'])
.disableHostCheck(true)
.filename('hello')
.headers({
'Content-Type': 'text/css',
})
.historyApiFallback(true)
.host('localhost')
.hot(true)
.hotOnly(true)
.http2(true)
.https(true)
.index('test.html')
.info(true)
.inline(true)
.lazy(true)
.mimeTypes({ 'text/html': ['phtml'] })
.noInfo(true)
.open(true)
.openPage('/foo')
.openPage(['/foo', '/bar'])
.overlay(true)
.overlay({
warnings: true,
errors: true,
})
.pfx('/path/to/file.pfx')
.pfxPassphrase('passphrase')
.port(8080)
.progress(true)
.proxy({})
.public('foo')
.publicPath('bar')
.quiet(false)
.setup((app) => {})
.socket('socket')
.sockHost('localhost')
.sockPath('/sockpath/')
.sockPort(8080)
.staticOptions({})
.stats({
reasons: true,
errors: true,
warnings: false,
})
.stdin(true)
.useLocalIp(true)
.watchContentBase(true)
.watchOptions({})
.writeToDisk(true)
.end()
.module.noParse(/.min.js$/)
.strictExportPresence(true)
.rule('compile')
.test(/.js$/)
.include.add(/.js$/)
.end()
.exclude.add(/node_modules/)
.end()
.parser({
opt: 'foo',
})
.enforce('pre')
.use('babel')
.tap((config) => [])
.loader('babel-loader')
.options({})
.end()
.use('eslint')
.loader('eslint-loader')
.options({})
.after('babel')
.end()
.uses.delete('babel')
.delete('eslint')
.end()
.pre()
.post()
.rule('inline')
.after('vue')
.resourceQuery(/inline/)
.use('url')
.loader('url-loader')
.end()
.resolve.symlinks(true)
.end()
.end()
.rules.delete('inline')
.end()
.oneOf('inline')
.after('vue')
.uses.delete('babel')
.end()
.resourceQuery(/inline/)
.use('url')
.loader('url-loader')
.end()
.end()
.oneOfs.delete('inline')
.end()
.resolve.symlinks(true)
.end()
.end()
.rules.delete('compile')
.end()
.end()
//** support https://webpack.js.org/configuration/module/#ruletype */
.module.rule('mjs-compile')
.test(/\.mjs$/)
.type('javascript/auto')
.end()
.end()
.merge({})
.toConfig();
// Test TypedChainedMap
const entryPoints = config.entryPoints;
expectType<typeof entryPoints>(entryPoints.clear());
expectType<typeof entryPoints>(entryPoints.delete('key'));
expectType<boolean>(entryPoints.has('key'));
expectType<Config.EntryPoint>(entryPoints.get('key'));
expectType<Config.EntryPoint>(
entryPoints.getOrCompute('key', () => new Config.EntryPoint()),
);
expectType<typeof entryPoints>(entryPoints.set('key', new Config.EntryPoint()));
expectType<typeof entryPoints>(
entryPoints.merge({
key: new Config.EntryPoint(),
}),
);
expectType<Record<string, Config.EntryPoint>>(entryPoints.entries());
expectType<typeof entryPoints>(
entryPoints.when(
true,
(val) => {
expectType<typeof entryPoints>(val);
},
(val) => {
expectType<typeof entryPoints>(val);
},
),
);
// Test TypedChainedSet
const extensions = config.resolve.extensions;
expectType<typeof extensions>(extensions.add('.txt'));
expectType<typeof extensions>(extensions.prepend('.txt'));
expectType<typeof extensions>(extensions.clear());
expectType<typeof extensions>(extensions.delete('.txt'));
expectType<boolean>(extensions.has('.txt'));
expectType<typeof extensions>(extensions.merge(['.txt']));
expectType<string[]>(extensions.values());
expectType<typeof extensions>(
extensions.when(
true,
(val) => {
expectType<typeof extensions>(val);
},
(val) => {
expectType<typeof extensions>(val);
},
),
);
================================================
FILE: types/typings.json
================================================
{
"name": "webpack-chain",
"main": "index.d.ts"
}
gitextract_gz5flbuo/
├── .eslintrc.js
├── .github/
│ └── workflows/
│ └── ci.yml
├── .gitignore
├── .prettierignore
├── .prettierrc.js
├── CHANGELOG.md
├── LICENSE
├── README.md
├── jest.config.js
├── package.json
├── renovate.json
├── src/
│ ├── Chainable.js
│ ├── ChainedMap.js
│ ├── ChainedSet.js
│ ├── Config.js
│ ├── DevServer.js
│ ├── Module.js
│ ├── Optimization.js
│ ├── Orderable.js
│ ├── Output.js
│ ├── Performance.js
│ ├── Plugin.js
│ ├── Resolve.js
│ ├── ResolveLoader.js
│ ├── Rule.js
│ └── Use.js
├── test/
│ ├── Chainable.js
│ ├── ChainedMap.js
│ ├── ChainedSet.js
│ ├── Config.js
│ ├── DevServer.js
│ ├── Module.js
│ ├── Optimization.js
│ ├── Orderable.js
│ ├── Output.js
│ ├── Performance.js
│ ├── Plugin.js
│ ├── Resolve.js
│ ├── ResolveLoader.js
│ ├── Rule.js
│ └── Use.js
└── types/
├── index.d.ts
├── test/
│ ├── tsconfig.json
│ └── webpack-chain-tests.ts
└── typings.json
SYMBOL INDEX (125 symbols across 21 files)
FILE: src/Chainable.js
method constructor (line 2) | constructor(parent) {
method batch (line 6) | batch(handler) {
method end (line 11) | end() {
FILE: src/ChainedMap.js
method constructor (line 5) | constructor(parent) {
method extend (line 10) | extend(methods) {
method clear (line 18) | clear() {
method delete (line 23) | delete(key) {
method order (line 28) | order() {
method entries (line 55) | entries() {
method values (line 65) | values() {
method get (line 71) | get(key) {
method getOrCompute (line 75) | getOrCompute(key, fn) {
method has (line 82) | has(key) {
method set (line 86) | set(key, value) {
method merge (line 91) | merge(obj, omit = []) {
method clean (line 113) | clean(obj) {
method when (line 138) | when(
FILE: src/ChainedSet.js
method constructor (line 4) | constructor(parent) {
method add (line 9) | add(value) {
method prepend (line 14) | prepend(value) {
method clear (line 19) | clear() {
method delete (line 24) | delete(value) {
method values (line 29) | values() {
method has (line 33) | has(value) {
method merge (line 37) | merge(arr) {
method when (line 42) | when(
FILE: src/Config.js
method constructor (line 13) | constructor() {
method toString (line 47) | static toString(config, { verbose = false, configPrefix = 'config' } = {...
method entry (line 109) | entry(name) {
method plugin (line 113) | plugin(name) {
method toConfig (line 117) | toConfig() {
method toString (line 140) | toString(options) {
method merge (line 144) | merge(obj = {}, omit = []) {
FILE: src/DevServer.js
method constructor (line 5) | constructor(parent) {
method toConfig (line 59) | toConfig() {
method merge (line 66) | merge(obj, omit = []) {
FILE: src/Module.js
method constructor (line 5) | constructor(parent) {
method defaultRule (line 12) | defaultRule(name) {
method rule (line 19) | rule(name) {
method toConfig (line 23) | toConfig() {
method merge (line 32) | merge(obj, omit = []) {
FILE: src/Optimization.js
method constructor (line 5) | constructor(parent) {
method minimizer (line 29) | minimizer(name) {
method toConfig (line 44) | toConfig() {
method merge (line 52) | merge(obj, omit = []) {
FILE: src/Orderable.js
method before (line 3) | before(name) {
method after (line 16) | after(name) {
method merge (line 29) | merge(obj, omit = []) {
FILE: src/Output.js
method constructor (line 4) | constructor(parent) {
FILE: src/Performance.js
method constructor (line 4) | constructor(parent) {
FILE: src/Plugin.js
method constructor (line 6) | constructor(parent, name, type = 'plugin') {
method use (line 20) | use(plugin, args = []) {
method tap (line 24) | tap(f) {
method set (line 34) | set(key, value) {
method merge (line 41) | merge(obj, omit = []) {
method toConfig (line 53) | toConfig() {
FILE: src/Resolve.js
method constructor (line 6) | constructor(parent) {
method plugin (line 27) | plugin(name) {
method toConfig (line 34) | toConfig() {
method merge (line 49) | merge(obj, omit = []) {
FILE: src/ResolveLoader.js
method constructor (line 5) | constructor(parent) {
method toConfig (line 11) | toConfig() {
method merge (line 19) | merge(obj, omit = []) {
FILE: src/Rule.js
function toArray (line 7) | function toArray(arr) {
method constructor (line 13) | constructor(parent, name, ruleType = 'rule') {
method use (line 45) | use(name) {
method rule (line 49) | rule(name) {
method oneOf (line 53) | oneOf(name) {
method pre (line 60) | pre() {
method post (line 64) | post() {
method toConfig (line 68) | toConfig() {
method merge (line 88) | merge(obj, omit = []) {
FILE: src/Use.js
method constructor (line 7) | constructor(parent, name) {
method tap (line 13) | tap(f) {
method merge (line 18) | merge(obj, omit = []) {
method toConfig (line 30) | toConfig() {
FILE: test/Config.js
class StringifyPlugin (line 7) | class StringifyPlugin {
method constructor (line 8) | constructor(...args) {
method apply (line 12) | apply() {
class FooPlugin (line 408) | class FooPlugin {}
method render (line 563) | render() {}
FILE: test/Optimization.js
class StringifyPlugin (line 3) | class StringifyPlugin {
method constructor (line 4) | constructor(...args) {
method apply (line 8) | apply() {
FILE: test/Plugin.js
class StringifyPlugin (line 5) | class StringifyPlugin {
method constructor (line 6) | constructor(...args) {
method apply (line 10) | apply() {
class TestPlugin (line 106) | class TestPlugin {}
method apply (line 120) | apply() {}
FILE: test/Resolve.js
class StringifyPlugin (line 3) | class StringifyPlugin {
method constructor (line 4) | constructor(...args) {
method apply (line 8) | apply() {
FILE: types/index.d.ts
class Chained (line 8) | class Chained<Parent> {
class TypedChainedMap (line 12) | class TypedChainedMap<Parent, Value> extends Chained<Parent> {
class ChainedMap (line 29) | class ChainedMap<Parent> extends TypedChainedMap<Parent, any> {}
class TypedChainedSet (line 31) | class TypedChainedSet<Parent, Value> extends Chained<Parent> {
class ChainedSet (line 46) | class ChainedSet<Parent> extends TypedChainedSet<Parent, any> {}
class Config (line 49) | class Config extends __Config.ChainedMap<void> {
class Chained (line 87) | class Chained<Parent> extends __Config.Chained<Parent> {}
class TypedChainedMap (line 88) | class TypedChainedMap<Parent, Value> extends __Config.TypedChainedMap<
class ChainedMap (line 92) | class ChainedMap<Parent> extends __Config.TypedChainedMap<Parent, any> {}
class TypedChainedSet (line 93) | class TypedChainedSet<Parent, Value> extends __Config.TypedChainedSet<
class ChainedSet (line 97) | class ChainedSet<Parent> extends __Config.TypedChainedSet<Parent, any> {}
class Plugins (line 99) | class Plugins<
class Plugin (line 104) | class Plugin<Parent, PluginType extends Tapable.Plugin = webpack.Plugin>
class Module (line 127) | class Module extends ChainedMap<Config> {
class Output (line 136) | class Output extends ChainedMap<Config> {
class DevServer (line 168) | class DevServer extends ChainedMap<Config> {
class Performance (line 222) | class Performance extends ChainedMap<Config> {
class EntryPoint (line 229) | class EntryPoint extends TypedChainedSet<Config, string> {}
class Resolve (line 231) | class Resolve<T = Config> extends ChainedMap<T> {
class ResolveLoader (line 253) | class ResolveLoader extends Resolve {
class Rule (line 258) | class Rule<T = Module> extends ChainedMap<T> implements Orderable {
class Optimization (line 288) | class Optimization extends ChainedMap<Config> {
type RuntimeChunk (line 309) | interface RuntimeChunk {
type RuntimeChunkFunction (line 313) | type RuntimeChunkFunction = (entryPoint: EntryPoint) => string;
type SplitChunksOptions (line 315) | interface SplitChunksOptions {
type LoaderOptions (line 319) | interface LoaderOptions {
class Use (line 323) | class Use<Parent = Rule> extends ChainedMap<Parent> implements Orderable {
type DevTool (line 334) | type DevTool =
type PluginClass (line 381) | interface PluginClass<PluginType extends Tapable.Plugin = webpack.Plugin> {
type Orderable (line 385) | interface Orderable {
FILE: types/test/webpack-chain-tests.ts
class ResolvePluginImpl (line 9) | class ResolvePluginImpl extends webpack.ResolvePlugin {
method apply (line 10) | apply(resolver: Resolver): void {}
function expectType (line 13) | function expectType<T>(value: T) {}
Condensed preview — 45 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (183K chars).
[
{
"path": ".eslintrc.js",
"chars": 427,
"preview": "module.exports = {\n root: true,\n extends: [\n 'eslint-config-airbnb-base',\n 'eslint-config-prettier',\n 'plugin"
},
{
"path": ".github/workflows/ci.yml",
"chars": 902,
"preview": "name: 'ci'\non: [push, pull_request]\n\njobs:\n lint:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@"
},
{
"path": ".gitignore",
"chars": 629,
"preview": "# Logs\nlogs\n*.log\nnpm-debug.log*\nlerna-debug.log\n\n# Build directories\nbuild\n\n# Runtime data\npids\n*.pid\n*.seed\n*.pid.lock"
},
{
"path": ".prettierignore",
"chars": 116,
"preview": "# Since autogenerated file\nCHANGELOG.md\n\n# Since it formats the inline code blocks, worsening readability\nREADME.md\n"
},
{
"path": ".prettierrc.js",
"chars": 67,
"preview": "module.exports = {\n singleQuote: true,\n trailingComma: 'all',\n};\n"
},
{
"path": "CHANGELOG.md",
"chars": 25376,
"preview": "### Changelog\n\nAll notable changes to this project will be documented in this file. Dates are displayed in UTC.\n\nGenerat"
},
{
"path": "LICENSE",
"chars": 16724,
"preview": "Mozilla Public License Version 2.0\n==================================\n\n1. Definitions\n--------------\n\n1.1. \"Contributor\""
},
{
"path": "README.md",
"chars": 32388,
"preview": "# webpack-chain\n\n[![NPM version][npm-image]][npm-url]\n[![NPM downloads][npm-downloads]][npm-url]\n[![CI Status][ci-image]"
},
{
"path": "jest.config.js",
"chars": 83,
"preview": "module.exports = {\n testEnvironment: 'node',\n testMatch: ['**/test/**/*.js'],\n};\n"
},
{
"path": "package.json",
"chars": 1453,
"preview": "{\n \"name\": \"webpack-chain\",\n \"version\": \"7.0.0-dev\",\n \"main\": \"src/Config.js\",\n \"typings\": \"types/index.d.ts\",\n \"re"
},
{
"path": "renovate.json",
"chars": 221,
"preview": "{\n \"extends\": [\n \"config:base\",\n \":maintainLockFilesWeekly\",\n \":prNotPending\",\n \":semanticCommitsDisabled\","
},
{
"path": "src/Chainable.js",
"chars": 181,
"preview": "module.exports = class {\n constructor(parent) {\n this.parent = parent;\n }\n\n batch(handler) {\n handler(this);\n "
},
{
"path": "src/ChainedMap.js",
"chars": 2833,
"preview": "const merge = require('deepmerge');\nconst Chainable = require('./Chainable');\n\nmodule.exports = class extends Chainable "
},
{
"path": "src/ChainedSet.js",
"chars": 847,
"preview": "const Chainable = require('./Chainable');\n\nmodule.exports = class extends Chainable {\n constructor(parent) {\n super("
},
{
"path": "src/Config.js",
"chars": 5229,
"preview": "const ChainedMap = require('./ChainedMap');\nconst ChainedSet = require('./ChainedSet');\nconst Resolve = require('./Resol"
},
{
"path": "src/DevServer.js",
"chars": 1384,
"preview": "const ChainedMap = require('./ChainedMap');\nconst ChainedSet = require('./ChainedSet');\n\nmodule.exports = class extends "
},
{
"path": "src/Module.js",
"chars": 1226,
"preview": "const ChainedMap = require('./ChainedMap');\nconst Rule = require('./Rule');\n\nmodule.exports = class extends ChainedMap {"
},
{
"path": "src/Optimization.js",
"chars": 1671,
"preview": "const ChainedMap = require('./ChainedMap');\nconst Plugin = require('./Plugin');\n\nmodule.exports = class extends ChainedM"
},
{
"path": "src/Orderable.js",
"chars": 804,
"preview": "module.exports = (Class) =>\n class extends Class {\n before(name) {\n if (this.__after) {\n throw new Error"
},
{
"path": "src/Output.js",
"chars": 961,
"preview": "const ChainedMap = require('./ChainedMap');\n\nmodule.exports = class extends ChainedMap {\n constructor(parent) {\n sup"
},
{
"path": "src/Performance.js",
"chars": 219,
"preview": "const ChainedMap = require('./ChainedMap');\n\nmodule.exports = class extends ChainedMap {\n constructor(parent) {\n sup"
},
{
"path": "src/Plugin.js",
"chars": 2538,
"preview": "const ChainedMap = require('./ChainedMap');\nconst Orderable = require('./Orderable');\n\nmodule.exports = Orderable(\n cla"
},
{
"path": "src/Resolve.js",
"chars": 1954,
"preview": "const ChainedMap = require('./ChainedMap');\nconst ChainedSet = require('./ChainedSet');\nconst Plugin = require('./Plugin"
},
{
"path": "src/ResolveLoader.js",
"chars": 731,
"preview": "const Resolve = require('./Resolve');\nconst ChainedSet = require('./ChainedSet');\n\nmodule.exports = class extends Resolv"
},
{
"path": "src/Rule.js",
"chars": 3512,
"preview": "const ChainedMap = require('./ChainedMap');\nconst ChainedSet = require('./ChainedSet');\nconst Orderable = require('./Ord"
},
{
"path": "src/Use.js",
"chars": 1065,
"preview": "const merge = require('deepmerge');\nconst ChainedMap = require('./ChainedMap');\nconst Orderable = require('./Orderable')"
},
{
"path": "test/Chainable.js",
"chars": 411,
"preview": "const Chainable = require('../src/Chainable');\n\ntest('calling .end() returns parent', () => {\n const parent = { parent:"
},
{
"path": "test/ChainedMap.js",
"chars": 4514,
"preview": "const ChainedMap = require('../src/ChainedMap');\n\ntest('is Chainable', () => {\n const parent = { parent: true };\n cons"
},
{
"path": "test/ChainedSet.js",
"chars": 2766,
"preview": "const ChainedSet = require('../src/ChainedSet');\n\ntest('is Chainable', () => {\n const parent = { parent: true };\n cons"
},
{
"path": "test/Config.js",
"chars": 12592,
"preview": "/* eslint-disable max-classes-per-file */\nconst { validate } = require('webpack');\nconst { stringify } = require('javasc"
},
{
"path": "test/DevServer.js",
"chars": 764,
"preview": "const DevServer = require('../src/DevServer');\n\ntest('is Chainable', () => {\n const parent = { parent: true };\n const "
},
{
"path": "test/Module.js",
"chars": 1086,
"preview": "const Module = require('../src/Module');\n\ntest('is Chainable', () => {\n const parent = { parent: true };\n const module"
},
{
"path": "test/Optimization.js",
"chars": 2820,
"preview": "const Optimization = require('../src/Optimization');\n\nclass StringifyPlugin {\n constructor(...args) {\n this.values ="
},
{
"path": "test/Orderable.js",
"chars": 2404,
"preview": "const Orderable = require('../src/Orderable');\nconst ChainedMap = require('../src/ChainedMap');\n\nconst Ordered = Orderab"
},
{
"path": "test/Output.js",
"chars": 447,
"preview": "const Output = require('../src/Output');\n\ntest('is Chainable', () => {\n const parent = { parent: true };\n const output"
},
{
"path": "test/Performance.js",
"chars": 502,
"preview": "const Performance = require('../src/Performance');\n\ntest('is Chainable', () => {\n const parent = { parent: true };\n co"
},
{
"path": "test/Plugin.js",
"chars": 4347,
"preview": "/* eslint-disable max-classes-per-file */\nconst EnvironmentPlugin = require('webpack/lib/EnvironmentPlugin');\nconst Plug"
},
{
"path": "test/Resolve.js",
"chars": 3430,
"preview": "const Resolve = require('../src/Resolve');\n\nclass StringifyPlugin {\n constructor(...args) {\n this.values = args;\n }"
},
{
"path": "test/ResolveLoader.js",
"chars": 2459,
"preview": "const ResolveLoader = require('../src/ResolveLoader');\n\ntest('is Chainable', () => {\n const parent = { parent: true };\n"
},
{
"path": "test/Rule.js",
"chars": 9791,
"preview": "const Rule = require('../src/Rule');\n\ntest('is Chainable', () => {\n const parent = { parent: true };\n const rule = new"
},
{
"path": "test/Use.js",
"chars": 1225,
"preview": "const Rule = require('../src/Rule');\nconst Use = require('../src/Use');\n\ntest('is Chainable', () => {\n const parent = {"
},
{
"path": "types/index.d.ts",
"chars": 12640,
"preview": "import { Tapable } from 'tapable';\nimport * as webpack from 'webpack';\nimport * as https from 'https';\n\nexport = Config;"
},
{
"path": "types/test/tsconfig.json",
"chars": 379,
"preview": "{\n \"compilerOptions\": {\n \"module\": \"commonjs\",\n \"lib\": [\"es6\"],\n \"noImplicitAny\": true,\n \"noImplicitThis\": "
},
{
"path": "types/test/webpack-chain-tests.ts",
"chars": 8130,
"preview": "/**\n * Notes: The order structure of the type check follows the order\n * of this document: https://github.com/neutrinojs"
},
{
"path": "types/typings.json",
"chars": 54,
"preview": "{\n \"name\": \"webpack-chain\",\n \"main\": \"index.d.ts\"\n}\n"
}
]
About this extraction
This page contains the full source code of the neutrinojs/webpack-chain GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 45 files (170.2 KB), approximately 46.3k tokens, and a symbol index with 125 extracted functions, classes, methods, constants, and types. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.