Merge branch 'main' into feature/tests

archoleat · Feb 28, 2024 · bcd2c61 · bcd2c61
2 parents 080b37f + 17082d4
commit bcd2c61
Show file tree

Hide file tree

Showing 17 changed files with 443 additions and 305 deletions.
diff --git a/.gitmodules b/.gitmodules
@@ -1,3 +1,3 @@
 [submodule ".husky"]
   path = .husky
-  url = https://github.com/Archoleat/.husky.git
+  url = https://github.com/archoleat/.husky.git
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/README.md b/README.md
@@ -2,18 +2,16 @@
 
 ![NPM Version](https://img.shields.io/npm/v/%40archoleat%2Fstylelint-config-extended-scss)
 ![NPM Downloads](https://img.shields.io/npm/dm/%40archoleat%2Fstylelint-config-extended-scss)
-![CodeQL](https://img.shields.io/github/actions/workflow/status/Archoleat/stylelint-config-extended-scss/codeql.yaml?label=CodeQL)
-![Test](https://img.shields.io/github/actions/workflow/status/Archoleat/stylelint-config-extended-scss/mocha.yaml?label=Test)
-![Commitlint](https://img.shields.io/github/actions/workflow/status/Archoleat/stylelint-config-extended-scss/commitlint.yaml?label=Commitlint)
-![Editorconfig](https://img.shields.io/github/actions/workflow/status/Archoleat/stylelint-config-extended-scss/editorconfig.yaml?label=Editorconfig)
-![Prettier](https://img.shields.io/github/actions/workflow/status/Archoleat/stylelint-config-extended-scss/prettier.yaml?label=Prettier)
-![ESLint](https://img.shields.io/github/actions/workflow/status/Archoleat/stylelint-config-extended-scss/eslint.yaml?label=ESLint)
-![Markdown](https://img.shields.io/github/actions/workflow/status/Archoleat/stylelint-config-extended-scss/markdown.yaml?label=Markdown)
+![CodeQL](https://img.shields.io/github/actions/workflow/status/archoleat/stylelint-config-extended-scss/codeql.yaml?label=CodeQL)
+![Test](https://img.shields.io/github/actions/workflow/status/archoleat/stylelint-config-extended-scss/mocha.yaml?label=Test)
+![Commitlint](https://img.shields.io/github/actions/workflow/status/archoleat/stylelint-config-extended-scss/commitlint.yaml?label=Commitlint)
+![Editorconfig](https://img.shields.io/github/actions/workflow/status/archoleat/stylelint-config-extended-scss/editorconfig.yaml?label=Editorconfig)
+![Prettier](https://img.shields.io/github/actions/workflow/status/archoleat/stylelint-config-extended-scss/prettier.yaml?label=Prettier)
+![ESLint](https://img.shields.io/github/actions/workflow/status/archoleat/stylelint-config-extended-scss/eslint.yaml?label=ESLint)
+![Markdown](https://img.shields.io/github/actions/workflow/status/archoleat/stylelint-config-extended-scss/markdown.yaml?label=Markdown)
 ![ESM Only](https://img.shields.io/badge/ESM-only-gray?labelColor=fe0)
 ![TS Only](https://img.shields.io/badge/TS-only-gray?labelColor=06f)
 
-> Extended Shareable Config for Stylelint With Property Sorting
-
 ## Table of Contents
 
 -   [This Config](#this-config)
@@ -114,10 +112,10 @@ export default {
 };
 ```
 
-## Remove the Space Between Logical Groups
+## Add the Space Between Logical Groups
 
-If you don't like spaces between logical groups,
-you can easily disable this behavior:
+If you want to add spaces between logical groups,
+add this rule to your **Stylelint** config:
 
 ```js
 // stylelint.config.js
@@ -134,9 +132,7 @@ export default {
 ```scss
 .popup {
   pointer-events: none;
-
   opacity: 0;
-
   position: fixed;
   inset: 0;
 }
@@ -147,7 +143,9 @@ export default {
 ```scss
 .popup {
   pointer-events: none;
+
   opacity: 0;
+
   position: fixed;
   inset: 0;
 }
@@ -169,7 +167,8 @@ This is a list of the lints turned on in this configuration, and what they do.
 
 -   [`value-keyword-case`](https://stylelint.io/user-guide/rules/value-keyword-case):
     Lowercase for keywords values.
-    Ignore `text-rendering`.
+
+    > Ignore: `text-rendering`.
 
 #### Color
 
@@ -186,11 +185,6 @@ This is a list of the lints turned on in this configuration, and what they do.
 -   [`no-descending-specificity`](https://stylelint.io/user-guide/rules/no-descending-specificity):
     Rule disabled.
 
-#### Empty Lines
-
--   [`declaration-empty-line-before`](https://stylelint.io/user-guide/rules/declaration-empty-line-before):
-    The rule is disabled for `stylelint-order` to work correctly.
-
 #### Function
 
 -   [`function-url-no-scheme-relative`](https://stylelint.io/user-guide/rules/function-url-no-scheme-relative):
@@ -200,7 +194,8 @@ This is a list of the lints turned on in this configuration, and what they do.
 
 -   [`max-nesting-depth`](https://stylelint.io/user-guide/rules/max-nesting-depth):
     Limit the allowed nesting depth to `3`.
-    Ignore: `'blockless-at-rules'`.
+
+    > Ignore: `'blockless-at-rules'`.
 
 -   [`selector-max-combinators`](https://stylelint.io/user-guide/rules/selector-max-combinators):
     Limit the allowed combinators to `4`.
@@ -247,11 +242,13 @@ This is a list of the lints turned on in this configuration, and what they do.
 
 -   [`scss/at-function-named-arguments`](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/at-function-named-arguments):
     Require named parameters in **SCSS** function call rule.
-    Ignore `single-argument`.
+
+    > Ignore: `single-argument`.
 
 -   [`scss/at-mixin-named-arguments`](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/at-mixin-named-arguments):
     Require named parameters in **at-mixin** call rule.
-    Ignore `single-argument`.
+
+    > Ignore: `single-argument`.
 
 -   [`scss/at-root-no-redundant`](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/at-root-no-redundant):
     Disallow redundant `@at-root` rule.
@@ -278,6 +275,13 @@ This is a list of the lints turned on in this configuration, and what they do.
 
 #### Dollar Variable
 
+-   [`scss/dollar-variable-empty-line-after`](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/scss/dollar-variable-empty-line-after):
+    Require a newline after the `$`-variable declaration.
+
+    > Expect: `last-nested`, `before-comment`, `before-dollar-variable`.
+    >
+    > Ignore: `before-comment`, `inside-single-line-block`.
+
 -   [`scss/dollar-variable-colon-newline-after`](https://github.com/stylelint-scss/stylelint-scss/tree/master/src/rules/dollar-variable-colon-newline-after):
     Require a newline after the colon in `$`-variable declarations.
 
@@ -329,5 +333,4 @@ This is a list of the lints turned on in this configuration, and what they do.
 
 ## License
 
-This project is licensed under the MIT license - see the
-[**LICENSE**](LICENSE) for details.
+This project is licensed under the [**MIT license**](LICENSE).
diff --git a/eslint.config.js b/eslint.config.js
@@ -3,15 +3,13 @@ import globals from 'globals';
 import typescriptParser from '@typescript-eslint/parser';
 import unicorn from 'eslint-plugin-unicorn';
 
-//! migrate to flat config
 import { resolve } from 'node:path';
 import { FlatCompat } from '@eslint/eslintrc';
 
 const compat = new FlatCompat({
   baseDirectory: resolve(),
   resolvePluginsRelativeTo: resolve(),
 });
-//!--------------------------
 
 export default [
   ...compat.extends(

diff --git a/package.json b/package.json
@@ -9,7 +9,7 @@
   "email": "archoleat@gmail.com",
   "name": "@archoleat/stylelint-config-extended-scss",
   "description": "Extended config for Stylelint with property sorting",
-  "version": "1.5.8",
+  "version": "1.6.4",
   "license": "MIT",
   "keywords": [
     "archoleat-config-scss",
@@ -32,17 +32,17 @@
     "stylelint-plugin-logical-css",
     "stylelint-prettier"
   ],
-  "homepage": "https://github.com/Archoleat/stylelint-config-extended-scss#readme",
+  "homepage": "https://github.com/archoleat/stylelint-config-extended-scss#readme",
   "repository": {
     "type": "git",
-    "url": "https://github.com/Archoleat/stylelint-config-extended-scss.git"
+    "url": "https://github.com/archoleat/stylelint-config-extended-scss.git"
   },
   "bugs": {
-    "url": "https://github.com/Archoleat/stylelint-config-extended-scss/issues"
+    "url": "https://github.com/archoleat/stylelint-config-extended-scss/issues"
   },
   "scripts": {
     "init": "pnpm i && husky && git submodule update",
-    "build": "rollup -c && pnpm clear",
+    "build": "rollup -c",
     "test": "mocha",
     "test:coverage": "nyc pnpm test && pnpm clear",
     "release": "semantic-release",
@@ -51,16 +51,19 @@
     "lint:md": "remark . --quiet",
     "lint:ts": "eslint src/**/*.ts --fix",
     "prettify": "prettier . --write",
-    "commit": "cz",
-    "clear": "rm -rf .nyc_report .rollup.cache dist"
+    "commit": "cz"
   },
+  "files": [
+    "index.d.ts",
+    "index.js"
+  ],
   "engines": {
     "node": ">=20.11.0",
-    "pnpm": ">=8.15.3"
+    "pnpm": ">=8.15.4"
   },
   "volta": {
     "node": "20.11.0",
-    "pnpm": "8.15.3"
+    "pnpm": "8.15.4"
   },
   "peerDependencies": {
     "stylelint": "^14.0.0 || ^15.0.0 || ^16.0.0"
@@ -86,15 +89,15 @@
     "@rollup/plugin-typescript": "^11.1.6",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "@types/chai": "^4.3.11",
+    "@types/chai": "^4.3.12",
     "@types/mocha": "^10.0.6",
-    "@typescript-eslint/eslint-plugin": "^7.0.2",
-    "@typescript-eslint/parser": "^7.0.2",
+    "@typescript-eslint/eslint-plugin": "^7.1.0",
+    "@typescript-eslint/parser": "^7.1.0",
     "chai": "^5.1.0",
     "conventional-changelog-conventionalcommits": "^7.0.2",
     "cz-conventional-changelog": "^3.3.0",
     "editorconfig-checker": "^5.1.4",
-    "eslint": "^8.56.0",
+    "eslint": "^8.57.0",
     "eslint-config-airbnb-typescript": "^17.1.0",
     "eslint-import-resolver-typescript": "^3.6.1",
     "eslint-plugin-import": "^2.29.1",