@syncify/stylelint-config

@syncify/stylelint-config

This package includes the shareable Stylelint configuration that can optionally be used within Syncify projects. The config is ideal for developers leveraging SASS and comes with bare essentials pre-defined and ready for usage.

Install

pnpm

pnpm add stylelint @syncify/stylelint-config -D

Stylelint is an peerDependency so you will need to install it within your project.

Usage

We extend configuration from within package.json files.

{
  "stylelint": {
    "extends": "@syncify/stylelint-config",
    "ignoreFiles": ["**/node_modules"]
  }
}

Text Editor (VSCode)

Install the stylelint.vscode-stylelint extension from the marketplace. Depending on how your editor is configured, one may require setting global configuration in a user settings.json file:

{
  "stylelint.validate": ["scss", "sass", "postcss"],
  "stylelint.packageManager": "pnpm",
  "stylelint.enable": true,
  "scss.validate": false, // important to disable vscode validation
  "scss.scannerExclude": ["**/.git", "**/node_modules"],
  "editor.codeActionsOnSave": {
    "source.fixAll.stylelint": true
  }
}

License

MIT