stylelint-plugin-rhythmguard 2.1.0 → 2.2.0

package/types/__checks__/consumer.ts

@@ -14,6 +14,7 @@ import { createAuditReport, toAuditContractReport } from 'stylelint-plugin-rhyth
 import eslintPlugin from 'stylelint-plugin-rhythmguard/eslint';
 import { getScalePreset, listScalePresetNames } from 'stylelint-plugin-rhythmguard/presets';
 import recommended from 'stylelint-plugin-rhythmguard/configs/recommended';
+import embed from 'stylelint-plugin-rhythmguard/configs/embed';
 import reactTailwind from 'stylelint-plugin-rhythmguard/configs/react-tailwind';
 import useScale, { ruleName as useScaleName } from 'stylelint-plugin-rhythmguard/rules/use-scale';
 
@@ -27,6 +28,8 @@ const pluginConfigs: readonly RhythmguardStylelintConfig[] = [
   plugin.configs.motion,
   plugin.configs['react-tailwind'],
   configs.recommended,
+  plugin.configs.embed,
+  embed,
   recommended,
   reactTailwind,
 ];
@@ -38,6 +41,12 @@ const ruleOptions: RhythmguardRuleOptions = {
   tokenMapFromCssCustomProperties: true,
 };
 
+const autoScaleOptions: RhythmguardRuleOptions = {
+  scale: 'auto',
+  scaleSources: ['./tokens.json', { path: './theme.css', format: 'css' }],
+  tailwindConfigPath: './tailwind.config.mjs',
+};
+
 const useScaleRule = rules['rhythmguard/use-scale'];
 const fixable: boolean | undefined = useScaleRule.meta.fixable;
 const docUrl: string | undefined = useScale.meta.url;
@@ -59,6 +68,7 @@ async function runAudit(): Promise<AuditContractReport> {
 
 void pluginConfigs;
 void ruleOptions;
+void autoScaleOptions;
 void fixable;
 void docUrl;
 void name;

package/types/audit.d.ts

@@ -37,7 +37,8 @@ export interface AuditOptions {
   noConfig?: boolean;
   /** Write rendered output to this file instead of stdout (equivalent to `--output`). */
   outputPath?: string;
-  scale?: Array<number | string>;
+  /** Explicit scale values, or `"auto"` to infer from token sources, then scanned CSS, then the default. */
+  scale?: Array<number | string> | "auto";
   since?: string;
   sinceBaseline?: boolean;
   staged?: boolean;
@@ -87,8 +88,19 @@ export interface AuditBaselineComparison {
   [key: string]: unknown;
 }
 
+export type AuditScaleSource = "default" | "explicit" | "fallback" | "scanned-css" | "token-sources";
+
+export interface AuditScale {
+  /** Files the scale was derived from (token sources or scanned stylesheets). Empty for explicit, default and fallback. */
+  files: string[];
+  source: AuditScaleSource;
+  tokenCount: number;
+  values: Array<number | string>;
+}
+
 export interface AuditReport {
   baseline?: AuditBaselineComparison | null;
+  scale?: AuditScale | null;
   config?: string | null;
   directory: string;
   findings: {
@@ -112,8 +124,11 @@ export interface AuditContractReport {
     motion?: unknown;
     scale: {
       cleanliness?: unknown;
+      files: string[];
       offScaleValues?: unknown;
+      source: AuditScaleSource;
       tokenOpportunities?: unknown;
+      values: Array<number | string> | null;
     };
     tokens?: unknown;
   };

package/types/index.d.ts

@@ -14,6 +14,7 @@ export type {
   RhythmguardRuleOptions,
   RhythmguardStylelintConfig,
   ScalePresetMetadata,
+  ScaleSource,
   ScaleValue,
 } from "./shared";
 export type {
@@ -22,6 +23,8 @@ export type {
   AuditFinding,
   AuditOptions,
   AuditReport,
+  AuditScale,
+  AuditScaleSource,
   AuditScanned,
   AuditSummary,
   AuditTokenKind,
@@ -35,6 +38,7 @@ export type { StylelintRuleModule } from "./rule";
 export interface RhythmguardPlugin extends Array<StylelintRuleModule> {
   audit: typeof auditApi;
   configs: {
+    embed: RhythmguardStylelintConfig;
     expanded: RhythmguardStylelintConfig;
     logical: RhythmguardStylelintConfig;
     migration: RhythmguardStylelintConfig;

package/types/shared.d.ts

@@ -2,13 +2,34 @@ export type ScaleValue = number | string;
 
 export type RuleSeverity = boolean | "always" | "never";
 
+export interface ScaleSource {
+  /** Directory that a relative `path` resolves from. Defaults to the working directory. */
+  baseDir?: string;
+  /** Alias for `path`. */
+  file?: string;
+  /** `auto` (default), `css`, `flat-json`, `style-dictionary`, or `dtcg`. */
+  format?: string;
+  path?: string;
+}
+
 export interface RhythmguardRuleOptions {
+  /** Exempt non-zero lengths of one CSS pixel or less (1px, -1px, 0.5px, 0.0625rem). Default true. */
+  allowHairlines?: boolean;
   baseFontSize?: number;
   customScale?: ScaleValue[];
   includeMathFunctions?: boolean;
   preset?: string;
   properties?: Array<string | RegExp>;
-  scale?: ScaleValue[];
+  /**
+   * Allowed values, or `"auto"` to infer the scale from spacing tokens: `scaleSources`,
+   * then `.rhythmguardrc.json` audit token sources, then the linted stylesheet's custom
+   * properties, then `tailwindConfigPath`, falling back to the `rhythmic-4` preset.
+   */
+  scale?: ScaleValue[] | "auto";
+  /** Token files consulted first when `scale` is `"auto"`. */
+  scaleSources?: Array<string | ScaleSource>;
+  /** Tailwind v3 config whose `theme.spacing` feeds `scale: "auto"` and `tokenMapFromTailwindSpacing`. */
+  tailwindConfigPath?: string;
   tokenMap?: Record<string, string>;
   tokenMapFile?: string;
   tokenMapFromCssCustomProperties?: boolean;