Prepare 5.0.0 (#84)

.github/workflows/test.yml

@@ -1,33 +1,62 @@
-name: Tests
-on: [push, pull_request]
-env:
-  CI: true
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - '**'
 
 jobs:
-  run:
-    name: Node ${{ matrix.node }} on ${{ matrix.os }}
+  lint:
+    name: Lint
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Use Node.js ${{ matrix.node }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: 'lts/*'
+          cache: npm
+
+      - name: Install latest npm
+        run: npm install --global npm@latest
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Lint
+        run: npm run lint
+
+  test:
+    name: Test on Node.js ${{ matrix.node }} and ${{ matrix.os }}
+
     runs-on: ${{ matrix.os }}
 
     strategy:
       fail-fast: false
       matrix:
-        node: [12, 14]
-        os: [ubuntu-latest, windows-latest]
+        node: [12, 14, 16]
+        os: [ubuntu-latest, windows-latest, macos-latest]
 
     steps:
-      - name: Clone repository
-        uses: actions/checkout@v2
+      - uses: actions/checkout@v2
 
-      - name: Set Node.js version
-        uses: actions/setup-node@v1
+      - name: Use Node.js ${{ matrix.node }}
+        uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node }}
+          cache: npm
 
-      - run: node --version
-      - run: npm --version
+      - name: Install latest npm
+        run: npm install --global npm@latest
 
-      - name: Install npm dependencies
+      - name: Install dependencies
         run: npm ci
 
-      - name: Run tests
+      - name: Test
         run: npm test

.prettierignore

@@ -1 +1 @@
-*.md
+__tests__/*.scss

CHANGELOG.md

@@ -1,43 +1,66 @@
+# 5.0.0
+
+This release adds over a dozen new rules.
+
+If needed, you can [extend the config](README.md#extending-the-config) to turn off any of the new rules.
+
+- Removed: `stylelint` less than `14.0.0` from peer dependencies.
+- Changed: updated to [`stylelint-config-recommended@6.0.0`](https://github.com/stylelint-scss/stylelint-config-recommended-scss/releases/tag/6.0.0).
+- Added: `scss/at-extend-no-missing-placeholder` rule.
+- Added: `scss/at-if-no-null` rule.
+- Added: `scss/at-import-no-partial-leading-underscore` rule.
+- Added: `scss/at-import-partial-extension` rule.
+- Added: `scss/comment-no-empty` rule.
+- Added: `scss/declaration-nested-properties-no-divided-groups` rule.
+- Added: `scss/dollar-variable-no-missing-interpolation` rule.
+- Added: `scss/function-quote-no-quoted-strings-inside` rule.
+- Added: `scss/function-unquote-no-unquoted-strings-inside` rule.
+- Added: `scss/no-duplicate-mixins` rule.
+- Added: `scss/no-global-function-names` rule.
+- Added: `scss/operator-no-newline-after` rule.
+- Added: `scss/operator-no-newline-before` rule.
+- Added: `scss/operator-no-unspaced` rule.
+
 # 4.3.0
 
--   Updated `stylelint-config-recommended` dependency to version 5.0.0.
+- Updated `stylelint-config-recommended` dependency to version 5.0.0.
 
 # 4.2.0
 
--   Added: support for stylelint 13.
+- Added: support for stylelint 13.
 
 # 4.1.0
 
--   Added: support for stylelint 12.
+- Added: support for stylelint 12.
 
 # 4.0.0
 
--   **Breaking change** update to peer depedencies: `stylelint`@10.1.0+ and `stylelint-scss`@3.0.0+ are required now.
--   Updated: `stylelint-config-recommended` dependency to version 3.0.0.
--   Added: support for stylelint 11.
+- **Breaking change** update to peer depedencies: `stylelint`@10.1.0+ and `stylelint-scss`@3.0.0+ are required now.
+- Updated: `stylelint-config-recommended` dependency to version 3.0.0.
+- Added: support for stylelint 11.
 
 # 3.3.0
 
--   Added: support for stylelint 10.
--   Updated `stylelint-config-recommended` dependency to version 2.2.0.
+- Added: support for stylelint 10.
+- Updated `stylelint-config-recommended` dependency to version 2.2.0.
 
 # 3.2.0
 
--   Added: support for stylelint-scss v3.
+- Added: support for stylelint-scss v3.
 
 # 3.1.0
 
--   Added: support for stylelint 9.
+- Added: support for stylelint 9.
 
 # 3.0.0
 
--   Updated `stylelint-config-recommended` dependency to version 2.0.0.
--   Updated `stylelint` peer dependency to version 8.3.0.
+- Updated `stylelint-config-recommended` dependency to version 2.0.0.
+- Updated `stylelint` peer dependency to version 8.3.0.
 
 # 2.0.0
 
--   Updated `stylelint-scss` dependency to version 2.
+- Updated `stylelint-scss` dependency to version 2.
 
 # 1.0.0
 
--   Initial release
+- Initial release

README.md

@@ -1,61 +1,49 @@
 # stylelint-config-recommended-scss
 
 [![npm version](http://img.shields.io/npm/v/stylelint-config-recommended-scss.svg)](https://www.npmjs.org/package/stylelint-config-recommended-scss)
-[![Build Status](https://github.com/kristerkari/stylelint-config-recommended-scss/workflows/Tests/badge.svg)](https://github.com/kristerkari/stylelint-config-recommended-scss/actions?workflow=Tests)
+[![Build Status](https://github.com/stylelint-scss/stylelint-config-recommended-scss/workflows/CI/badge.svg)](https://github.com/stylelint-scss/stylelint-config-recommended-scss/actions?workflow=CI)
 [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)
 [![Downloads per month](https://img.shields.io/npm/dm/stylelint-config-recommended-scss.svg)](https://npmcharts.com/compare/stylelint-config-recommended-scss)
-[![Greenkeeper badge](https://badges.greenkeeper.io/kristerkari/stylelint-config-recommended-scss.svg)](https://greenkeeper.io/)
 
 > The recommended shareable SCSS config for stylelint.
 
-It turns on all the [_possible errors_](https://github.com/stylelint/stylelint/blob/master/docs/user-guide/rules/list.md#possible-errors) rules within stylelint.
+This config:
 
-Use it as is or as a foundation for your own config.
+- extends the [`stylelint-config-recommended` shared config](https://github.com/stylelint/stylelint-config-recommended) and configures its rules for SCSS
+- bundles the [`stylelint-scss` plugin pack](https://github.com/stylelint-scss/stylelint-scss) and turns on its rules that check for possible errors
+- bundles the [`postcss-scss` custom syntax](https://github.com/postcss/postcss-scss) and configures it
 
-## Installation
-
-First, install stylelint-scss and stylelint, if you haven't done so yet via npm:
+This config is extended by the [`stylelint-config-standard-scss` shared config](https://github.com/stylelint-scss/stylelint-config-standard-scss). That config is better suited to most users as it also turns on the stylistic rules in the [`stylelint-scss` plugin pack](https://github.com/stylelint-scss/stylelint-scss).
 
-```shell
-npm install stylelint stylelint-scss --save-dev
-```
+To see the rules that this config uses, please read the [config itself](/index.js).
 
-and then you can install the config:
+## Installation
 
 ```shell
-npm install stylelint-config-recommended-scss --save-dev
+npm install --save-dev stylelint-config-recommended-scss
 ```
 
 ## Usage
 
-If you've installed `stylelint-config-recommended-scss` locally within your project, just set your `stylelint` config to:
+Set your `stylelint` config to:
 
 ```json
 {
   "extends": "stylelint-config-recommended-scss"
 }
 ```
 
-If you've globally installed `stylelint-config-recommended-scss` using the `-g` flag, then you'll need to use the absolute path to `stylelint-config-recommended-scss` in your config e.g.
-
-```json
-{
-  "extends": "/absolute/path/to/stylelint-config-recommended-scss"
-}
-```
-
 ### Extending the config
 
 Simply add a `"rules"` key to your config, then add your overrides and additions there.
 
-For example, to turn off the `block-no-empty` rule, and add the `unit-whitelist` rule:
+For example, to turn off the `scss/at-if-no-null` rule:
 
 ```json
 {
   "extends": "stylelint-config-recommended-scss",
   "rules": {
-    "block-no-empty": null,
-    "unit-whitelist": ["em", "rem", "s"]
+    "scss/at-if-no-null": null
   }
 }
 ```