@ivuorinen/stylelint-config 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Ismo Vuorinen
+
+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,107 @@
+# @ivuorinen/stylelint-config <!-- omit in toc -->
+
+[![npm package][npm-badge]][npm-link]
+[![license MIT][license-badge]][license-link]
+[![ivuorinen's Code Style][style-badge]][style-link]
+
+> ivuorinen's shareable configuration for [`stylelint`][stylelint-link].
+
+## Table of Contents <!-- omit in toc -->
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [CSS <sub><sup>(Default)</sup></sub>](#css-subsupdefaultsupsub)
+  - [SCSS](#scss)
+- [Extending the config](#extending-the-config)
+- [Documentations](#documentations)
+- [Contributing](#contributing)
+- [Changelog](#changelog)
+- [License](#license)
+
+## Installation
+
+Install `this config` as a _`devDependencies`_:
+
+```sh
+# npm
+npm install @ivuorinen/stylelint-config --save-dev
+
+# Yarn
+yarn add @ivuorinen/stylelint-config --dev
+```
+
+After installing it, a _`.stylelintrc.json`_ file will be created automatically in the project's root folder with the following configuration:
+
+```json
+{
+  "extends": ["@ivuorinen/stylelint-config/css"]
+}
+```
+
+## Usage
+
+This package provides configuration for CSS and SCSS, you can choose which one you want to extend:
+
+### CSS <sub><sup>(Default)</sup></sub>
+
+```json
+{
+  "extends": ["@ivuorinen/stylelint-config/css"]
+}
+```
+
+### SCSS
+
+```json
+{
+  "extends": ["@ivuorinen/stylelint-config/scss"]
+}
+```
+
+## Extending the config
+
+The defined rules can be modified by adding other configurations, plugins or custom rules:
+
+```json
+{
+  "extends": ["@ivuorinen/stylelint-config/css", "some-other-config-you-use"],
+  "rules": {
+    "at-rule-no-unknown": [
+      true,
+      {
+        "ignoreAtRules": ["extends", "ignores"]
+      }
+    ]
+  }
+}
+
+```
+
+## Documentations
+
+Read the [stylelint docs][stylelint-docs-link] for more information.
+
+## Contributing
+
+If you are interested in helping contribute, please take a look at our [contribution guidelines][contributing-link] and open an [issue][issue-link] or [pull request][pull-request-link].
+
+## Changelog
+
+See [CHANGELOG][changelog-link] for a human-readable history of changes.
+
+## License
+
+Distributed under the MIT License. See [LICENSE][license-link] for more information.
+
+[changelog-link]: ./CHANGELOG.md
+[stylelint-docs-link]: https://stylelint.io
+[stylelint-link]: https://github.com/stylelint/stylelint
+[contributing-link]: https://github.com/ivuorinen/.github/blob/main/CONTRIBUTING.md
+[issue-link]: https://github.com/ivuorinen/base-configs/issues
+[license-badge]: https://img.shields.io/github/license/ivuorinen/base-configs?style=flat-square&labelColor=292a44&color=663399
+[license-link]: ./LICENSE
+[npm-badge]: https://img.shields.io/npm/v/@ivuorinen/stylelint-config?style=flat-square&labelColor=292a44&color=663399
+[npm-link]: https://www.npmjs.com/package/@ivuorinen/stylelint-config
+[pull-request-link]: https://github.com/ivuorinen/base-configs/pulls
+[style-badge]: https://img.shields.io/badge/code_style-ivuorinen%E2%80%99s-663399.svg?labelColor=292a44&style=flat-square
+[style-link]: https://github.com/ivuorinen/base-configs

package/css/index.js

@@ -0,0 +1,279 @@
+/* eslint-disable sonarjs/no-duplicate-string */
+/* eslint-disable unicorn/no-null */
+'use strict'
+
+module.exports = {
+  extends: ['stylelint-config-standard'],
+  plugins: ['stylelint-order'],
+  rules: {
+    'at-rule-empty-line-before': [
+      'always',
+      {
+        except: ['blockless-after-same-name-blockless', 'first-nested']
+      }
+    ],
+    'at-rule-name-space-after': 'always',
+    'at-rule-no-vendor-prefix': true,
+    'at-rule-semicolon-space-before': 'never',
+    'block-closing-brace-empty-line-before': null,
+    'block-closing-brace-newline-after': null,
+    'block-opening-brace-space-before': null,
+    'color-named': 'never',
+    'declaration-block-semicolon-newline-before': 'never-multi-line',
+    'declaration-empty-line-before': 'never',
+    'font-family-name-quotes': 'always-where-recommended',
+    'font-weight-notation': [
+      'numeric',
+      {
+        ignore: ['relative']
+      }
+    ],
+    'function-url-no-scheme-relative': true,
+    'function-url-quotes': 'always',
+    'max-empty-lines': 2,
+    'max-line-length': null,
+    'media-feature-name-no-vendor-prefix': true,
+    'no-descending-specificity': null,
+    'number-leading-zero': 'never',
+    'order/properties-order': [
+      'position',
+      'top',
+      'right',
+      'bottom',
+      'left',
+      'z-index',
+      'box-sizing',
+      'display',
+      'flex',
+      'flex-align',
+      'flex-basis',
+      'flex-direction',
+      'flex-wrap',
+      'flex-flow',
+      'flex-shrink',
+      'flex-grow',
+      'flex-order',
+      'flex-pack',
+      'align-content',
+      'align-items',
+      'align-self',
+      'justify-content',
+      'order',
+      'float',
+      'width',
+      'min-width',
+      'max-width',
+      'height',
+      'min-height',
+      'max-height',
+      'padding',
+      'padding-top',
+      'padding-right',
+      'padding-bottom',
+      'padding-left',
+      'margin',
+      'margin-top',
+      'margin-right',
+      'margin-bottom',
+      'margin-left',
+      'overflow',
+      'overflow-x',
+      'overflow-y',
+      '-webkit-overflow-scrolling',
+      '-ms-overflow-x',
+      '-ms-overflow-y',
+      '-ms-overflow-style',
+      'columns',
+      'column-count',
+      'column-fill',
+      'column-gap',
+      'column-rule',
+      'column-rule-width',
+      'column-rule-style',
+      'column-rule-color',
+      'column-span',
+      'column-width',
+      'orphans',
+      'widows',
+      'clip',
+      'clear',
+      'font',
+      'font-family',
+      'font-size',
+      'font-style',
+      'font-weight',
+      'font-variant',
+      'font-size-adjust',
+      'font-stretch',
+      'font-effect',
+      'font-emphasize',
+      'font-emphasize-position',
+      'font-emphasize-style',
+      'font-smooth',
+      'src',
+      'hyphens',
+      'line-height',
+      'color',
+      'text-align',
+      'text-align-last',
+      'text-emphasis',
+      'text-emphasis-color',
+      'text-emphasis-style',
+      'text-emphasis-position',
+      'text-decoration',
+      'text-indent',
+      'text-justify',
+      'text-outline',
+      '-ms-text-overflow',
+      'text-overflow',
+      'text-overflow-ellipsis',
+      'text-overflow-mode',
+      'text-shadow',
+      'text-transform',
+      'text-wrap',
+      '-webkit-text-size-adjust',
+      '-ms-text-size-adjust',
+      'letter-spacing',
+      '-ms-word-break',
+      'word-break',
+      'word-spacing',
+      '-ms-word-wrap',
+      'word-wrap',
+      'overflow-wrap',
+      'tab-size',
+      'white-space',
+      'vertical-align',
+      'direction',
+      'unicode-bidi',
+      'list-style',
+      'list-style-position',
+      'list-style-type',
+      'list-style-image',
+      'pointer-events',
+      '-ms-touch-action',
+      'touch-action',
+      'cursor',
+      'visibility',
+      'zoom',
+      'table-layout',
+      'empty-cells',
+      'caption-side',
+      'border-spacing',
+      'border-collapse',
+      'content',
+      'quotes',
+      'counter-reset',
+      'counter-increment',
+      'resize',
+      'user-select',
+      'nav-index',
+      'nav-up',
+      'nav-right',
+      'nav-down',
+      'nav-left',
+      'background',
+      'background-color',
+      'background-image',
+      'filter',
+      'background-repeat',
+      'background-attachment',
+      'background-position',
+      'background-position-x',
+      'background-position-y',
+      'background-clip',
+      'background-origin',
+      'background-size',
+      'border',
+      'border-color',
+      'border-style',
+      'border-width',
+      'border-top',
+      'border-top-color',
+      'border-top-style',
+      'border-top-width',
+      'border-right',
+      'border-right-color',
+      'border-right-style',
+      'border-right-width',
+      'border-bottom',
+      'border-bottom-color',
+      'border-bottom-style',
+      'border-bottom-width',
+      'border-left',
+      'border-left-color',
+      'border-left-style',
+      'border-left-width',
+      'border-radius',
+      'border-top-left-radius',
+      'border-top-right-radius',
+      'border-bottom-right-radius',
+      'border-bottom-left-radius',
+      'border-image',
+      'border-image-source',
+      'border-image-slice',
+      'border-image-width',
+      'border-image-outset',
+      'border-image-repeat',
+      'outline',
+      'outline-width',
+      'outline-style',
+      'outline-color',
+      'outline-offset',
+      'box-shadow',
+      'opacity',
+      '-ms-interpolation-mode',
+      'page-break-after',
+      'page-break-before',
+      'page-break-inside',
+      'transition',
+      'transition-delay',
+      'transition-timing-function',
+      'transition-duration',
+      'transition-property',
+      'transform',
+      'transform-origin',
+      'perspective',
+      'appearance',
+      'animation',
+      'animation-name',
+      'animation-duration',
+      'animation-play-state',
+      'animation-timing-function',
+      'animation-delay',
+      'animation-iteration-count',
+      'animation-direction',
+      'animation-fill-mode',
+      'fill',
+      'stroke'
+    ],
+    'property-no-vendor-prefix': true,
+    'rule-empty-line-before': [
+      'always',
+      {
+        except: ['after-single-line-comment', 'first-nested']
+      }
+    ],
+    'selector-attribute-quotes': 'always',
+    'selector-class-pattern': '^[a-z][a-z0-9\\-]*[a-z0-9]$',
+    'selector-list-comma-newline-before': 'never-multi-line',
+    'selector-list-comma-space-after': 'always-single-line',
+    'selector-list-comma-space-before': 'never-single-line',
+    'selector-max-attribute': 2,
+    'selector-max-class': 4,
+    'selector-max-combinators': 4,
+    'selector-max-compound-selectors': 4,
+    'selector-max-id': 0,
+    'selector-max-specificity': null,
+    'selector-max-type': 2,
+    'selector-max-universal': 1,
+    'selector-no-qualifying-type': true,
+    'selector-no-vendor-prefix': true,
+    'shorthand-property-no-redundant-values': true,
+    'string-quotes': 'double',
+    'unicode-bom': 'never',
+    'value-list-comma-newline-after': 'never-multi-line',
+    'value-list-comma-newline-before': 'never-multi-line',
+    'value-list-comma-space-after': 'always',
+    'value-no-vendor-prefix': true
+  }
+}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@ivuorinen/stylelint-config",
+  "version": "0.1.0",
+  "description": "ivuorinen's shareable configuration for stylelint.",
+  "author": {
+    "name": "Ismo Vuorinen",
+    "url": "https://github.com/ivuorinen"
+  },
+  "bugs": {
+    "url": "https://github.com/ivuorinen/base-configs/issues"
+  },
+  "engines": {
+    "node": ">= 12",
+    "npm": ">= 6",
+    "yarn": ">=1.20.0"
+  },
+  "files": [
+    "css/index.js",
+    "scripts/*",
+    "scss/index.js"
+  ],
+  "homepage": "https://github.com/ivuorinen/base-configs/tree/main/packages/stylelint-config#readme",
+  "keywords": [
+    "stylelint-config",
+    "stylelint",
+    "config",
+    "ivuorinen"
+  ],
+  "license": "MIT",
+  "main": "css/index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ivuorinen/base-configs.git"
+  },
+  "scripts": {
+    "postinstall": "node scripts/postinstall.js"
+  },
+  "dependencies": {
+    "stylelint": "14.16.0",
+    "stylelint-config-recommended-scss": "8.0.0",
+    "stylelint-config-standard": "29.0.0",
+    "stylelint-order": "5.0.0",
+    "stylelint-scss": "4.3.0"
+  },
+  "gitHead": "0b2b89ca98caac7995c4c2a3662f0d338043938b"
+}

package/scripts/postinstall.js

@@ -0,0 +1,14 @@
+'use strict'
+
+const fs = require('fs')
+const path = require('path')
+
+const filePath = path.join(process.env.INIT_CWD, '.stylelintrc.json')
+
+const fileConfigObject = {
+  extends: ['@ivuorinen/stylelint-config/css']
+}
+
+if (!fs.existsSync(filePath)) {
+  fs.writeFileSync(filePath, JSON.stringify(fileConfigObject, undefined, 2))
+}

package/scss/index.js

@@ -0,0 +1,33 @@
+/* eslint-disable unicorn/no-null */
+'use strict'
+
+module.exports = {
+  extends: ['stylelint-config-recommended-scss', '../css'],
+  rules: {
+    'at-rule-no-unknown': null,
+    'scss/at-function-named-arguments': 'never',
+    'scss/at-function-parentheses-space-before': 'never',
+    'scss/at-function-pattern': '^[a-z][a-z-]*$',
+    'scss/at-import-no-partial-leading-underscore': true,
+    'scss/at-import-partial-extension': 'never',
+    'scss/at-mixin-argumentless-call-parentheses': 'always',
+    'scss/at-mixin-named-arguments': null,
+    'scss/at-mixin-parentheses-space-before': 'never',
+    'scss/at-rule-no-unknown': true,
+    'scss/dimension-no-non-numeric-values': true,
+    'scss/dollar-variable-colon-space-after': 'at-least-one-space',
+    'scss/dollar-variable-colon-space-before': 'never',
+    'scss/dollar-variable-no-missing-interpolation': true,
+    'scss/dollar-variable-pattern': '^[a-z][a-z-\\d]*$',
+    'scss/media-feature-value-dollar-variable': null,
+    'scss/no-duplicate-dollar-variables': [
+      null,
+      { ignoreInsideAtRules: ['if', 'mixin'] }
+    ],
+    'scss/no-duplicate-mixins': true,
+    'scss/operator-no-newline-after': true,
+    'scss/operator-no-newline-before': true,
+    'scss/operator-no-unspaced': true,
+    'scss/selector-no-redundant-nesting-selector': true
+  }
+}