diff --git a/.github/ISSUE_TEMPLATE/BUG.md b/.github/ISSUE_TEMPLATE/BUG.md index 374f347..931d2e2 100644 --- a/.github/ISSUE_TEMPLATE/BUG.md +++ b/.github/ISSUE_TEMPLATE/BUG.md @@ -3,32 +3,31 @@ name: 🐛 Bug Report about: Something went awry and you'd like to tell us about it. --- - - + + ### Bug report - + - + ### Actual Behavior - + ### Expected Behavior - - + + ### How Do We Reproduce? - - - - - - + + + + + -### Please paste the results of `npx webpack-cli info` here, and mention other relevant information +### Please paste the results of `npx webpack-cli info` here, and mention other relevant information. diff --git a/.github/ISSUE_TEMPLATE/DOCS.md b/.github/ISSUE_TEMPLATE/DOCS.md index a94c0c9..1f9fad7 100644 --- a/.github/ISSUE_TEMPLATE/DOCS.md +++ b/.github/ISSUE_TEMPLATE/DOCS.md @@ -3,12 +3,12 @@ name: 📚 Documentation about: Are the docs lacking or missing something? Do they need some new đŸ”Ĩ hotness? Tell us here. --- - - + + -Documentation Is: +Documentation is: - + - [ ] Missing - [ ] Needed @@ -17,9 +17,9 @@ Documentation Is: ### Please Explain in Detail... - + - + ### Your Proposal for Changes diff --git a/.github/ISSUE_TEMPLATE/FEATURE.md b/.github/ISSUE_TEMPLATE/FEATURE.md index 1e5304e..d1e618f 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE.md +++ b/.github/ISSUE_TEMPLATE/FEATURE.md @@ -3,16 +3,18 @@ name: ✨ Feature Request about: Suggest an idea for this project --- - - + + ### Feature Proposal - + - + ### Feature Use Case -### Please paste the results of `npx webpack-cli info` here, and mention other relevant information + + +### Please paste the results of `npx webpack-cli info` here, and mention other relevant information. diff --git a/.github/ISSUE_TEMPLATE/MODIFICATION.md b/.github/ISSUE_TEMPLATE/MODIFICATION.md index c60a501..3560244 100644 --- a/.github/ISSUE_TEMPLATE/MODIFICATION.md +++ b/.github/ISSUE_TEMPLATE/MODIFICATION.md @@ -1,20 +1,25 @@ --- name: 🔧 Modification Request -about: Would you like something work differently? Have an alternative approach? This is the template for you. +about: Want something to work differently? Have an alternative approach? This is the template for you. --- - - + + ### Modification Proposal - + + - + ### Expected Behavior / Situation + + ### Actual Behavior / Situation -### Please paste the results of `npx webpack-cli info` here, and mention other relevant information + + +### Please paste the results of `npx webpack-cli info` here, and mention other relevant information. diff --git a/.github/ISSUE_TEMPLATE/SUPPORT.md b/.github/ISSUE_TEMPLATE/SUPPORT.md index daaf912..65f014a 100644 --- a/.github/ISSUE_TEMPLATE/SUPPORT.md +++ b/.github/ISSUE_TEMPLATE/SUPPORT.md @@ -1,7 +1,15 @@ --- name: 🆘 Support, Help, and Advice -about: 👉đŸŊ Need support, help, or advice? Don't open an issue! Head to https://github.com/webpack/webpack/discussions or StackOverflow. +about: 👉đŸŊ Need support, help, or advice? Don't open an issue! Head to https://github.com/webpack/webpack/discussions or StackOverflow --- -Hey there! If you need support, help, or advice then this is not the place to ask. -Please visit [GitHub Discussions](https://github.com/webpack/webpack/discussions) or [StackOverflow](https://stackoverflow.com/questions/tagged/webpack) instead. +Hey there! 👋 + +If you need support, help, or advice then this is not the right place to ask. + +Please visit one of the following instead: + +- [GitHub Discussions](https://github.com/webpack/webpack/discussions) +- [StackOverflow](https://stackoverflow.com/questions/tagged/webpack) + +Thanks for understanding! diff --git a/README.md b/README.md index b41a858..1b87cb3 100644 --- a/README.md +++ b/README.md @@ -91,10 +91,13 @@ Finally, run Webpack using your preferred method. Why? Because CSS support only these source map types. The plugin respects the [`devtool`](https://webpack.js.org/configuration/devtool/) setting and uses the `SourceMapDevToolPlugin` internally. + Using a supported `devtool` value enables source map generation. + Enabling the `columns` option in `SourceMapDevToolPlugin` also allows source map generation. Use source maps to map error message locations to their original modules (note that this may slow down compilation). + If you use your own `minify` function please refer to the `minify` section for correct handling of source maps. ## Options @@ -179,6 +182,7 @@ module.exports = { - Default: `true` Use multi-process parallel running to improve the build speed. + The default number of concurrent runs: `os.cpus().length - 1` or `os.availableParallelism() - 1` (if this function is supported). > â„šī¸ Parallelization can speed up your build significantly and is therefore **highly recommended**. @@ -228,8 +232,10 @@ module.exports = { - Default: `CssMinimizerPlugin.cssnanoMinify` Overrides the default minify function. + By default, plugin uses [cssnano](https://github.com/cssnano/cssnano) package. -This is useful when using or testing unpublished versions or forks. + +> This is useful when using or testing unpublished versions or forks. Possible options: @@ -271,6 +277,7 @@ module.exports = { #### `Array` If an array of functions is passed to the `minify` option, the `minimizerOptions` must also be an array. + The function index in the `minify` array corresponds to the options object with the same index in the `minimizerOptions` array. **webpack.config.js** @@ -337,6 +344,7 @@ module.exports = { #### `Array` The function index in the `minify` array corresponds to the options object with the same index in the `minimizerOptions` array. + If you use `minimizerOptions` like object, all `minify` function accept it. > If parallelization is enabled, the packages in `minimizerOptions` must be referenced via strings (`packageName` or `require.resolve(packageName)`). In this case, we shouldn't use `require`/`import`. @@ -362,6 +370,7 @@ module.exports = { - Default: `{ from: assetName }` Allows filtering options [`processoptions`](https://postcss.org/api/#processoptions) for the cssnano. + The `parser`,` stringifier` and `syntax` can be either a function or a string indicating the module that will be imported. > [!WARNING] @@ -411,6 +420,7 @@ module.exports = { - Default: `() => true` Filter css-minimizer warnings (By default [cssnano](https://github.com/cssnano/cssnano)). + Return `true` to keep the warning, or a falsy value (`false`/`null`/`undefined`) to suppress it. > [!WARNING] @@ -603,6 +613,7 @@ module.exports = { ## Contributing We welcome all contributions! + If you're new here, please take a moment to review our contributing guidelines. [CONTRIBUTING](./.github/CONTRIBUTING.md)