Release prep changes (#201)

.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: Tests
+name: CI
 on: [push, pull_request]
 env:
   CI: true

CHANGELOG.md

@@ -4,12 +4,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [8.0.1]
+## [Unreleased]
+### Changed
+- Updated repo to be compatible with stylelint v14. Updated stylelint peerDependency range from `^13.0.0` to `^14.0.0` [PR](https://github.com/bjankord/stylelint-config-sass-guidelines/pull/197)
+- Renamed tests files extension from `.js`to `.spec.js`
+- Moved manually tested passing and failing SCSS examples into `__tests__/manual-test-cases`
+
 ### Added
 - Added node 16 to automated test matrix
 
 ### Removed
+- Dropped official support for Node 10 [PR](https://github.com/bjankord/stylelint-config-sass-guidelines/pull/197)
+- Removed node 10 from automated test matrix [PR](https://github.com/bjankord/stylelint-config-sass-guidelines/pull/198)
 - Removed babel as a dev dependency, resolves issue with security vuln in glob-parent CVE-2020-28469
+- Removed `src/.stylelint.json`
 
 ## [8.0.0]
 ### Added

README.md

@@ -1,18 +1,20 @@
 # stylelint-config-sass-guidelines
 
 [![NPM version](http://img.shields.io/npm/v/stylelint-config-sass-guidelines.svg)](https://www.npmjs.org/package/stylelint-config-sass-guidelines)
-
-[![Build Status](https://travis-ci.org/bjankord/stylelint-config-sass-guidelines.svg?branch=master)](https://travis-ci.org/bjankord/stylelint-config-sass-guidelines)
-[![Downloads per month](https://img.shields.io/npm/dm/stylelint-config-sass-guidelines.svg)](http://npmcharts.com/compare/stylelint-config-sass-guidelines)
-
-[![Dependency Status](https://david-dm.org/bjankord/stylelint-config-sass-guidelines.svg)](https://david-dm.org/bjankord/stylelint-config-sass-guidelines)
-[![devDependency Status](https://david-dm.org/bjankord/stylelint-config-sass-guidelines/dev-status.svg)](https://david-dm.org/bjankord/stylelint-config-sass-guidelines/?type=dev)
+[![Build Status](https://github.com/bjankord/stylelint-config-sass-guidelines/workflows/CI/badge.svg)](https://github.com/bjankord/stylelint-config-sass-guidelines/actions?workflow=CI)
 [![Known Vulnerabilities](https://snyk.io/test/github/bjankord/stylelint-config-sass-guidelines/badge.svg)](https://snyk.io//test/github/bjankord/stylelint-config-sass-guidelines)
+[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/bjankord/stylelint-config-sass-guidelines/blob/main/CONTRIBUTING.md)
+[![Downloads per month](https://img.shields.io/npm/dm/stylelint-config-sass-guidelines.svg)](http://npmcharts.com/compare/stylelint-config-sass-guidelines)
 
-A stylelint config inspired by [sass-guidelin.es](https://sass-guidelin.es/).
+> A stylelint config inspired by [sass-guidelin.es](https://sass-guidelin.es/).
 
 This linter has been designed / tested with SCSS syntax based on the SCSS guidelines documented in https://sass-guidelin.es/. It is intended for use with SCSS syntax, not Sass (tab style) syntax.
 
+This config:
+- 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 [`stylelint-order` plugin pack](https://github.com/hudochenkov/stylelint-order) 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
+
 # Translations
 
 * [Deutsch](page/de.md)
@@ -56,11 +58,6 @@ For example, to change the `indentation` to tabs and turn off the `number-leadin
 
 ## Documentation
 
-### Plugins
-
-* [`stylelint-order`](https://github.com/hudochenkov/stylelint-order): A plugin pack of order related linting rules for stylelint.
-* [`stylelint-scss`](https://github.com/kristerkari/stylelint-scss): A collection of SCSS specific linting rules for stylelint
-
 ### Configured lints
 
 This is a list of the lints turned on in this configuration, and what they do.

RELEASE.md

@@ -15,5 +15,5 @@ Releasing the project requires these steps:
 
 
 [npm-url]: https://www.npmjs.com/package/stylelint-config-sass-guidelines
-[release-scripts-url]: https://github.com/bjankord/stylelint-config-sass-guidelines/blob/master/package.json#L48-L50
+[release-scripts-url]: https://github.com/bjankord/stylelint-config-sass-guidelines/blob/main/package.json#L48-L50
 [github-release-url]: https://github.com/bjankord/stylelint-config-sass-guidelines/releases

__tests__/README.md

@@ -1,8 +1,6 @@
 # How to add tests
 
-* Update `./src/.stylelintrc.json` with your new rules
-* Run npm run build to generate `./index.js`
-* Create your test file named after the scss-lint your you are adding a stylelint rule for
+* Create your test file named after the scss lint your you are adding a stylelint rule for. For example, `__tests___/unit/bang-format.spec.js`
 * Copy the code from one of the other tests into your test new file
 * Update the test so you have .scss code that will produce lint you want to test for
 * Add a console.log statement within the checkResult function in the test file passing `result` to the log statement. e.g. `console.log(result)`

__tests__/manual-test-cases/stylelint.config.js

@@ -0,0 +1,2 @@
+const rules = require('../../index');
+module.exports = {...rules};

__tests__/bang-format.js → __tests__/unit/bang-format.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/border-zero.js → __tests__/unit/border-zero.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/color-keyword.js → __tests__/unit/color-keyword.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/debug-statement.js → __tests__/unit/debug-statement.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/declaration-order.js → __tests__/unit/declaration-order.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/empty-line-between-blocks.js → __tests__/unit/empty-line-between-blocks.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/empty-rule.js → __tests__/unit/empty-rule.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/final-newline.js → __tests__/unit/final-newline.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/hex-length.js → __tests__/unit/hex-length.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/hex-notation.js → __tests__/unit/hex-notation.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/hex-validation.js → __tests__/unit/hex-validation.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/id-selector.js → __tests__/unit/id-selector.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/import-path.js → __tests__/unit/import-path.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/indentation.js → __tests__/unit/indentation.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/leading-zero.js → __tests__/unit/leading-zero.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/name-format.js → __tests__/unit/name-format.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/nesting-depth.js → __tests__/unit/nesting-depth.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/placeholder-in-extend.js → __tests__/unit/placeholder-in-extend.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/property-spelling.js → __tests__/unit/property-spelling.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/pseudo-element.js → __tests__/unit/pseudo-element.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/qualifying-element.js → __tests__/unit/qualifying-element.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/selector-depth.js → __tests__/unit/selector-depth.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/selector-format.js → __tests__/unit/selector-format.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/shorthand.js → __tests__/unit/shorthand.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/single-line-per-property.js → __tests__/unit/single-line-per-property.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/single-line-per-selector.js → __tests__/unit/single-line-per-selector.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/space-after-comma.js → __tests__/unit/space-after-comma.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/space-after-property-colon.js → __tests__/unit/space-after-property-colon.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/space-after-property-name.js → __tests__/unit/space-after-property-name.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/space-after-variable-colon.js → __tests__/unit/space-after-variable-colon.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/space-after-variable-name.js → __tests__/unit/space-after-variable-name.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/space-before-brace.js → __tests__/unit/space-before-brace.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/space-between-parens.js → __tests__/unit/space-between-parens.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/string-quotes.js → __tests__/unit/string-quotes.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/trailing-semicolon.js → __tests__/unit/trailing-semicolon.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/trailing-zero.js → __tests__/unit/trailing-zero.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/unnecessary-mantissa.js → __tests__/unit/unnecessary-mantissa.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/unnecessary-parent-reference.js → __tests__/unit/unnecessary-parent-reference.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/url-quotes.js → __tests__/unit/url-quotes.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/valid-scss.js → __tests__/unit/valid-scss.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/vendor-prefixes.js → __tests__/unit/vendor-prefixes.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

__tests__/zero-unit.js → __tests__/unit/zero-unit.spec.js

@@ -1,4 +1,4 @@
-const config = require("../index");
+const config = require("../../index");
 const stylelint = require("stylelint");
 const postcss = require("postcss");
 const scssSyntax = require("postcss-scss");

package.json

@@ -8,7 +8,9 @@
     "stylelint-scss",
     "scss",
     "sass",
-    "guidelines"
+    "guidelines",
+    "lint",
+    "linter"
   ],
   "author": "Brett Jankord",
   "license": "MIT",
@@ -36,26 +38,15 @@
     "stylelint": "^14.0.0"
   },
   "devDependencies": {
-    "prepend-file": "^2.0.0",
-    "shelljs": "^0.8.1",
     "stylelint": "^14.0.0",
     "tape": "^5.3.1"
   },
   "scripts": {
-    "build": "node scripts/build.js",
     "release:major": "npm test && npm run build && npm version major -m \"Released version %s\" && npm publish && git push --follow-tags",
     "release:minor": "npm test && npm run build && npm version minor -m \"Released version %s\" && npm publish && git push --follow-tags",
     "release:patch": "npm test && npm run build && npm version patch -m \"Released version %s\" && npm publish && git push --follow-tags",
-    "scss-lint-failing-case": "cd src; bundle exec scss-lint failing-test-cases.scss -c .scss-lint.yml; exit 0",
-    "scss-lint-passing-case": "cd src; bundle exec scss-lint passing-test-cases.scss -c .scss-lint.yml; exit 0",
-    "stylelint-failing-case": "cd src; stylelint failing-test-cases.scss; exit 0",
-    "stylelint-passing-case": "cd src; stylelint passing-test-cases.scss; exit 0",
-    "tape": "tape \"__tests__/**/*.js\"",
-    "test": "npm run build && npm run tape"
-  },
-  "babel": {
-    "presets": [
-      "@babel/preset-env"
-    ]
+    "stylelint-failing-case": "cd __tests__/manual-test-cases; stylelint failing-test-cases.scss",
+    "stylelint-passing-case": "cd __tests__/manual-test-cases; stylelint passing-test-cases.scss",
+    "test": "tape \"__tests__/unit/*.spec.js\""
   }
 }