@double-great/stylelint-a11y 2.0.0

package/.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": ["@babel/preset-env"]
+}

package/.eslintignore

@@ -0,0 +1,2 @@
+build/*
+node_modules/*

package/.eslintrc.js

@@ -0,0 +1,27 @@
+module.exports = {
+  extends: ['eslint:recommended', 'prettier'],
+  parser: '@babel/eslint-parser',
+  parserOptions: {
+    sourceType: 'module',
+    ecmaVersion: 6,
+  },
+  env: {
+    es6: true,
+    jest: true,
+    node: true,
+  },
+  plugins: ['prettier', 'import'],
+  globals: {
+    testRule: true,
+  },
+  rules: {
+    'prettier/prettier': [
+      'error',
+      {
+        printWidth: 100,
+        singleQuote: true,
+        trailingComma: 'es5',
+      },
+    ],
+  },
+};

package/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'monthly'
+  - package-ecosystem: 'npm'
+    directory: '/'
+    schedule:
+      interval: 'monthly'

package/.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Test
+
+on:
+  pull_request:
+
+jobs:
+  build-npm:
+    name: Run NPM install and test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: 'npm'
+      - name: Test
+        run: |
+          node -v
+          npm -v
+          npm ci
+          npm run test

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx pretty-quick --staged

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Stanislav
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,68 @@
+# @double-great/stylelint-a11y
+
+## Installation and usage
+
+```bash
+npm i --save-dev stylelint @double-great/stylelint-a11y
+```
+
+Create the `.stylelintrc.json` config file (or open the existing one), add `stylelint-a11y` to the plugins array and the rules you need to the rules list. All rules from stylelint-a11y need to be namespaced with `a11y`.
+
+Please refer to [stylelint docs](https://stylelint.io/user-guide/) for the detailed info on using this linter.
+
+## Rules
+
+| Rule ID                                                                                    | Description                                                             |                      |
+| :----------------------------------------------------------------------------------------- | :---------------------------------------------------------------------- | -------------------- |
+| [content-property-no-static-value](./src/rules/content-property-no-static-value/README.md) | Disallow unaccessible CSS generated content in pseudo-elements          |                      |
+| [font-size-is-readable](./src/rules/font-size-is-readable/README.md)                       | Disallow font sizes less than `15px`                                    |                      |
+| [line-height-is-vertical-rhythmed](./src/rules/line-height-is-vertical-rhythmed/README.md) | Disallow not vertical rhythmed `line-height`                            |                      |
+| [media-prefers-reduced-motion](./src/rules/media-prefers-reduced-motion/README.md)         | Require certain styles if the animation or transition in media features | Recommended, Fixable |
+| [media-prefers-color-scheme](./src/rules/media-prefers-color-scheme/README.md)             | Require implementation of certain styles for selectors with colors.     |                      |
+| [no-display-none](./src/rules/no-display-none/README.md)                                   | Disallow content hiding with `display: none` property                   |                      |
+| [no-obsolete-attribute](./src/rules/no-obsolete-attribute/README.md)                       | Disallow obsolete attribute using                                       |                      |
+| [no-obsolete-element](./src/rules/no-obsolete-element/README.md)                           | Disallow obsolete selectors using                                       |                      |
+| [no-spread-text](./src/rules/no-spread-text/README.md)                                     | Require width of text in a comfortable range                            |                      |
+| [no-outline-none](./src/rules/no-outline-none/README.md)                                   | Disallow outline clearing                                               | Recommended          |
+| [no-text-align-justify](./src/rules/no-text-align-justify/README.md)                       | Disallow content with `text-align: justify`                             |                      |
+| [selector-pseudo-class-focus](./src/rules/selector-pseudo-class-focus/README.md)           | Require or disallow a pseudo-element to the selectors with `:hover`     | Recommended, Fixable |
+
+## Recommended config
+
+Add recommended configuration by adding the following to `extends` in your stylelint configuration:
+
+```
+@double-great/stylelint-a11y/recommended
+```
+
+This shareable config contains the following:
+
+```json
+{
+  "plugins": ["@double-great/stylelint-a11y"],
+  "rules": {
+    "a11y/media-prefers-reduced-motion": true,
+    "a11y/no-outline-none": true,
+    "a11y/selector-pseudo-class-focus": true
+  }
+}
+```
+
+Since it adds stylelint-a11y to `plugins`, you don't have to do this yourself when extending this config.
+
+## Help out
+
+There work on the plugin's rules is still in progress, so if you feel like it, you're welcome to help out in any of these (the plugin follows stylelint guidelines so most part of this is based on its docs):
+
+- Create, enhance, and debug rules (see stylelint's guide to "[Working on rules](https://github.com/stylelint/stylelint/blob/main/docs/developer-guide/rules.md)").
+- Improve documentation.
+- Chime in on any open issue or pull request.
+- Open new issues about your ideas on new rules, or for how to improve the existing ones, and pull requests to show us how your idea works.
+- Add new tests to absolutely anything.
+- Work on improving performance of rules.
+- Contribute to [stylelint](https://github.com/stylelint/stylelint)
+- Spread the word.
+
+We communicate via [issues](https://github.com/double-great/stylelint-a11y/issues) and [pull requests](https://github.com/double-great/stylelint-a11y/pulls).
+
+There is also [stackoverflow](https://stackoverflow.com/questions/tagged/stylelint), which would be the preferred QA forum.

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+
+var _stylelint = require("stylelint");
+
+var _rules = _interopRequireDefault(require("./rules"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+
+var rulesPlugins = Object.keys(_rules["default"]).map(function (ruleName) {
+  return (0, _stylelint.createPlugin)("a11y/".concat(ruleName), _rules["default"][ruleName]);
+});
+var _default = rulesPlugins;
+exports["default"] = _default;

package/dist/rules/content-property-no-static-value/__tests__/index.js

@@ -0,0 +1,37 @@
+"use strict";
+
+var _index = require("../index");
+
+testRule({
+  ruleName: _index.ruleName,
+  config: [true],
+  accept: [{
+    code: ".foo::after { content: ''; }"
+  }, {
+    code: 'a { }'
+  }, {
+    code: ".foo:after { content: ''; }"
+  }, {
+    code: '.foo::after { content: ""; }'
+  }, {
+    code: '.bar::before { content: attr(aria-label); }'
+  }, {
+    code: ".foo { font-size: '12px'; width: '200px'; }"
+  }],
+  reject: [{
+    code: '.foo::before { content: "bar"; }',
+    message: _index.messages.expected('.foo::before'),
+    line: 1,
+    column: 3
+  }, {
+    code: '.bar::before { content: 23; }',
+    message: _index.messages.expected('.bar::before'),
+    line: 1,
+    column: 3
+  }, {
+    code: ".foo:before, .bar { content: ''; }",
+    message: _index.messages.expected('.foo:before, .bar'),
+    line: 1,
+    column: 3
+  }]
+});

package/dist/rules/content-property-no-static-value/index.js

@@ -0,0 +1,90 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = _default;
+exports.ruleName = exports.messages = void 0;
+
+var _stylelint = require("stylelint");
+
+var _isStandardSyntaxRule = _interopRequireDefault(require("stylelint/lib/utils/isStandardSyntaxRule"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+
+var ruleName = 'a11y/content-property-no-static-value';
+exports.ruleName = ruleName;
+
+var messages = _stylelint.utils.ruleMessages(ruleName, {
+  expected: function expected(selector) {
+    return "Unexpected using \"content\" property in ".concat(selector);
+  }
+});
+
+exports.messages = messages;
+
+var isContentPropertyUsedCorrectly = function isContentPropertyUsedCorrectly(selectors) {
+  return selectors.every(function (selector) {
+    return /:before|:after/.test(selector);
+  });
+};
+
+var checkNodesForContentProperty = function checkNodesForContentProperty(node) {
+  return node.nodes.filter(function (node) {
+    return node.prop;
+  }).some(function (node) {
+    return node.prop.toLowerCase() === 'content';
+  });
+};
+
+function check(node) {
+  if (node.type !== 'rule' || !checkNodesForContentProperty(node) || !node.first) {
+    return true;
+  }
+
+  return node.nodes.some(function (o) {
+    return o.type === 'decl' && o.prop.toLowerCase() === 'content' && isContentPropertyUsedCorrectly(o.parent.selectors) && (o.value.toLowerCase() === "''" || o.value.toLowerCase() === '""' || o.value.toLowerCase() === 'attr(aria-label)');
+  });
+}
+
+function _default(actual) {
+  return function (root, result) {
+    var validOptions = _stylelint.utils.validateOptions(result, ruleName, {
+      actual: actual
+    });
+
+    if (!validOptions || !actual) {
+      return;
+    }
+
+    root.walk(function (node) {
+      var selector = null;
+
+      if (node.type === 'rule') {
+        if (!(0, _isStandardSyntaxRule["default"])(node)) {
+          return;
+        }
+
+        selector = node.selector;
+      } else if (node.type === 'atrule' && node.name.toLowerCase() === 'page' && node.params) {
+        selector = node.params;
+      }
+
+      if (!selector) {
+        return;
+      }
+
+      var isAccepted = check(node);
+
+      if (!isAccepted) {
+        _stylelint.utils.report({
+          index: node.lastEach,
+          message: messages.expected(selector),
+          node: node,
+          ruleName: ruleName,
+          result: result
+        });
+      }
+    });
+  };
+}

package/dist/rules/font-size-is-readable/__tests__/index.js

@@ -0,0 +1,35 @@
+"use strict";
+
+var _index = require("../index");
+
+testRule({
+  ruleName: _index.ruleName,
+  config: [true],
+  accept: [{
+    code: '.foo { }'
+  }, {
+    code: '.foo { font-size: 15px; }'
+  }, {
+    code: '.foo { font-size: 12pt; }'
+  }, {
+    code: '.bar { FONT-SIZE: 15PX; }'
+  }, {
+    code: '.baz { font-size: 1em; }'
+  }],
+  reject: [{
+    code: '.foo { font-size: 10px; }',
+    message: _index.messages.expected('.foo'),
+    line: 1,
+    column: 3
+  }, {
+    code: '.foo { font-size: 3pt; }',
+    message: _index.messages.expected('.foo'),
+    line: 1,
+    column: 3
+  }, {
+    code: '.bar { FONT-SIZE: 8PX; }',
+    message: _index.messages.expected('.bar'),
+    line: 1,
+    column: 3
+  }]
+});

package/dist/rules/font-size-is-readable/index.js

@@ -0,0 +1,77 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = _default;
+exports.ruleName = exports.messages = void 0;
+
+var _stylelint = require("stylelint");
+
+var _isStandardSyntaxRule = _interopRequireDefault(require("stylelint/lib/utils/isStandardSyntaxRule"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+
+var ruleName = 'a11y/font-size-is-readable';
+exports.ruleName = ruleName;
+
+var messages = _stylelint.utils.ruleMessages(ruleName, {
+  expected: function expected(selector) {
+    return "Expected a larger font-size in ".concat(selector);
+  }
+});
+
+exports.messages = messages;
+var THRESHOLD_IN_PX = 15;
+
+var pxToPt = function pxToPt(v) {
+  return 0.75 * v;
+};
+
+var checkInPx = function checkInPx(value) {
+  return value.toLowerCase().endsWith('px') && parseFloat(value) < THRESHOLD_IN_PX;
+};
+
+var checkInPt = function checkInPt(value) {
+  return value.toLowerCase().endsWith('pt') && parseFloat(value) < pxToPt(THRESHOLD_IN_PX);
+};
+
+function _default(actual) {
+  return function (root, result) {
+    var validOptions = _stylelint.utils.validateOptions(result, ruleName, {
+      actual: actual
+    });
+
+    if (!validOptions || !actual) {
+      return;
+    }
+
+    root.walkRules(function (rule) {
+      var selector = null;
+
+      if (!(0, _isStandardSyntaxRule["default"])(rule)) {
+        return;
+      }
+
+      selector = rule.selector;
+
+      if (!selector) {
+        return;
+      }
+
+      var isRejected = rule.nodes.some(function (o) {
+        return o.type === 'decl' && o.prop.toLowerCase() === 'font-size' && (checkInPx(o.value) || checkInPt(o.value));
+      });
+
+      if (isRejected) {
+        _stylelint.utils.report({
+          index: rule.lastEach,
+          message: messages.expected(selector),
+          node: rule,
+          ruleName: ruleName,
+          result: result
+        });
+      }
+    });
+  };
+}

package/dist/rules/index.js

@@ -0,0 +1,48 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+
+var _contentPropertyNoStaticValue = _interopRequireDefault(require("./content-property-no-static-value"));
+
+var _fontSizeIsReadable = _interopRequireDefault(require("./font-size-is-readable"));
+
+var _lineHeightIsVerticalRhythmed = _interopRequireDefault(require("./line-height-is-vertical-rhythmed"));
+
+var _mediaPrefersReducedMotion = _interopRequireDefault(require("./media-prefers-reduced-motion"));
+
+var _noDisplayNone = _interopRequireDefault(require("./no-display-none"));
+
+var _noObsoleteAttribute = _interopRequireDefault(require("./no-obsolete-attribute"));
+
+var _noObsoleteElement = _interopRequireDefault(require("./no-obsolete-element"));
+
+var _noOutlineNone = _interopRequireDefault(require("./no-outline-none"));
+
+var _noSpreadText = _interopRequireDefault(require("./no-spread-text"));
+
+var _noTextAlignJustify = _interopRequireDefault(require("./no-text-align-justify"));
+
+var _selectorPseudoClassFocus = _interopRequireDefault(require("./selector-pseudo-class-focus"));
+
+var _mediaPrefersColorScheme = _interopRequireDefault(require("./media-prefers-color-scheme"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+
+var _default = {
+  'content-property-no-static-value': _contentPropertyNoStaticValue["default"],
+  'font-size-is-readable': _fontSizeIsReadable["default"],
+  'line-height-is-vertical-rhythmed': _lineHeightIsVerticalRhythmed["default"],
+  'media-prefers-reduced-motion': _mediaPrefersReducedMotion["default"],
+  'no-display-none': _noDisplayNone["default"],
+  'no-obsolete-attribute': _noObsoleteAttribute["default"],
+  'no-obsolete-element': _noObsoleteElement["default"],
+  'no-outline-none': _noOutlineNone["default"],
+  'no-spread-text': _noSpreadText["default"],
+  'no-text-align-justify': _noTextAlignJustify["default"],
+  'selector-pseudo-class-focus': _selectorPseudoClassFocus["default"],
+  'media-prefers-color-scheme': _mediaPrefersColorScheme["default"]
+};
+exports["default"] = _default;

package/dist/rules/line-height-is-vertical-rhythmed/__tests__/index.js

@@ -0,0 +1,59 @@
+"use strict";
+
+var _index = require("../index");
+
+testRule({
+  ruleName: _index.ruleName,
+  config: [true],
+  accept: [{
+    code: 'a { }'
+  }, {
+    code: '.smallText { line-height: 24px; }'
+  }, {
+    code: '.largeText { line-height: 48px; }'
+  }, {
+    code: '.relText { line-height: 1.5; }'
+  }, {
+    code: '.smallTextU { LINE-HEIGHT: 24PX; }'
+  }, {
+    code: 'body { font-size: 15px; line-height: 48px; }'
+  }, {
+    code: 'a { font-size: 15px; line-height: 1.6; }'
+  }],
+  reject: [{
+    code: '.foo { line-height: 12px; }',
+    message: _index.messages.expected('.foo'),
+    line: 1,
+    column: 3
+  }, {
+    code: '.foo { line-height: 50px; }',
+    message: _index.messages.expected('.foo'),
+    line: 1,
+    column: 3
+  }, {
+    code: '.foo { line-height: 1.2; }',
+    message: _index.messages.expected('.foo'),
+    line: 1,
+    column: 3
+  }, {
+    code: '.foo { line-height: 12px; }',
+    message: _index.messages.expected('.foo'),
+    line: 1,
+    column: 3
+  }, {
+    code: '.foo { LINE-HEIGHT: 23PX; }',
+    message: _index.messages.expected('.foo'),
+    line: 1,
+    column: 3
+  }, {
+    code: 'p { font-size: 23px; line-height: 23px; }',
+    message: _index.messages.expected('p'),
+    line: 1,
+    column: 3
+  }, {
+    code: 'a { font-size: 23px; line-height: 1; }',
+    message: _index.messages.expected('a'),
+    line: 1,
+    column: 3
+  }]
+});

package/dist/rules/line-height-is-vertical-rhythmed/index.js

@@ -0,0 +1,84 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = _default;
+exports.ruleName = exports.messages = void 0;
+
+var _stylelint = require("stylelint");
+
+var _isStandardSyntaxRule = _interopRequireDefault(require("stylelint/lib/utils/isStandardSyntaxRule"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+
+var ruleName = 'a11y/line-height-is-vertical-rhythmed';
+exports.ruleName = ruleName;
+
+var messages = _stylelint.utils.ruleMessages(ruleName, {
+  expected: function expected(selector) {
+    return "Expected a vertical rhythmed line-height in ".concat(selector);
+  }
+});
+
+exports.messages = messages;
+
+function check(node) {
+  if (node.type !== 'rule') {
+    return true;
+  }
+
+  var checkInPx = function checkInPx(o) {
+    return o.value.toLowerCase().endsWith('px') && parseInt(o.value) % 24 !== 0;
+  };
+
+  var checkInRel = function checkInRel(o) {
+    return !isNaN(o.value) && parseFloat(o.value) < 1.5;
+  };
+
+  return !node.nodes.some(function (o) {
+    return o.type === 'decl' && o.prop.toLowerCase() === 'line-height' && (checkInPx(o) || checkInRel(o));
+  });
+}
+
+function _default(actual) {
+  return function (root, result) {
+    var validOptions = _stylelint.utils.validateOptions(result, ruleName, {
+      actual: actual
+    });
+
+    if (!validOptions || !actual) {
+      return;
+    }
+
+    root.walk(function (node) {
+      var selector = null;
+
+      if (node.type === 'rule') {
+        if (!(0, _isStandardSyntaxRule["default"])(node)) {
+          return;
+        }
+
+        selector = node.selector;
+      } else if (node.type === 'atrule' && node.name.toLowerCase() === 'page' && node.params) {
+        selector = node.params;
+      }
+
+      if (!selector) {
+        return;
+      }
+
+      var isAccepted = check(node);
+
+      if (!isAccepted) {
+        _stylelint.utils.report({
+          index: node.lastEach,
+          message: messages.expected(selector),
+          node: node,
+          ruleName: ruleName,
+          result: result
+        });
+      }
+    });
+  };
+}

package/dist/rules/media-prefers-color-scheme/__tests__/index.js

@@ -0,0 +1,47 @@
+"use strict";
+
+var _index = require("../index");
+
+testRule({
+  ruleName: _index.ruleName,
+  config: [true],
+  accept: [{
+    code: 'a { }'
+  }, {
+    code: '.foo { color: red } @media screen and (prefers-color-scheme: dark) { .foo { color: blue } }'
+  }, {
+    code: '.bar { background-color: red } @media screen and (prefers-color-scheme: dark) { .bar { background-color: blue } }'
+  }],
+  reject: [{
+    code: 'a { color: red; }',
+    message: _index.messages.expected('a'),
+    line: 1,
+    column: 3
+  }, {
+    code: 'a { color: red; } @media screen and (prefers-color-scheme: dark) { a { background-color: red; } }',
+    message: _index.messages.expected('a'),
+    line: 1,
+    column: 3
+  }, {
+    code: '.foo { background-color: red;}',
+    message: _index.messages.expected('.foo'),
+    line: 1,
+    column: 3
+  }, {
+    code: '.bar { color: red; } .baz { background-color: red; } @media screen and (prefers-color-scheme: dark) { .baz { color: blue; } }',
+    warnings: [{
+      message: _index.messages.expected('.bar'),
+      line: 1,
+      column: 3
+    }, {
+      message: _index.messages.expected('.baz'),
+      line: 1,
+      column: 24
+    }]
+  }, {
+    code: '.foo { background-color: red; } @media screen and (prefers-color-scheme) { .foo { color: red; } }',
+    message: _index.messages.expected('.foo'),
+    line: 1,
+    column: 3
+  }]
+});