From 0ca77539caaaf8f7b141e16530e185d4bc1e4ec7 Mon Sep 17 00:00:00 2001 From: Sachin Kumar Date: Thu, 5 Jun 2025 09:35:41 +0530 Subject: [PATCH 1/7] docs: improving typos in ISSUE_TEMPLATE files --- .github/ISSUE_TEMPLATE/BUG.md | 27 +++++++++++++------------- .github/ISSUE_TEMPLATE/DOCS.md | 12 ++++++------ .github/ISSUE_TEMPLATE/FEATURE.md | 12 +++++++----- .github/ISSUE_TEMPLATE/MODIFICATION.md | 17 ++++++++++------ .github/ISSUE_TEMPLATE/SUPPORT.md | 14 ++++++++++--- README.md | 4 ++++ 6 files changed, 52 insertions(+), 34 deletions(-) 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 fc1dc55..2957c19 100644 --- a/README.md +++ b/README.md @@ -146,6 +146,7 @@ type eslintPath = string; - Default: `eslint` Path to `eslint` instance that will be used for linting. + If the `eslintPath` is a folder like a official ESlint, or specify a `formatter` option, now you don't have to install `eslint`. ### `extensions` @@ -226,6 +227,7 @@ type formatter = string| ( - Default: `'stylish'` Accepts a function that receives an array of ESLint messages (object) as its argument and must return a string as output. + You can use official [ESlint formatters](https://eslint.org/docs/user-guide/formatters/). ### `lintDirtyModulesOnly` @@ -255,6 +257,7 @@ Will run lint tasks across a thread pool. The pool size is automatic unless you ### Errors and Warning **By default the plugin will auto adjust error reporting depending on eslint errors/warnings counts.** + You can still force this behavior by using `emitError` **or** `emitWarning` options: #### `emitError` @@ -353,6 +356,7 @@ Write ESLint results to a file, for example a checkstyle xml file for use for re ## Contributing We welcome all contributions! + If you're new here, please take a moment to review our contributing guidelines. [CONTRIBUTING](./.github/CONTRIBUTING.md) From 96d9d877443995524488a7b45dcd42e6479d2aab Mon Sep 17 00:00:00 2001 From: Sachin Kumar Date: Thu, 5 Jun 2025 09:38:42 +0530 Subject: [PATCH 2/7] docs: improving typos in ISSUE_TEMPLATE files --- .github/ISSUE_TEMPLATE/SUPPORT.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/SUPPORT.md b/.github/ISSUE_TEMPLATE/SUPPORT.md index 65f014a..6c3d657 100644 --- a/.github/ISSUE_TEMPLATE/SUPPORT.md +++ b/.github/ISSUE_TEMPLATE/SUPPORT.md @@ -1,6 +1,6 @@ --- 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 Stack Overflow --- Hey there! 👋 @@ -10,6 +10,6 @@ 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) +- [Stack Overflow](https://stackoverflow.com/questions/tagged/webpack) Thanks for understanding! From 50c7dc76df082b0583dfb669e22f96733b97ee08 Mon Sep 17 00:00:00 2001 From: Sachin Kumar Date: Thu, 5 Jun 2025 09:47:44 +0530 Subject: [PATCH 3/7] docs: improving typos in ISSUE_TEMPLATE files --- .github/ISSUE_TEMPLATE.md | 15 +++++++-------- .github/ISSUE_TEMPLATE/SUPPORT.md | 2 +- 2 files changed, 8 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 3ce9cf3..0aaecb0 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,16 +1,15 @@ diff --git a/.github/ISSUE_TEMPLATE/SUPPORT.md b/.github/ISSUE_TEMPLATE/SUPPORT.md index 6c3d657..78e3ebe 100644 --- a/.github/ISSUE_TEMPLATE/SUPPORT.md +++ b/.github/ISSUE_TEMPLATE/SUPPORT.md @@ -1,6 +1,6 @@ --- 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 Stack Overflow +about: 👉🏽 Need support, help, or advice? Don't open an issue! Head to "GitHub Discussions" or "Stack Overflow" --- Hey there! 👋 From 7a4f0e66b52056a514af05c4d54e52d83564d2b4 Mon Sep 17 00:00:00 2001 From: Sachin Kumar Date: Thu, 5 Jun 2025 09:49:44 +0530 Subject: [PATCH 4/7] docs: improving typos in ISSUE_TEMPLATE files --- .github/ISSUE_TEMPLATE/SUPPORT.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/SUPPORT.md b/.github/ISSUE_TEMPLATE/SUPPORT.md index 78e3ebe..4c2a9d2 100644 --- a/.github/ISSUE_TEMPLATE/SUPPORT.md +++ b/.github/ISSUE_TEMPLATE/SUPPORT.md @@ -1,6 +1,6 @@ --- name: 🆘 Support, Help, and Advice -about: 👉🏽 Need support, help, or advice? Don't open an issue! Head to "GitHub Discussions" or "Stack Overflow" +about: 👉🏽 Need support, help, or advice? Don't open an issue! Head to [GitHub Discussions](https://github.com/webpack/webpack/discussions) or [Stack Overflow](https://stackoverflow.com/questions/tagged/webpack) --- Hey there! 👋 From 0252e0fad61258bfdba42bb5f9711ac935d16801 Mon Sep 17 00:00:00 2001 From: Sachin Kumar Date: Thu, 5 Jun 2025 09:50:17 +0530 Subject: [PATCH 5/7] docs: improving typos in ISSUE_TEMPLATE files --- .github/ISSUE_TEMPLATE/SUPPORT.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/SUPPORT.md b/.github/ISSUE_TEMPLATE/SUPPORT.md index 4c2a9d2..78e3ebe 100644 --- a/.github/ISSUE_TEMPLATE/SUPPORT.md +++ b/.github/ISSUE_TEMPLATE/SUPPORT.md @@ -1,6 +1,6 @@ --- name: 🆘 Support, Help, and Advice -about: 👉🏽 Need support, help, or advice? Don't open an issue! Head to [GitHub Discussions](https://github.com/webpack/webpack/discussions) or [Stack Overflow](https://stackoverflow.com/questions/tagged/webpack) +about: 👉🏽 Need support, help, or advice? Don't open an issue! Head to "GitHub Discussions" or "Stack Overflow" --- Hey there! 👋 From 9d3534f666c838804202290137cb244ffa60f5c0 Mon Sep 17 00:00:00 2001 From: Sachin Kumar Date: Thu, 5 Jun 2025 09:55:38 +0530 Subject: [PATCH 6/7] docs: improving typos in ISSUE_TEMPLATE files --- .github/ISSUE_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 0aaecb0..f92d3cb 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -2,7 +2,7 @@ 👉🏽 Need support, advice, or help? Don't open an issue! Head to GitHub Discussions(https://github.com/webpack/webpack/discussions) or Stack Overflow(https://stackoverflow.com/questions/tagged/webpack) - Hey there! + Hey there! 👋 You arrived at this template because you felt none of the other options matched the kind of issue you'd like to report. From 4ea7b46e0e55b5e3435ca5293f31a3273d8a7015 Mon Sep 17 00:00:00 2001 From: Sachin Kumar Date: Thu, 5 Jun 2025 10:31:39 +0530 Subject: [PATCH 7/7] docs: improving typos in ISSUE_TEMPLATE files --- .github/ISSUE_TEMPLATE/SUPPORT.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/SUPPORT.md b/.github/ISSUE_TEMPLATE/SUPPORT.md index 78e3ebe..066348a 100644 --- a/.github/ISSUE_TEMPLATE/SUPPORT.md +++ b/.github/ISSUE_TEMPLATE/SUPPORT.md @@ -1,6 +1,6 @@ --- name: 🆘 Support, Help, and Advice -about: 👉🏽 Need support, help, or advice? Don't open an issue! Head to "GitHub Discussions" or "Stack Overflow" +about: 👉🏽 Need support, help, or advice? Don't open an issue - visit "GitHub Discussions" or "Stack Overflow" instead. --- Hey there! 👋