Merge pull request #38 from adorade/develop

adorade · web-flow · commit ee41284991b4 · 2024-08-13T15:04:08.000+03:00
Prepare minor version
diff --git a/.babelrc.cjs b/.babelrc.cjs
@@ -1,5 +1,5 @@
 /*!
- * Gulp Stylelint (v2.1.0): .babelrc.cjs
+ * Gulp Stylelint (v2.2.0): .babelrc.cjs
  * Copyright (c) 2023-24 Adorade (https://github.com/adorade/gulp-stylelint-esm)
  * License under MIT
  * ========================================================================== */
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -1,20 +1,16 @@
 /*!
- * Gulp Stylelint (v2.1.0): .eslintrc.cjs
+ * Gulp Stylelint (v2.2.0): .eslintrc.cjs
  * Copyright (c) 2023-24 Adorade (https://github.com/adorade/gulp-stylelint-esm)
  * License under MIT
  * ========================================================================== */
 
 module.exports = {
   parser: "@babel/eslint-parser",
   env: {
-    browser: true,
     node: true,
     es6: true
   },
   extends: 'stylelint',
-  globals: {
-    module: true
-  },
   parserOptions: {
     ecmaVersion: 2024,
     requireConfigFile: false,
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,29 @@
+---
+name: Bug report
+about: Create a report to help improve gulp-stylelint-esm
+
+---
+
+### Describe the bug
+
+A clear and concise description of what the bug is.
+
+### To Reproduce
+
+Steps to reproduce the behavior.
+
+### Expected behavior
+
+A clear and concise description of what you expected to happen.
+
+### Screenshots
+
+If applicable, add screenshots to help explain the bug.
+
+### Additional context
+
+- gulp-stylelint-esm version:
+- gulp and node version:
+- gulpfile or plugin configuration:
+
+Add any other context about the bug here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,22 @@
+---
+name: Feature request
+about: Suggest an idea for gulp-stylelint-esm
+
+---
+
+### Is your feature request related to a problem? Please describe.
+
+A clear and concise description of what the problem is.
+
+### Describe the solution you'd like
+
+A clear and concise description of what you want to happen.
+
+### Describe alternatives you've considered
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+### Additional context
+
+- gulp-stylelint-esm version:
+- gulp and node version:
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,10 @@
+### Description
+
+Please describe your pull request.
+
+Fixes #
+
+Before submitting pull request, please review the following checklist:
+
+- [ ] Make sure you have read our [CONTRIBUTING.md](https://github.com/adorade/gulp-stylelint-esm/blob/main/CONTRIBUTING.md) document.
+- [ ] Every commit has a descriptive commit message.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,19 @@
+# Contributing to gulp-stylelint-esm
+
+As an open-source project, gulp-stylelint-esm welcomes contributions of many forms.
+
+## Bug reporting or feature request
+
+I appreciate your effort to improve **gulp-stylelint-esm** by submitting a bug report or feature request. Before doing so, please check the following things:
+
+1. Check whether the bug you face **hasn't been already reported**. Checking for duplicate reports takes time that could be used to fix other bugs or make improvements.
+2. Prior to submitting a pull request, it is advisable to create an issue and await feedback.
+3. Specify the **gulp-stylelint-esm**, **gulp** information that may be helpful to fix the problem, especially exact **version numbers**.
+4. If you got some error, please **describe what happened**.
+5. Provide easy steps to reproduce.
+
+Thanks for your help!
+
+Please report [bugs on GitHub][1].
+
+[1]: https://github.com/adorade/gulp-stylelint-esm/issues/new
diff --git a/README.md b/README.md
@@ -26,15 +26,14 @@ npm install stylelint gulp-stylelint-esm --save-dev
 
 ## Quick start
 
-Once you have [configured stylelint](https://stylelint.io/user-guide/configuration/) (e.g. you have a _.stylelintrc_ file), start with the following code. You will find additional configuration [options](#options) below.
+Once you have [configured stylelint](https://stylelint.io/user-guide/configuration/), start with the following code. You will find additional configuration [options](#options) below.
 
 ```js
-import gulp from 'gulp';
+import { src } from 'gulp';
 import gStylelintEsm from 'gulp-stylelint-esm';
 
 function lintCssTask() {
-  return gulp
-    .src('src/**/*.css')
+  return src('src/**/*.css')
     .pipe(gStylelintEsm({
       reporters: [
         { formatter: 'string', console: true }
@@ -60,13 +59,12 @@ Formatters bundled with stylelint: `"compact"`, `"github"`, `"json"`, `"string (
 and accepts a **custom set of options** listed below:
 
 ```js
-import gulp from 'gulp';
+import { src } from 'gulp';
 import gStylelintEsm from 'gulp-stylelint-esm';
 import { myStylelintFormatter } from 'my-stylelint-formatter';
 
 function lintCssTask() {
-  return gulp
-    .src('src/**/*.css')
+  return src('src/**/*.css')
     .pipe(gStylelintEsm({
       failAfterError: true,
       reportOutputDir: 'reports/lint',
@@ -116,17 +114,18 @@ When set to `true`, the error handler will print an error stack trace. Defaults
 
 The `fix: true` option instructs stylelint to try to fix as many issues as possible. The fixes are applied to the gulp stream. The fixed content can be saved to file using gulp `dest`.
 
+> NOTE: Not all stylelint rules can be automatically fixed, so it's advisable to manually resolve errors.
+
 ```js
-import gulp from 'gulp';
+import { src, dest } from 'gulp';
 import gStylelintEsm from 'gulp-stylelint-esm';
 
 function fixCssTask() {
-  return gulp
-    .src('src/**/*.css')
+  return src('src/**/*.css')
     .pipe(gStylelintEsm({
       fix: true
     }))
-    .pipe(gulp.dest('src'));
+    .pipe(dest('src'));
 }
 ```
 
diff --git a/jest.config.js b/jest.config.js
@@ -1,5 +1,5 @@
 /*!
- * Gulp Stylelint (v2.1.0): jest.config.js
+ * Gulp Stylelint (v2.2.0): jest.config.js
  * Copyright (c) 2023-24 Adorade (https://github.com/adorade/gulp-stylelint-esm)
  * License under MIT
  * ========================================================================== */
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "gulp-stylelint-esm",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Gulp plugin for stylelint with ES module support.",
   "author": {
     "name": "Adorade",
@@ -48,7 +48,7 @@
     "@babel/preset-env": "7.25.3",
     "babel-jest": "29.7.0",
     "eslint": "8.57.0",
-    "eslint-config-stylelint": "21.0.0",
+    "eslint-config-stylelint": "22.0.0",
     "gulp": "5.0.0",
     "gulp-clean-css": "4.3.0",
     "gulp-concat": "2.6.1",
diff --git a/src/apply-sourcemap.mjs b/src/apply-sourcemap.mjs
@@ -1,5 +1,5 @@
 /*!
- * Gulp Stylelint (v2.1.0): src/apply-sourcemap.mjs
+ * Gulp Stylelint (v2.2.0): src/apply-sourcemap.mjs
  * Copyright (c) 2023-24 Adorade (https://github.com/adorade/gulp-stylelint-esm)
  * License under MIT
  * ========================================================================== */
diff --git a/src/formatters.mjs b/src/formatters.mjs
@@ -1,5 +1,5 @@
 /*!
- * Gulp Stylelint (v2.1.0): src/formatters.mjs
+ * Gulp Stylelint (v2.2.0): src/formatters.mjs
  * Copyright (c) 2023-24 Adorade (https://github.com/adorade/gulp-stylelint-esm)
  * License under MIT
  * ========================================================================== */
diff --git a/src/index.mjs b/src/index.mjs
@@ -1,5 +1,5 @@
 /*!
- * Gulp Stylelint (v2.1.0): src/index.mjs
+ * Gulp Stylelint (v2.2.0): src/index.mjs
  * Copyright (c) 2023-24 Adorade (https://github.com/adorade/gulp-stylelint-esm)
  * License under MIT
  * ========================================================================== */
diff --git a/src/reporter-factory.mjs b/src/reporter-factory.mjs
@@ -1,5 +1,5 @@
 /*!
- * Gulp Stylelint (v2.1.0): src/reporter-factory.mjs
+ * Gulp Stylelint (v2.2.0): src/reporter-factory.mjs
  * Copyright (c) 2023-24 Adorade (https://github.com/adorade/gulp-stylelint-esm)
  * License under MIT
  * ========================================================================== */
diff --git a/src/writer.mjs b/src/writer.mjs
@@ -1,5 +1,5 @@
 /*!
- * Gulp Stylelint (v2.1.0): src/writer.mjs
+ * Gulp Stylelint (v2.2.0): src/writer.mjs
  * Copyright (c) 2023-24 Adorade (https://github.com/adorade/gulp-stylelint-esm)
  * License under MIT
  * ========================================================================== */
diff --git a/test/fail.test.js b/test/fail.test.js
@@ -1,5 +1,5 @@
 /*!
- * Gulp Stylelint (v2.1.0): test/fail-after-error.test.js
+ * Gulp Stylelint (v2.2.0): test/fail-after-error.test.js
  * Copyright (c) 2023-24 Adorade (https://github.com/adorade/gulp-stylelint-esm)
  * License under MIT
  * ========================================================================== */
diff --git a/test/formatters.test.js b/test/formatters.test.js
@@ -1,5 +1,5 @@
 /*!
- * Gulp Stylelint (v2.1.0): test/formatters.test.js
+ * Gulp Stylelint (v2.2.0): test/formatters.test.js
  * Copyright (c) 2023-24 Adorade (https://github.com/adorade/gulp-stylelint-esm)
  * License under MIT
  * ========================================================================== */
diff --git a/test/index.test.js b/test/index.test.js
@@ -1,5 +1,5 @@
 /*!
- * Gulp Stylelint (v2.1.0): test/index.test.js
+ * Gulp Stylelint (v2.2.0): test/index.test.js
  * Copyright (c) 2023-24 Adorade (https://github.com/adorade/gulp-stylelint-esm)
  * License under MIT
  * ========================================================================== */
diff --git a/test/reporter-factory.test.js b/test/reporter-factory.test.js
@@ -1,5 +1,5 @@
 /*!
- * Gulp Stylelint (v2.1.0): test/reporter-factory.test.js
+ * Gulp Stylelint (v2.2.0): test/reporter-factory.test.js
  * Copyright (c) 2023-24 Adorade (https://github.com/adorade/gulp-stylelint-esm)
  * License under MIT
  * ========================================================================== */
diff --git a/test/sourcemap.test.js b/test/sourcemap.test.js
@@ -1,5 +1,5 @@
 /*!
- * Gulp Stylelint (v2.1.0): test/sourcemap.test.js
+ * Gulp Stylelint (v2.2.0): test/sourcemap.test.js
  * Copyright (c) 2023-24 Adorade (https://github.com/adorade/gulp-stylelint-esm)
  * License under MIT
  * ========================================================================== */
diff --git a/test/writer.test.js b/test/writer.test.js
@@ -1,5 +1,5 @@
 /*!
- * Gulp Stylelint (v2.1.0): test/writer.test.js
+ * Gulp Stylelint (v2.2.0): test/writer.test.js
  * Copyright (c) 2023-24 Adorade (https://github.com/adorade/gulp-stylelint-esm)
  * License under MIT
  * ========================================================================== */
diff --git a/yarn.lock b/yarn.lock
