stylelint-plugin-rhythmguard 2.0.1 → 2.1.0

package/CHANGELOG.md

@@ -6,6 +6,27 @@ The format follows Keep a Changelog principles and semantic versioning.
 
 ## [Unreleased]
 
+## [2.1.0] - 2026-09-05
+
+### Added
+
+- Added `rhythmguard audit --format github`, emitting GitHub Actions workflow-command annotations (one `::warning` per finding, a `::notice` summary) for inline PR feedback without a formatter dependency.
+- Added per-rule documentation pages under `docs/rules/` for every Stylelint and ESLint rule. Rule `meta.url` and ESLint `meta.docs.url` now point at them, and a test enforces the link.
+- Added `npm run typecheck`: compiles the published TypeScript declarations, a consumer check file, and the packaged examples.
+- Added Stylelint 17 to the CI and release matrices (Node 20 and 22; Node 18 is excluded for Stylelint 17).
+- Added a bug-report issue template.
+
+### Changed
+
+- README cut from 833 lines to a quick start. Config details, scale presets, the audit reference and the full custom setup moved to `docs/CONFIGS.md`, `docs/SCALE_PRESETS.md` and `docs/AUDIT.md`; development and release notes moved to `CONTRIBUTING.md`.
+- Split the audit CLI into focused modules under `src/audit/`; `src/cli/audit.js` is now a thin command shell. No behaviour change.
+- Release, post-publish smoke and community-scale workflows now run on the self-hosted runners like CI.
+
+### Fixed
+
+- `plugin.configs` and the ESM entry now expose `react-tailwind`, matching the `./configs/react-tailwind` package export. A test asserts parity between package exports and the programmatic configs object.
+- `AuditOptions` declaration: `config` and `output` were never read by the audit API and are replaced by the real keys `configPath` and `outputPath`; `noConfig` and `tokenSourceFormat` added.
+
 ## [2.0.1] - 2026-06-17
 
 ### Added

package/CONTRIBUTING.md

@@ -37,6 +37,21 @@ npm run scales:validate
 
 Scale files must pass schema and collision checks. See [`docs/COMMUNITY_SCALES.md`](./docs/COMMUNITY_SCALES.md) for the full spec and policy.
 
+## Compatibility Targets
+
+- Stylelint `^16.0.0 || ^17.0.0`. Stylelint `16.0.0` has known autofix and API differences; CI runs the floor-compat suite against it and the full suite non-blocking.
+- Node `>=18.18.0` for Stylelint 16, `>=20.19.0` for Stylelint 17. The CI matrix excludes Node 18 with Stylelint 17.
+- Dual CommonJS and ESM entry points; every export has a declaration under `types/`. `npm run typecheck` compiles the declarations, a consumer check file, and the examples.
+
+## Performance Benchmarking
+
+```bash
+npm run bench:perf
+npm run bench:perf:fix
+```
+
+Compares runtime against `stylelint-scales` on a deterministic corpus. Method and arguments: [`docs/BENCHMARKING.md`](./docs/BENCHMARKING.md).
+
 ## Semver Rules
 
 - Patch (`x.y.Z`): bug fixes, docs updates, non-breaking internal changes.
@@ -55,11 +70,14 @@ When changing rule logic:
 
 1. add/adjust tests for the behavior
 2. validate deterministic fix behavior
-3. update README option or behavior docs if needed
+3. update the rule's page in `docs/rules/` if options or behavior changed
 4. update CHANGELOG
 
-## Release Notes
+## Release Workflow
+
+1. Run the local gate: `npm run lint && npm run typecheck && npm test && npm run test:pack-smoke`.
+2. Update `CHANGELOG.md` and bump `package.json`.
+3. Create a GitHub release. `release.yml` runs the Node and Stylelint matrix on the self-hosted runners, then publishes to npm with provenance when `NPM_TOKEN` is configured, or skips publish with a notice when it is not.
+4. `post-publish-smoke.yml` installs the published version in a clean project.
 
-- Keep `stylelint-plugin-rhythmguard/configs/recommended` and `stylelint-plugin-rhythmguard/configs/strict` stable.
-- Verify CI matrix is green before publishing.
-- Publish with provenance through the release workflow.
+Keep `configs/recommended` and `configs/strict` stable across minors. Rule docs live in `docs/rules/`; a test checks that every rule's `meta.url` points at its page.