@readme/stylelint-config 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 ReadMe
+
+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,60 @@
+# @readme/stylelint-config
+
+ReadMe coding standards for all things style-related, specifically CSS and SCSS.
+
+[![](https://d3vv6lp55qjaqc.cloudfront.net/items/1M3C3j0I0s0j3T362344/Untitled-2.png)](https://readme.io)
+
+[![npm](https://img.shields.io/npm/v/@readme/stylelint-config)](https://npm.im/@readme/stylelint-config) [![Build](https://github.com/readmeio/stylelint-config/workflows/CI/badge.svg)](https://github.com/readmeio/stylelint-config)
+
+## Installation
+
+```sh
+# Install the config as a dev dependency.
+npm install --save-dev @readme/eslint-config
+```
+
+### Peer dependencies
+
+You need to additionally install [Stylelint](https://www.npmjs.com/package/stylelint) and [PostCSS](https://www.npmjs.com/package/postcss) into your project. These are peer dependencies of `@readme/stylelint-config`, which can conveniently be installed either manually or using [`install-peerdeps`](https://www.npmjs.com/package/install-peerdeps).
+
+```sh
+# Install with "install-peerdeps"
+npx install-peerdeps --dev @readme/stylelint-config
+```
+
+```sh
+# Install manually
+npm install --save-dev stylelint postcss
+```
+
+## Usage
+
+Create a `stylelint.config.js` file with the following contents:
+
+```js
+module.exports = {
+  extends: "@readme/stylelint-config",
+};
+```
+
+## Testing
+
+```sh
+# Run unit tests
+npm run test
+```
+
+```sh
+# Run unit tests in watch mode
+npm run test -- --watch
+```
+
+## Extended configs
+
+We've adopted the following list of shared configs that remain actively maintained by the broader developer community.
+
+- [stylelint-config-standard](https://github.com/stylelint/stylelint-config-standard) - The standard shareable config for Stylelint.
+- [stylelint-config-standard-scss](https://github.com/stylelint-scss/stylelint-config-standard-scss) - The standard shareable SCSS config for Stylelint.
+- [stylelint-config-sass-guidelines](https://github.com/bjankord/stylelint-config-sass-guidelines) - A stylelint config inspired by [sass-guidelin.es](https://sass-guidelin.es/).
+- [stylelint-config-css-modules](https://github.com/pascalduez/stylelint-config-css-modules) - CSS modules shareable config for stylelint. Tweaks stylelint rules to accept [css modules](https://github.com/css-modules/css-modules) specific syntax.
+- [stylelint-prettier/recommended](https://github.com/prettier/stylelint-prettier) - Runs Prettier as a Stylelint rule and reports differences as individual Stylelint issues.

package/index.js

@@ -0,0 +1,51 @@
+module.exports = {
+  extends: [
+    // Standard rules to enforce common conventions
+    'stylelint-config-standard',
+
+    // Standard rules for SCSS
+    'stylelint-config-standard-scss',
+
+    // Stylelint config inspired by https://sass-guidelin.es
+    'stylelint-config-sass-guidelines',
+
+    // Support CSS modules syntax
+    'stylelint-config-css-modules',
+
+    // Enable prettier formatting for SCSS/CSS
+    'stylelint-config-prettier',
+    'stylelint-prettier/recommended',
+  ],
+  rules: {
+    // ReadMe still uses color names as values in many places.
+    'color-named': null,
+
+    // ReadMe breaks this rule in many places.
+    'max-nesting-depth': null,
+
+    // ReadMe relies on "element[attr='value']" selectors in too many places.
+    // Eventually, it may be beneficial to turn this on.
+    'selector-no-qualifying-type': null,
+
+    // ReadMe relies on legacy color functions (e.g. rgba(0, 0, 0, 0.5))
+    // everywhere in addition to Scss allowing this to be written with a color
+    // name (e.g. rgba(black, 0.5)). Eventually, consider removing this rule to
+    // use "modern" style with comma-free syntax (e.g. rgb(0 0 0 / 0.5)). This
+    // change however won't be trivial.
+    'color-function-notation': 'legacy',
+
+    // Custom regex of ReadMe's current BEM selector class pattern.
+    'selector-class-pattern': [
+      '^[a-zA-Z0-9]+((_|-)([a-zA-Z0-9]+))*$',
+      {
+        message:
+          'Selector should start in CapitalCase or camelCase and optionally followed by either kebab-lowercase with hyphens or snake_lowercase with underscores (e.g. BlockName-element-name_modifier-name)',
+      },
+    ],
+
+    // TODO: Remove this when migrating to Dart Sass.
+    // Disallows the use of global function names, as these global functions are
+    // now located inside built-in Dart Sass modules.
+    'scss/no-global-function-names': null,
+  },
+};

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@readme/stylelint-config",
+  "version": "1.1.0",
+  "description": "ReadMe coding standards for styles",
+  "main": "index.js",
+  "files": [
+    "index.js"
+  ],
+  "scripts": {
+    "lint": "eslint .",
+    "test": "jest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/readmeio/standards.git"
+  },
+  "author": "Engineers <engineers@readme.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/readmeio/standards/issues"
+  },
+  "homepage": "https://github.com/readmeio/standards",
+  "dependencies": {
+    "stylelint-config-css-modules": "^4.1.0",
+    "stylelint-config-prettier": "^9.0.3",
+    "stylelint-config-sass-guidelines": "^9.0.1",
+    "stylelint-config-standard": "^25.0.0",
+    "stylelint-config-standard-scss": "^3.0.0",
+    "stylelint-prettier": "^2.0.0"
+  },
+  "peerDependencies": {
+    "postcss": "^8.4.12",
+    "stylelint": "^14.6.1"
+  },
+  "devDependencies": {
+    "@readme/eslint-config": "file:../eslint-config",
+    "jest": "^27.5.1"
+  }
+}