dispersa 0.4.2 → 1.0.0

package/dist/builders.cjs

@@ -1,5 +1,6 @@
 'use strict';
 
+var changeCase = require('change-case');
 var culori = require('culori');
 var prettier = require('prettier');
 
@@ -46,19 +47,6 @@ var init_errors = __esm({
 });
 
 // src/shared/utils/token-utils.ts
-function formatDeprecationMessage(token, description = "", format = "bracket") {
-  if (token.$deprecated == null || token.$deprecated === false) {
-    return description;
-  }
-  const deprecationMsg = typeof token.$deprecated === "string" ? token.$deprecated : "";
-  if (format === "comment") {
-    const msg2 = deprecationMsg ? ` ${deprecationMsg}` : "";
-    return `DEPRECATED${msg2}`;
-  }
-  const msg = deprecationMsg ? `: ${deprecationMsg}` : "";
-  const prefix = `[DEPRECATED${msg}]`;
-  return description ? `${prefix} ${description}` : prefix;
-}
 function stripInternalTokenMetadata(tokens) {
   const cleaned = {};
   for (const [name, token] of Object.entries(tokens)) {
@@ -132,7 +120,7 @@ function indentStr(width, level) {
 function buildGeneratedFileHeader() {
   return [
     "// Generated by Dispersa - do not edit manually",
-    "// https://github.com/timges/dispersa"
+    "// https://github.com/dispersa-core/dispersa"
   ].join("\n");
 }
 function toSafeIdentifier(name, keywords, capitalize) {
@@ -336,6 +324,94 @@ var init_utils = __esm({
   }
 });
 
+// src/renderers/metadata.ts
+function sanitizeText(text, format) {
+  switch (format) {
+    case "css":
+    case "tailwind":
+      return text.replace(/\*\//g, "*\\/").replace(/\r?\n/g, " ").trim();
+    case "kotlin":
+      return text.replace(/\*\//g, "* /").replace(/\r?\n/g, " ").trim();
+    case "js":
+    case "swift":
+      return text.replace(/\r?\n/g, " ").trim();
+    default:
+      return text.trim();
+  }
+}
+function buildDeprecationText(token) {
+  if (token.$deprecated == null || token.$deprecated === false) {
+    return "";
+  }
+  const msg = typeof token.$deprecated === "string" ? token.$deprecated : "";
+  return msg ? `DEPRECATED: ${msg}` : "DEPRECATED";
+}
+function buildTokenDescriptionComment(token, format) {
+  if (!token.$description || token.$description === "") {
+    return void 0;
+  }
+  const text = sanitizeText(token.$description, format);
+  switch (format) {
+    case "css":
+    case "tailwind":
+      return `/* ${text} */`;
+    case "js":
+      return `// ${text}`;
+    case "swift":
+      return `/// ${text}`;
+    case "kotlin":
+      return `/** ${text} */`;
+    default:
+      return void 0;
+  }
+}
+function buildTokenDeprecationComment(token, format) {
+  const text = buildDeprecationText(token);
+  if (!text) {
+    return void 0;
+  }
+  switch (format) {
+    case "css":
+    case "tailwind":
+      return `/* ${text} */`;
+    case "js":
+      return `// ${text}`;
+    case "swift":
+      return `/// ${text}`;
+    case "kotlin":
+      return `/** ${text} */`;
+    default:
+      return void 0;
+  }
+}
+function buildModifierComment(modifier, context) {
+  return `/* Modifier: ${modifier}=${context} */`;
+}
+function buildSwiftDeprecationAttribute(token) {
+  if (token.$deprecated == null || token.$deprecated === false) {
+    return void 0;
+  }
+  const msg = typeof token.$deprecated === "string" ? token.$deprecated : "";
+  if (msg) {
+    return `@available(*, deprecated, message: "${sanitizeText(msg, "swift")}")`;
+  }
+  return "@available(*, deprecated)";
+}
+function buildKotlinDeprecationAnnotation(token) {
+  if (token.$deprecated == null || token.$deprecated === false) {
+    return void 0;
+  }
+  const msg = typeof token.$deprecated === "string" ? token.$deprecated : "";
+  if (msg) {
+    return `@Deprecated(message = "${sanitizeText(msg, "kotlin")}")`;
+  }
+  return "@Deprecated";
+}
+var init_metadata = __esm({
+  "src/renderers/metadata.ts"() {
+  }
+});
+
 // src/renderers/bundlers/js.ts
 var js_exports = {};
 __export(js_exports, {
@@ -440,7 +516,7 @@ async function bundleAsJsModule(bundleData, resolver, options, formatTokens) {
   }
   const metadata = buildMetadata(resolver);
   const jsBlocks = [];
-  for (const { tokens, modifierInputs } of bundleData) {
+  for (const { tokens, modifierInputs, isBase } of bundleData) {
     const cleanTokens = stripInternalMetadata(tokens);
     const key = buildStableDashKey({
       modifierInputs,
@@ -448,10 +524,30 @@ async function bundleAsJsModule(bundleData, resolver, options, formatTokens) {
       defaults: metadata.defaults
     });
     const camelKey = toCamelKey(key);
+    const normalizedInputs = normalizeModifierInputs(modifierInputs);
+    const modifierParts = [];
+    for (const dim of metadata.dimensions) {
+      const value = normalizedInputs[dim.toLowerCase()];
+      if (value) {
+        modifierParts.push(`${dim}=${value}`);
+      }
+    }
     const formattedJs = await formatTokens(cleanTokens);
     const tokenObject = extractObjectFromJsModule(formattedJs);
     const indentedObject = tokenObject.replace(/\n/g, "\n  ");
-    jsBlocks.push(`  // ${key}
+    let comment;
+    if (modifierParts.length > 0) {
+      const modifierPart = modifierParts[0];
+      const eqIndex = modifierPart.indexOf("=");
+      const modifier = modifierPart.slice(0, eqIndex);
+      const context = modifierPart.slice(eqIndex + 1);
+      comment = buildModifierComment(modifier, context);
+    } else if (isBase) {
+      comment = "// Base permutation";
+    } else {
+      comment = `// ${key}`;
+    }
+    jsBlocks.push(`  ${comment}
   ${JSON.stringify(camelKey)}: ${indentedObject}`);
   }
   return assembleJsBundle(metadata, jsBlocks, options?.generateHelper ?? false);
@@ -459,6 +555,7 @@ async function bundleAsJsModule(bundleData, resolver, options, formatTokens) {
 var init_js = __esm({
   "src/renderers/bundlers/js.ts"() {
     init_errors();
+    init_metadata();
     init_utils();
   }
 });
@@ -490,6 +587,17 @@ var init_json = __esm({
     init_utils();
   }
 });
+function nameKebabCase() {
+  return {
+    transform: (token) => {
+      const name = changeCase.kebabCase(token.path.join(" "));
+      return {
+        ...token,
+        name
+      };
+    }
+  };
+}
 function isColorObject(value) {
   return typeof value === "object" && value !== null && "colorSpace" in value && "components" in value;
 }
@@ -567,6 +675,7 @@ function durationObjectToString(duration) {
 init_errors();
 init_token_utils();
 init_utils();
+init_metadata();
 
 // src/renderers/output-tree.ts
 var outputTree = (files) => {
@@ -627,9 +736,6 @@ function resolveColorFormat(format) {
 function escapeKotlinString(str) {
   return str.replace(/\\/g, "\\\\").replace(/"/g, '\\"').replace(/\n/g, "\\n").replace(/\$/g, "\\$");
 }
-function escapeKDoc(str) {
-  return str.replace(/\*\//g, "* /").replace(/\r?\n/g, " ").trim();
-}
 function formatKotlinNumber(value) {
   return Number.isInteger(value) ? `${value}.0` : String(value);
 }
@@ -761,8 +867,13 @@ var AndroidRenderer = class {
         const kotlinName = this.buildFlatKotlinName(token);
         const kotlinValue = this.formatKotlinValue(token, options, baseDepth + 1);
         const annotation = this.typeAnnotationSuffix(token);
-        if (token.$description) {
-          lines.push(`${valIndent}/** ${escapeKDoc(token.$description)} */`);
+        const descriptionComment = buildTokenDescriptionComment(token, "kotlin");
+        if (descriptionComment) {
+          lines.push(`${valIndent}${descriptionComment}`);
+        }
+        const deprecation = buildKotlinDeprecationAnnotation(token);
+        if (deprecation) {
+          lines.push(`${valIndent}${deprecation}`);
         }
         lines.push(
           `${valIndent}${options.visPrefix}val ${kotlinName}${annotation} = ${kotlinValue}`
@@ -798,8 +909,13 @@ var AndroidRenderer = class {
     const kotlinName = toSafeIdentifier(key, KOTLIN_KEYWORDS, false);
     const kotlinValue = this.formatKotlinValue(token, options, depth);
     const annotation = this.typeAnnotationSuffix(token);
-    if (token.$description) {
-      lines.push(`${pad}/** ${escapeKDoc(token.$description)} */`);
+    const descriptionComment = buildTokenDescriptionComment(token, "kotlin");
+    if (descriptionComment) {
+      lines.push(`${pad}${descriptionComment}`);
+    }
+    const deprecation = buildKotlinDeprecationAnnotation(token);
+    if (deprecation) {
+      lines.push(`${pad}${deprecation}`);
     }
     lines.push(`${pad}${options.visPrefix}val ${kotlinName}${annotation} = ${kotlinValue}`);
   }
@@ -1576,10 +1692,8 @@ function stableInputsKey(modifierInputs) {
 
 // src/renderers/css.ts
 init_utils();
+init_metadata();
 var CssRenderer = class _CssRenderer {
-  sanitizeCssCommentText(text) {
-    return text.replace(/\*\//g, "*\\/").replace(/\r?\n/g, " ").trim();
-  }
   async format(context, options) {
     const opts = {
       preset: options?.preset ?? "bundle",
@@ -1659,12 +1773,13 @@ var CssRenderer = class _CssRenderer {
   }
   pushTokenLines(lines, token, tokens, referenceTokens, preserveReferences, indent, newline, space) {
     const entries = this.buildCssEntries(token, tokens, referenceTokens, preserveReferences);
-    if (token.$deprecated != null && token.$deprecated !== false) {
-      const deprecationMsg = formatDeprecationMessage(token, "", "comment");
-      lines.push(`${indent}/* ${this.sanitizeCssCommentText(deprecationMsg)} */${newline}`);
+    const deprecationComment = buildTokenDeprecationComment(token, "css");
+    if (deprecationComment) {
+      lines.push(`${indent}${deprecationComment}${newline}`);
     }
-    if (token.$description && token.$description !== "") {
-      lines.push(`${indent}/* ${this.sanitizeCssCommentText(token.$description)} */${newline}`);
+    const descriptionComment = buildTokenDescriptionComment(token, "css");
+    if (descriptionComment) {
+      lines.push(`${indent}${descriptionComment}${newline}`);
     }
     for (const entry of entries) {
       lines.push(`${indent}--${entry.name}:${space}${entry.value};${newline}`);
@@ -2315,6 +2430,7 @@ function isBorderToken(token) {
 
 // src/renderers/ios.ts
 init_utils();
+init_metadata();
 var toSRGB2 = culori.converter("rgb");
 var toP32 = culori.converter("p3");
 var SWIFT_TYPE_GROUP_MAP = {
@@ -2458,9 +2574,13 @@ var IosRenderer = class {
       const swiftValue = this.formatSwiftValue(token, options);
       const typeAnnotation = this.getTypeAnnotation(token);
       const annotation = typeAnnotation ? `: ${typeAnnotation}` : "";
-      const docComment = this.buildDocComment(token, indent);
+      const docComment = buildTokenDescriptionComment(token, "swift");
       if (docComment) {
-        lines.push(docComment);
+        lines.push(`${indent}${docComment}`);
+      }
+      const deprecationAttr = buildSwiftDeprecationAttribute(token);
+      if (deprecationAttr) {
+        lines.push(`${indent}${deprecationAttr}`);
       }
       lines.push(`${indent}${access} ${staticPrefix}${swiftName}${annotation} = ${swiftValue}`);
     }
@@ -2475,15 +2595,6 @@ var IosRenderer = class {
     }
     return Array.from(imports).sort();
   }
-  /**
-   * Builds a `///` doc comment from a token's `$description`, if present.
-   */
-  buildDocComment(token, indent) {
-    if (!token.$description) {
-      return void 0;
-    }
-    return `${indent}/// ${token.$description}`;
-  }
   /**
    * Builds a qualified Swift name from a token's path, preserving parent
    * hierarchy segments to avoid duplicate identifiers.
@@ -2874,6 +2985,7 @@ function iosRenderer() {
 // src/renderers/js-module.ts
 init_utils();
 init_token_utils();
+init_metadata();
 var JsModuleRenderer = class {
   async format(context, options) {
     const opts = {
@@ -2911,17 +3023,10 @@ var JsModuleRenderer = class {
     return outputTree(files);
   }
   async formatTokens(tokens, options) {
-    const opts = {
-      preset: options.preset ?? "standalone",
-      structure: options.structure ?? "nested",
-      minify: options.minify ?? false,
-      moduleName: options.moduleName ?? "tokens",
-      generateHelper: options.generateHelper ?? false
-    };
     const lines = [];
-    lines.push(...this.formatAsObject(tokens, opts));
+    lines.push(...this.formatAsObject(tokens, options));
     const code = lines.join("\n");
-    if (opts.minify) {
+    if (options.minify) {
       return code;
     }
     return await prettier__default.default.format(code, {
@@ -2934,20 +3039,53 @@ var JsModuleRenderer = class {
       trailingComma: "es5"
     });
   }
-  /**
-   * Format as default export object
-   */
   formatAsObject(tokens, options) {
     const lines = [];
-    const tokenObj = this.tokensToPlainObject(tokens, options.structure);
+    const tokenMap = this.buildTokenMap(tokens);
     const varName = options.moduleName !== "" ? options.moduleName : "tokens";
-    lines.push(`const ${varName} = {`);
-    this.addObjectProperties(lines, tokenObj, 1);
-    lines.push("}");
+    if (options.structure === "flat") {
+      lines.push(`const ${varName} = {`);
+      this.addFlatProperties(lines, tokens, 1);
+      lines.push("}");
+    } else {
+      lines.push(`const ${varName} = {`);
+      const tokenObj = this.tokensToPlainObject(tokens, "nested");
+      this.addNestedProperties(lines, tokenObj, tokenMap, 1);
+      lines.push("}");
+    }
     lines.push("");
     lines.push(`export default ${varName}`);
     return lines;
   }
+  buildTokenMap(tokens) {
+    const map = /* @__PURE__ */ new Map();
+    for (const [name, token] of Object.entries(tokens)) {
+      map.set(name, token);
+    }
+    return map;
+  }
+  addFlatProperties(lines, tokens, indent) {
+    const indentStr2 = "  ".repeat(indent);
+    const sortedEntries = getSortedTokenEntries(tokens);
+    for (let i = 0; i < sortedEntries.length; i++) {
+      const [name, token] = sortedEntries[i];
+      const isLast = i === sortedEntries.length - 1;
+      this.pushTokenComments(lines, token, indentStr2);
+      lines.push(
+        `${indentStr2}${this.quoteKey(name)}: ${JSON.stringify(token.$value)}${isLast ? "" : ","}`
+      );
+    }
+  }
+  pushTokenComments(lines, token, indent) {
+    const deprecationComment = buildTokenDeprecationComment(token, "js");
+    if (deprecationComment) {
+      lines.push(`${indent}${deprecationComment}`);
+    }
+    const descriptionComment = buildTokenDescriptionComment(token, "js");
+    if (descriptionComment) {
+      lines.push(`${indent}${descriptionComment}`);
+    }
+  }
   tokensToPlainObject(tokens, structure) {
     if (structure === "nested") {
       return buildNestedTokenObject(tokens, (token) => token.$value);
@@ -2958,7 +3096,7 @@ var JsModuleRenderer = class {
     }
     return result;
   }
-  addObjectProperties(lines, obj, indent) {
+  addNestedProperties(lines, obj, tokenMap, indent) {
     const indentStr2 = "  ".repeat(indent);
     const entries = Object.entries(obj).sort(([keyA], [keyB]) => keyA.localeCompare(keyB));
     for (let i = 0; i < entries.length; i++) {
@@ -2970,19 +3108,20 @@ var JsModuleRenderer = class {
       const isLast = i === entries.length - 1;
       const isNestedObject = typeof value === "object" && value !== null && !Array.isArray(value);
       if (!isNestedObject) {
+        const token = tokenMap.get(key);
+        if (token) {
+          this.pushTokenComments(lines, token, indentStr2);
+        }
         lines.push(
           `${indentStr2}${this.quoteKey(key)}: ${JSON.stringify(value)}${isLast ? "" : ","}`
         );
         continue;
       }
       lines.push(`${indentStr2}${this.quoteKey(key)}: {`);
-      this.addObjectProperties(lines, value, indent + 1);
+      this.addNestedProperties(lines, value, tokenMap, indent + 1);
       lines.push(`${indentStr2}}${isLast ? "" : ","}`);
     }
   }
-  /**
-   * Quote key if necessary
-   */
   quoteKey(key) {
     if (/^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(key)) {
       return key;
@@ -3218,6 +3357,7 @@ function resolveOptions(options) {
 
 // src/renderers/tailwind.ts
 init_utils();
+init_metadata();
 var TAILWIND_NAMESPACE_MAP = {
   color: "color",
   dimension: "spacing",
@@ -3271,6 +3411,14 @@ var TailwindRenderer = class {
     for (const [, token] of getSortedTokenEntries(tokens)) {
       const varName = this.buildVariableName(token);
       const varValue = this.formatValue(token);
+      const deprecationComment = buildTokenDeprecationComment(token, "tailwind");
+      if (deprecationComment) {
+        lines.push(`${indent}${deprecationComment}${newline}`);
+      }
+      const descriptionComment = buildTokenDescriptionComment(token, "tailwind");
+      if (descriptionComment) {
+        lines.push(`${indent}${descriptionComment}${newline}`);
+      }
       lines.push(`${indent}--${varName}:${space}${varValue};${newline}`);
     }
     lines.push(`}${newline}`);
@@ -3297,6 +3445,14 @@ var TailwindRenderer = class {
     for (const [, token] of getSortedTokenEntries(tokens)) {
       const varName = this.buildVariableName(token);
       const varValue = this.formatValue(token);
+      const deprecationComment = buildTokenDeprecationComment(token, "tailwind");
+      if (deprecationComment) {
+        lines.push(`${tokenIndent}${deprecationComment}${newline}`);
+      }
+      const descriptionComment = buildTokenDescriptionComment(token, "tailwind");
+      if (descriptionComment) {
+        lines.push(`${tokenIndent}${descriptionComment}${newline}`);
+      }
       lines.push(`${tokenIndent}--${varName}:${space}${varValue};${newline}`);
     }
     if (hasMediaQuery) {
@@ -3457,7 +3613,7 @@ function css(config) {
     file,
     renderer: cssRenderer(),
     options: { preset, ...rendererOptions },
-    transforms,
+    transforms: [nameKebabCase(), ...transforms ?? []],
     filters,
     hooks
   };