@razorwind/stylelint 0.0.2

package/dist/types-DdjS21Bx.d.cts

@@ -0,0 +1,136 @@
+import { ComponentRole, ManifestComponent, ManifestFont, ManifestToken, TokenCategory } from "@razorwind/eslint";
+import { GuardrailRuleId as TailwindGuardrailRuleId, GuardrailTheme as TailwindGuardrailTheme } from "@razorwind/tailwindcss/stylelint-runtime";
+//#region src/types.d.ts
+/**
+ * Options for the Razorwind Stylelint design-system plugin generator.
+ */
+interface StylelintPluginOptions {
+  /**
+   * Output path of the generated Stylelint plugin module, written relative
+   * to the execution cwd.
+   *
+   * @defaultValue "stylelint/design-system/index.mjs"
+   */
+  stylelintPath?: string;
+  /**
+   * Rule namespace used in `stylelint.config.*`
+   * (`<prefix>/ensure-design-token-usage`).
+   *
+   * @defaultValue "design-system"
+   */
+  prefix?: string;
+  /**
+   * Module the generated file imports `createDesignSystemPlugin` from.
+   *
+   * @defaultValue "\@razorwind/stylelint/runtime"
+   */
+  runtimeImport?: string;
+  /**
+   * Prefix of the CSS custom properties generated for the design tokens
+   * (`--<prefix>-color-primary`). Set to `false` when tokens are emitted
+   * without a prefix.
+   *
+   * @defaultValue initials derived from the schema name, matching `\@razorwind/css`
+   */
+  cssVarPrefix?: string | false;
+  /**
+   * Include the `\@razorwind/tailwindcss` guardrails, exposed as
+   * `<prefix>/tailwind-*` rules that read `\@apply` preludes and theme
+   * variable references.
+   *
+   * @defaultValue true
+   */
+  tailwind?: boolean;
+  /**
+   * Override body for generated `INSTALL.md`. When omitted, Stylelint config
+   * wiring steps are generated for the output file.
+   */
+  installGuide?: string;
+}
+/**
+ * Schema-derived design-system manifest serialized into the generated
+ * Stylelint module.
+ */
+interface DesignSystemManifest {
+  /** Plugin name. */
+  name: string;
+  /** Plugin version. */
+  version: string;
+  /** Rule namespace used in `stylelint.config.*`. */
+  prefix: string;
+  /** CSS custom-property prefix, when tokens are emitted with one. */
+  cssVarPrefix?: string;
+  /** Theme ids present in the schema (`light`, `dark`). */
+  themes: string[];
+  tokens: ManifestToken[];
+  /** Schema components, named in messages that point at a replacement. */
+  components: ManifestComponent[];
+  fonts: ManifestFont[];
+  /** `\@razorwind/tailwindcss` guardrail theme, when enabled. */
+  tailwind?: TailwindGuardrailTheme;
+}
+/**
+ * Rule ids ported from `\@atlaskit/stylelint-design-system`, plus the
+ * `\@razorwind/eslint` rules that apply to stylesheets.
+ */
+type CoreRuleId = "ensure-design-token-usage" | "no-unsafe-design-token-usage" | "no-deprecated-design-token-usage" | "use-tokens-space" | "use-tokens-shape" | "use-tokens-typography" | "use-tokens-motion" | "expand-motion-shorthand" | "no-physical-properties" | "no-margin" | "use-visually-hidden";
+type TailwindRuleId = `tailwind-${TailwindGuardrailRuleId}`;
+/** Every rule id the generated plugin can expose. */
+type DesignSystemRuleId = CoreRuleId | TailwindRuleId;
+type DesignSystemSeverity = "error" | "warn" | "off";
+/**
+ * Value domains `ensure-design-token-usage` checks: the primary option of
+ * `\@atlaskit/stylelint-design-system`'s rule.
+ */
+interface TokenUsageDomains {
+  /**
+   * Hard-coded colors and shadows.
+   *
+   * @defaultValue true
+   */
+  color?: boolean;
+  /**
+   * Hard-coded lengths in spacing properties (`padding`, `gap`, …).
+   *
+   * @defaultValue false
+   */
+  spacing?: boolean;
+  /**
+   * Hard-coded font sizes, weights, families, line heights and letter
+   * spacing.
+   *
+   * @defaultValue false
+   */
+  typography?: boolean;
+  /**
+   * Custom properties outside the design system (`var(--sidebar-width)`).
+   *
+   * @defaultValue false
+   */
+  nonTokenCssVariables?: boolean;
+}
+/**
+ * How `no-unsafe-design-token-usage` treats `var(--token, fallback)`
+ * fallbacks: required (`forced`), allowed (`optional`) or disallowed (`none`).
+ */
+type FallbackUsage = "forced" | "optional" | "none";
+/** Options for the generated Stylelint config factory. */
+interface DesignSystemOptions {
+  /** Glob(s) the rules apply to; the rules move into an `overrides` entry. */
+  files?: string[];
+  /** Glob(s) exempt from every rule. */
+  ignoreFiles?: string[];
+  /** Per-rule overrides of the schema-derived default severities. */
+  severity?: Partial<Record<DesignSystemRuleId, DesignSystemSeverity>>;
+  /** Domains `ensure-design-token-usage` checks. */
+  tokenUsage?: TokenUsageDomains;
+  /**
+   * Fallback strategy of `no-unsafe-design-token-usage`.
+   *
+   * @defaultValue "optional"
+   */
+  fallbackUsage?: FallbackUsage;
+}
+//#endregion
+export { DesignSystemRuleId as a, ManifestComponent as c, StylelintPluginOptions as d, TokenCategory as f, DesignSystemOptions as i, ManifestFont as l, CoreRuleId as n, DesignSystemSeverity as o, TokenUsageDomains as p, DesignSystemManifest as r, FallbackUsage as s, ComponentRole as t, ManifestToken as u };
+//# sourceMappingURL=types-DdjS21Bx.d.cts.map

package/dist/types-DdjS21Bx.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types-DdjS21Bx.d.cts","names":[],"sources":["../src/types.ts"],"mappings":";;;;;;UA2CiB;;;;;;;EAOf;;;;;;;EAQA;;;;;;EAOA;;;;;;;;EASA;;;;;;;;EASA;;;;;EAMA;;;;;;UAOe;;EAEf;;EAEA;;EAEA;;EAEA;;EAEA;EACA,QAAQ;;EAER,YAAY;EACZ,OAAO;;EAEP,WAAW;;;;;;KAOD;KAaA,6BAA6B;;KAG7B,qBAAqB,aAAa;KAElC;;;;;UAMK;;;;;;EAMf;;;;;;EAMA;;;;;;;EAOA;;;;;;EAMA;;;;;;KAOU;;UAGK;;EAEf;;EAEA;;EAEA,WAAW,QAAQ,OAAO,oBAAoB;;EAE9C,aAAa;;;;;;EAMb,gBAAgB"}

package/dist/types-DdjS21Bx.d.mts

@@ -0,0 +1,136 @@
+import { ComponentRole, ManifestComponent, ManifestFont, ManifestToken, TokenCategory } from "@razorwind/eslint";
+import { GuardrailRuleId as TailwindGuardrailRuleId, GuardrailTheme as TailwindGuardrailTheme } from "@razorwind/tailwindcss/stylelint-runtime";
+//#region src/types.d.ts
+/**
+ * Options for the Razorwind Stylelint design-system plugin generator.
+ */
+interface StylelintPluginOptions {
+  /**
+   * Output path of the generated Stylelint plugin module, written relative
+   * to the execution cwd.
+   *
+   * @defaultValue "stylelint/design-system/index.mjs"
+   */
+  stylelintPath?: string;
+  /**
+   * Rule namespace used in `stylelint.config.*`
+   * (`<prefix>/ensure-design-token-usage`).
+   *
+   * @defaultValue "design-system"
+   */
+  prefix?: string;
+  /**
+   * Module the generated file imports `createDesignSystemPlugin` from.
+   *
+   * @defaultValue "\@razorwind/stylelint/runtime"
+   */
+  runtimeImport?: string;
+  /**
+   * Prefix of the CSS custom properties generated for the design tokens
+   * (`--<prefix>-color-primary`). Set to `false` when tokens are emitted
+   * without a prefix.
+   *
+   * @defaultValue initials derived from the schema name, matching `\@razorwind/css`
+   */
+  cssVarPrefix?: string | false;
+  /**
+   * Include the `\@razorwind/tailwindcss` guardrails, exposed as
+   * `<prefix>/tailwind-*` rules that read `\@apply` preludes and theme
+   * variable references.
+   *
+   * @defaultValue true
+   */
+  tailwind?: boolean;
+  /**
+   * Override body for generated `INSTALL.md`. When omitted, Stylelint config
+   * wiring steps are generated for the output file.
+   */
+  installGuide?: string;
+}
+/**
+ * Schema-derived design-system manifest serialized into the generated
+ * Stylelint module.
+ */
+interface DesignSystemManifest {
+  /** Plugin name. */
+  name: string;
+  /** Plugin version. */
+  version: string;
+  /** Rule namespace used in `stylelint.config.*`. */
+  prefix: string;
+  /** CSS custom-property prefix, when tokens are emitted with one. */
+  cssVarPrefix?: string;
+  /** Theme ids present in the schema (`light`, `dark`). */
+  themes: string[];
+  tokens: ManifestToken[];
+  /** Schema components, named in messages that point at a replacement. */
+  components: ManifestComponent[];
+  fonts: ManifestFont[];
+  /** `\@razorwind/tailwindcss` guardrail theme, when enabled. */
+  tailwind?: TailwindGuardrailTheme;
+}
+/**
+ * Rule ids ported from `\@atlaskit/stylelint-design-system`, plus the
+ * `\@razorwind/eslint` rules that apply to stylesheets.
+ */
+type CoreRuleId = "ensure-design-token-usage" | "no-unsafe-design-token-usage" | "no-deprecated-design-token-usage" | "use-tokens-space" | "use-tokens-shape" | "use-tokens-typography" | "use-tokens-motion" | "expand-motion-shorthand" | "no-physical-properties" | "no-margin" | "use-visually-hidden";
+type TailwindRuleId = `tailwind-${TailwindGuardrailRuleId}`;
+/** Every rule id the generated plugin can expose. */
+type DesignSystemRuleId = CoreRuleId | TailwindRuleId;
+type DesignSystemSeverity = "error" | "warn" | "off";
+/**
+ * Value domains `ensure-design-token-usage` checks: the primary option of
+ * `\@atlaskit/stylelint-design-system`'s rule.
+ */
+interface TokenUsageDomains {
+  /**
+   * Hard-coded colors and shadows.
+   *
+   * @defaultValue true
+   */
+  color?: boolean;
+  /**
+   * Hard-coded lengths in spacing properties (`padding`, `gap`, …).
+   *
+   * @defaultValue false
+   */
+  spacing?: boolean;
+  /**
+   * Hard-coded font sizes, weights, families, line heights and letter
+   * spacing.
+   *
+   * @defaultValue false
+   */
+  typography?: boolean;
+  /**
+   * Custom properties outside the design system (`var(--sidebar-width)`).
+   *
+   * @defaultValue false
+   */
+  nonTokenCssVariables?: boolean;
+}
+/**
+ * How `no-unsafe-design-token-usage` treats `var(--token, fallback)`
+ * fallbacks: required (`forced`), allowed (`optional`) or disallowed (`none`).
+ */
+type FallbackUsage = "forced" | "optional" | "none";
+/** Options for the generated Stylelint config factory. */
+interface DesignSystemOptions {
+  /** Glob(s) the rules apply to; the rules move into an `overrides` entry. */
+  files?: string[];
+  /** Glob(s) exempt from every rule. */
+  ignoreFiles?: string[];
+  /** Per-rule overrides of the schema-derived default severities. */
+  severity?: Partial<Record<DesignSystemRuleId, DesignSystemSeverity>>;
+  /** Domains `ensure-design-token-usage` checks. */
+  tokenUsage?: TokenUsageDomains;
+  /**
+   * Fallback strategy of `no-unsafe-design-token-usage`.
+   *
+   * @defaultValue "optional"
+   */
+  fallbackUsage?: FallbackUsage;
+}
+//#endregion
+export { DesignSystemRuleId as a, ManifestComponent as c, StylelintPluginOptions as d, TokenCategory as f, DesignSystemOptions as i, ManifestFont as l, CoreRuleId as n, DesignSystemSeverity as o, TokenUsageDomains as p, DesignSystemManifest as r, FallbackUsage as s, ComponentRole as t, ManifestToken as u };
+//# sourceMappingURL=types-DdjS21Bx.d.mts.map

package/dist/types-DdjS21Bx.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types-DdjS21Bx.d.mts","names":[],"sources":["../src/types.ts"],"mappings":""}

package/package.json

@@ -0,0 +1,97 @@
+{
+  "name": "@razorwind/stylelint",
+  "version": "0.0.2",
+  "type": "module",
+  "description": "Razorwind Stylelint plugin generator to create stylelint rules that can be used as design system guidelines.",
+  "repository": {
+    "type": "github",
+    "url": "https://github.com/storm-software/razorwind.git",
+    "directory": "packages/stylelint"
+  },
+  "homepage": "https://stormsoftware.com",
+  "bugs": {
+    "url": "https://stormsoftware.com/support",
+    "email": "support@stormsoftware.com"
+  },
+  "author": {
+    "name": "Storm Software",
+    "email": "contact@stormsoftware.com",
+    "url": "https://stormsoftware.com"
+  },
+  "license": "Apache-2.0",
+  "private": false,
+  "files": ["dist"],
+  "keywords": [
+    "stylelint",
+    "stylelint-plugin",
+    "razorwind",
+    "design-tokens",
+    "dtcg",
+    "storm-software"
+  ],
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      },
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "default": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      }
+    },
+    "./generate": {
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      },
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "default": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      }
+    },
+    "./runtime": {
+      "require": {
+        "types": "./dist/runtime.d.cts",
+        "default": "./dist/runtime.cjs"
+      },
+      "import": {
+        "types": "./dist/runtime.d.mts",
+        "default": "./dist/runtime.mjs"
+      },
+      "default": {
+        "types": "./dist/runtime.d.mts",
+        "default": "./dist/runtime.mjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.cts",
+  "typings": "dist/index.d.mts",
+  "dependencies": {
+    "@power-plant/core": "^0.0.93",
+    "@power-plant/dtcg-schema": "^0.0.1",
+    "@razorwind/core": "^0.0.80",
+    "@razorwind/eslint": "^0.0.2",
+    "@razorwind/tailwindcss": "^0.0.78"
+  },
+  "peerDependencies": { "stylelint": "^16.8.2 || ^17.0.0" },
+  "peerDependenciesMeta": { "stylelint": { "optional": true } },
+  "devDependencies": {
+    "@powerlines/plugin-tsdown": "^0.1.614",
+    "@types/node": "^25.9.9",
+    "typescript": "^6.0.3"
+  },
+  "publishConfig": { "access": "public" },
+  "gitHead": "2dc4d1c0f0fa0810aad001551f06c614f4991fec"
+}