feat: Add SCSS preset config (#96)

* feat: Add SCSS preset config

* fix: Include README.md and scss.js in package.json files list

* test: Add initial SCSS tests

Author: ntwb

packages/stylelint-config-wordpress/README.md

@@ -9,6 +9,7 @@ Configuration rules to ensure your CSS is compliant with the [WordPress CSS Codi
 
 -   [Installation](#installation)
 -   [Usage](#usage)
+-   [Presets](#presets)
 -   [Extending the config](#extending-the-config)
 -   [Style Guide](#style-guide)
     -   [Structure](#structure)
@@ -47,6 +48,20 @@ If you've globally installed `stylelint-config-wordpress` using the `-g` flag, t
 }
 ```
 
+## Presets
+
+In addition to the default preset, there are also specific presets. All presets extend the default one.
+
+### SCSS
+
+```json
+{
+  "extends": [
+    "stylelint-config-wordpress/scss"
+  ]
+}
+```
+
 ## Extending the config
 
 Simply add a `"rules"` key to your config and add your overrides there.

packages/stylelint-config-wordpress/__tests__/scss.js

@@ -0,0 +1,72 @@
+import config from "../scss.js"
+import stylelint from "stylelint"
+import test from "ava"
+
+/* eslint-disable */
+const validScss = (`
+@import "path/to/foo.scss";
+
+@function fooBar {
+
+	@return 1;
+}
+
+@mixin foo {
+
+	@content;
+}
+
+a {
+
+	@debug 1;
+}
+
+$map: (
+	"foo": 1,
+	"bar": 2,
+	"baz": 3
+);
+
+@if $foo == block {
+	display: block;
+}
+
+@else {
+	display: inline-block;
+}
+`)
+
+const invalidScss = (`
+@unknown {
+	display: block;
+}
+`)
+/* eslint-enable */
+
+test("There are no warnings with values SCSS", t => {
+  return stylelint.lint({
+    code: validScss,
+    config: config,
+    syntax: "scss",
+  })
+  .then(data => {
+    const { errored, results } = data
+    const { warnings } = results[0]
+    t.falsy(errored, "no errored")
+    t.is(warnings.length, 0, "flags no warnings")
+  })
+})
+
+test("There are warnings with invalid values SCSS", t => {
+  return stylelint.lint({
+    code: invalidScss,
+    config: config,
+    syntax: "scss",
+  })
+  .then(data => {
+    const { errored, results } = data
+    const { warnings } = results[0]
+    t.truthy(errored, "errored")
+    t.is(warnings.length, 1, "flags one warning")
+    t.is(warnings[0].text, "Unexpected unknown at-rule \"@unknown\" (at-rule-no-unknown)", "correct warning text") })
+})

packages/stylelint-config-wordpress/package.json

@@ -28,7 +28,9 @@
   "files": [
     "CHANGELOG.md",
     "LICENSE",
-    "index.js"
+    "README.md",
+    "index.js",
+    "scss.js"
   ],
   "engines": {
     "node": ">=4.2.1"
@@ -76,5 +78,8 @@
       "lint-recommended",
       "lint-consistent"
     ]
+  },
+  "dependencies": {
+    "stylelint-scss": "^1.3.4"
   }
 }

packages/stylelint-config-wordpress/scss.js

@@ -0,0 +1,17 @@
+module.exports = {
+  "extends": [
+    "./",
+  ].map(require.resolve),
+
+  plugins: [
+    "stylelint-scss",
+  ],
+
+  rules: {
+
+    // stylelint-config-wordpress css overrides
+    "at-rule-no-unknown": [ true, {
+      ignoreAtRules: [ "extend", "at-root", "debug", "warn", "error", "if", "else", "for", "each", "while", "mixin", "include", "content", "return", "function" ],
+    } ],
+  },
+}