stylelint-plugin-rhythmguard 2.0.1 → 2.1.0

package/src/eslint/rules/tailwind-class-use-motion-scale.js

@@ -76,6 +76,7 @@ function buildMessage(analysis, segment, lower, upper) {
 module.exports = {
   meta: {
     docs: {
+      url: 'https://github.com/PetriLahdelma/stylelint-plugin-rhythmguard/blob/main/docs/rules/tailwind-class-use-motion-scale.md',
       description: 'Enforce duration scale for Tailwind arbitrary motion utilities in class strings',
     },
     fixable: 'code',

package/src/eslint/rules/tailwind-class-use-scale.js

@@ -67,6 +67,7 @@ function maybeCheckNodeText(node, sourceCode, context, analyzer, allowFix) {
 module.exports = {
   meta: {
     docs: {
+      url: 'https://github.com/PetriLahdelma/stylelint-plugin-rhythmguard/blob/main/docs/rules/tailwind-class-use-scale.md',
       description: 'Enforce spacing scale for Tailwind arbitrary spacing utilities in class strings',
     },
     fixable: 'code',

package/src/index.js

@@ -22,6 +22,7 @@ module.exports.configs = {
   logical: require('./configs/logical'),
   migration: require('./configs/migration'),
   motion: require('./configs/motion'),
+  'react-tailwind': require('./configs/react-tailwind'),
 };
 module.exports.eslint = require('./eslint');
 module.exports.presets = require('./presets');

package/src/rules/no-offscale-transform/index.js

@@ -269,7 +269,7 @@ ruleFunction.ruleName = ruleName;
 ruleFunction.messages = messages;
 ruleFunction.meta = {
   fixable: true,
-  url: 'https://github.com/petrilahdelma/stylelint-plugin-rhythmguard#rhythmguardno-offscale-transform',
+  url: 'https://github.com/PetriLahdelma/stylelint-plugin-rhythmguard/blob/main/docs/rules/no-offscale-transform.md',
 };
 
 module.exports = stylelint.createPlugin(ruleName, ruleFunction);

package/src/rules/prefer-token/index.js

@@ -288,7 +288,7 @@ ruleFunction.ruleName = ruleName;
 ruleFunction.messages = messages;
 ruleFunction.meta = {
   fixable: true,
-  url: 'https://github.com/petrilahdelma/stylelint-plugin-rhythmguard#rhythmguardprefer-token',
+  url: 'https://github.com/PetriLahdelma/stylelint-plugin-rhythmguard/blob/main/docs/rules/prefer-token.md',
 };
 
 module.exports = stylelint.createPlugin(ruleName, ruleFunction);

package/src/rules/use-motion-scale/index.js

@@ -236,7 +236,7 @@ ruleFunction.ruleName = ruleName;
 ruleFunction.messages = messages;
 ruleFunction.meta = {
   fixable: true,
-  url: 'https://github.com/petrilahdelma/stylelint-plugin-rhythmguard#rhythmguarduse-motion-scale',
+  url: 'https://github.com/PetriLahdelma/stylelint-plugin-rhythmguard/blob/main/docs/rules/use-motion-scale.md',
 };
 
 module.exports = stylelint.createPlugin(ruleName, ruleFunction);

package/src/rules/use-scale/index.js

@@ -332,7 +332,7 @@ ruleFunction.ruleName = ruleName;
 ruleFunction.messages = messages;
 ruleFunction.meta = {
   fixable: true,
-  url: 'https://github.com/petrilahdelma/stylelint-plugin-rhythmguard#rhythmguarduse-scale',
+  url: 'https://github.com/PetriLahdelma/stylelint-plugin-rhythmguard/blob/main/docs/rules/use-scale.md',
 };
 
 module.exports = stylelint.createPlugin(ruleName, ruleFunction);

package/types/__checks__/consumer.ts

@@ -0,0 +1,70 @@
+/**
+ * Compile-time consumer of the public declarations.
+ * `npm run typecheck` fails if any published export or type drifts.
+ * Nothing here runs; it only has to type-check.
+ */
+import plugin, { audit, configs, eslint, presets, rules } from 'stylelint-plugin-rhythmguard';
+import type {
+  AuditContractReport,
+  AuditReport,
+  RhythmguardRuleOptions,
+  RhythmguardStylelintConfig,
+} from 'stylelint-plugin-rhythmguard';
+import { createAuditReport, toAuditContractReport } from 'stylelint-plugin-rhythmguard/audit';
+import eslintPlugin from 'stylelint-plugin-rhythmguard/eslint';
+import { getScalePreset, listScalePresetNames } from 'stylelint-plugin-rhythmguard/presets';
+import recommended from 'stylelint-plugin-rhythmguard/configs/recommended';
+import reactTailwind from 'stylelint-plugin-rhythmguard/configs/react-tailwind';
+import useScale, { ruleName as useScaleName } from 'stylelint-plugin-rhythmguard/rules/use-scale';
+
+const pluginConfigs: readonly RhythmguardStylelintConfig[] = [
+  plugin.configs.recommended,
+  plugin.configs.strict,
+  plugin.configs.tailwind,
+  plugin.configs.expanded,
+  plugin.configs.logical,
+  plugin.configs.migration,
+  plugin.configs.motion,
+  plugin.configs['react-tailwind'],
+  configs.recommended,
+  recommended,
+  reactTailwind,
+];
+
+const ruleOptions: RhythmguardRuleOptions = {
+  preset: 'rhythmic-4',
+  scale: [0, 4, 8, 12, 16],
+  tokenMap: { '4px': 'var(--space-1)' },
+  tokenMapFromCssCustomProperties: true,
+};
+
+const useScaleRule = rules['rhythmguard/use-scale'];
+const fixable: boolean | undefined = useScaleRule.meta.fixable;
+const docUrl: string | undefined = useScale.meta.url;
+const name: string = useScaleName;
+
+const presetNames: string[] = listScalePresetNames();
+const preset = getScalePreset('rhythmic-4');
+const presetsAgain: string[] = presets.listScalePresetNames();
+
+const eslintRule = eslint.rules['tailwind-class-use-scale'];
+const eslintRuleAgain = eslintPlugin.rules['tailwind-class-use-motion-scale'];
+
+async function runAudit(): Promise<AuditContractReport> {
+  const report: AuditReport = await createAuditReport({ dir: './src', noConfig: true });
+  const viaPlugin: AuditReport = await audit.createAuditReport({ dir: './src' });
+  void viaPlugin;
+  return toAuditContractReport(report);
+}
+
+void pluginConfigs;
+void ruleOptions;
+void fixable;
+void docUrl;
+void name;
+void presetNames;
+void preset;
+void presetsAgain;
+void eslintRule;
+void eslintRuleAgain;
+void runAudit;

package/types/audit.d.ts

@@ -23,22 +23,28 @@ export interface AuditTokenSource {
 export interface AuditOptions {
   baseFontSize?: number;
   baselinePath?: string;
-  config?: string;
+  /** Path to a `.rhythmguardrc.json`-style config. Defaults to `.rhythmguardrc.json` in `cwd`. */
+  configPath?: string;
   dir?: string;
   failOnNewDrift?: boolean;
-  format?: "json" | "json-v1" | "markdown" | "text" | "html";
+  format?: "json" | "json-v1" | "markdown" | "text" | "html" | "github";
   ignorePath?: string;
   ignorePatterns?: string[];
   includeMotion?: boolean;
   maxFindings?: number;
   minCleanliness?: number;
-  output?: string;
+  /** Skip config discovery entirely (equivalent to `--no-config`). */
+  noConfig?: boolean;
+  /** Write rendered output to this file instead of stdout (equivalent to `--output`). */
+  outputPath?: string;
   scale?: Array<number | string>;
   since?: string;
   sinceBaseline?: boolean;
   staged?: boolean;
   tokenCandidateMinCount?: number;
   tokenKind?: AuditTokenKind;
+  /** Format applied to `tokenSources` entries that do not declare their own. */
+  tokenSourceFormat?: AuditTokenSourceFormat | "auto";
   tokenSources?: AuditTokenSource[];
   writeBaseline?: boolean;
 }

package/types/index.d.ts

@@ -39,6 +39,7 @@ export interface RhythmguardPlugin extends Array<StylelintRuleModule> {
     logical: RhythmguardStylelintConfig;
     migration: RhythmguardStylelintConfig;
     motion: RhythmguardStylelintConfig;
+    "react-tailwind": RhythmguardStylelintConfig;
     recommended: RhythmguardStylelintConfig;
     strict: RhythmguardStylelintConfig;
     tailwind: RhythmguardStylelintConfig;