@bitfactory/stylelint-config/README.md

Stylelint sharable config for Bitfactory NL (part of NOBEARS) projects

# @bitfactory/stylelint-config

[![Release](https://img.shields.io/badge/Release-7.x.x-F0ec73)](https://github.com/bitfactory-nl/shared-npm-stylelint-config-bitfactory)
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)
[![Stylelint](https://img.shields.io/badge/Stylelint-^16.25.0-4B3263?logo=stylelint&logoColor=white)](https://stylelint.io/)
[![NodeJS](https://img.shields.io/badge/Node.js-^20.9|^22.11|^24.11-6da55f?logo=node.js)](https://nodejs.org/)
[![Node.js Package](https://github.com/bitfactory-nl/shared-npm-stylelint-config-bitfactory/actions/workflows/npm-publish.yml/badge.svg)](https://github.com/bitfactory-nl/shared-npm-stylelint-config-bitfactory/actions/workflows/npm-publish.yml)
[![NPM package version](https://badgen.net/npm/v/@bitfactory/stylelint-config)](https://npmjs.com/package/@bitfactory/stylelint-config)

Shareable Stylelint config for Stylelint v16+. All rules and configurations are pre-configured. Rules can be overridden as needed.

> [!IMPORTANT]
> **v6.3.0+ supports both ES modules (ESM) and CommonJS.**
>
> Use `.mjs` config files for ESM or traditional `.js`/`.cjs` files for CommonJS.

- [@bitfactory/stylelint-config](#bitfactorystylelint-config)
  - [Quick Start](#quick-start)
  - [Contributing](#contributing)
  - [Installation](#installation)
  - [Configuration](#configuration)
  - [CLI Usage](#cli-usage)
  - [Editor Integration](#editor-integration)

## Quick Start

For a quick start guide with basic installation and configuration, see [QUICKSTART.md](QUICKSTART.md).

## Contributing

For information about contributing to this project, including publishing guidelines, local development setup, and debugging tips, see [CONTRIBUTING.md](CONTRIBUTING.md).

## Installation

For detailed installation instructions including peer dependencies and syntax-specific setup (PostCSS, SCSS, SASS, Tailwind, Vue), see [Installation Guide](docs/01-installation.md).

## Configuration

For configuration examples (PostCSS, SCSS, SASS, Tailwind, Vue) and advanced configuration options (custom plugins, rule overrides, disabling rules), see [Configuration Guide](docs/02-configuration.md).

## CLI Usage

For CLI usage instructions and command examples, see [CLI Usage Guide](docs/03-cli-usage.md).

## Editor Integration

For editor integration instructions (Visual Studio Code, PhpStorm), see [Editor Integration Guide](docs/04-editor-integration.md).