mirror of
https://github.com/we-promise/sure.git
synced 2026-05-11 14:45:01 +00:00
* feat(design-system): live tokens reference page in Lookbook Adds `DesignTokensPreview` at `/design-system/inspect/design_tokens/*`, split into seven sub-pages (typography, palette, surfaces, text, borders, controls, effects). Each reads `design/tokens/sure.tokens.json` at request time and renders the corresponding slice with values pre-resolved to literal hex / rgba in Ruby — Tailwind doesn't need to keep every CSS variable alive for the swatches to render. Also drops the `@source not "../../../design/tokens"` directive added in #1604. Excluding the JSON tree-shook ten or so design system utilities that aren't yet used in app views (`shadow-border-md/sm/xl`, `button-bg-ghost-hover`, etc.). The preview references each utility through dynamic ERB, which Tailwind's scanner can't follow, so those swatches were rendering blank. Letting Tailwind scan the JSON keeps every declared utility available, which matches the intent of a design system. Compiled CSS grows by about 3 KB. Stacked previously on the `refactor/design-system-tokens` branch behind #1604; rebased onto `main` once that landed. * style(design-system): apply rubocop indented_internal_methods to preview CI lint flagged the private helpers in DesignTokensPreview because the project's RuboCop config uses `indented_internal_methods` style (methods after `private`/`protected` get an extra 2-space indent). Auto-fixed with `bin/rubocop -A`. * fix(design-system): pre-resolve utility token values for the preview CodeRabbit caught: collect_utilities was passing raw `{ref}` strings (e.g. `{color.gray.50}`) as light_value/dark_value, while the rest of the class pre-resolves to literal hex / rgba. The four templates that display them (surfaces, text, borders, controls) showed the unresolved template strings to users. Adds `light_resolved` / `dark_resolved` fields to each utility entry, populated via the same `resolve_template` helper the other collectors use. Templates display `:light_resolved || :light_value` so plain class strings (e.g. `border-tertiary`, `bg-gray-800 fg-inverse`) and compose cases still fall through correctly.
223 lines
6.8 KiB
Ruby
223 lines
6.8 KiB
Ruby
class DesignTokensPreview < ViewComponent::Preview
|
|
# Each section is its own preview so the Lookbook nav groups them.
|
|
# Source of truth: design/tokens/sure.tokens.json.
|
|
#
|
|
# All values are pre-resolved in this class (refs and {ref|N%} expanded to
|
|
# final hex / rgba strings) so templates iterate over plain data with no
|
|
# Tailwind-runtime dependency.
|
|
|
|
TAILWIND_TEXT_SIZES = [
|
|
[ "text-xs", "12px / 16px" ],
|
|
[ "text-sm", "14px / 20px" ],
|
|
[ "text-base", "16px / 24px" ],
|
|
[ "text-lg", "18px / 28px" ],
|
|
[ "text-xl", "20px / 28px" ],
|
|
[ "text-2xl", "24px / 32px" ],
|
|
[ "text-3xl", "30px / 36px" ],
|
|
[ "text-4xl", "36px / 40px" ],
|
|
[ "text-5xl", "48px" ]
|
|
].freeze
|
|
|
|
TAILWIND_FONT_WEIGHTS = [
|
|
[ "font-light", 300 ],
|
|
[ "font-normal", 400 ],
|
|
[ "font-medium", 500 ],
|
|
[ "font-semibold", 600 ],
|
|
[ "font-bold", 700 ]
|
|
].freeze
|
|
|
|
def typography
|
|
render_with_template(locals: {
|
|
fonts: collect_fonts,
|
|
text_sizes: TAILWIND_TEXT_SIZES,
|
|
font_weights: TAILWIND_FONT_WEIGHTS
|
|
})
|
|
end
|
|
|
|
def palette
|
|
render_with_template(locals: {
|
|
base_colors: collect_named_colors(%w[white black]),
|
|
semantic_colors: collect_named_colors(%w[success warning destructive shadow]),
|
|
budget_colors: collect_budget,
|
|
scales: collect_scales
|
|
})
|
|
end
|
|
|
|
def surfaces
|
|
render_with_template(locals: { utilities: collect_utilities { |name| name.start_with?("bg-") } })
|
|
end
|
|
|
|
def text
|
|
render_with_template(locals: {
|
|
text_utilities: collect_utilities { |name| name.start_with?("text-") },
|
|
fg_utilities: collect_utilities { |name| name.start_with?("fg-") }
|
|
})
|
|
end
|
|
|
|
def borders
|
|
render_with_template(locals: { utilities: collect_utilities { |name| name.start_with?("border-") || name.start_with?("shadow-border-") } })
|
|
end
|
|
|
|
def controls
|
|
render_with_template(locals: { utilities: collect_utilities { |name| name.start_with?("button-bg-") || name.start_with?("tab-") || name == "bg-nav-indicator" } })
|
|
end
|
|
|
|
def effects
|
|
render_with_template(locals: {
|
|
shadows: collect_shadows,
|
|
radii: collect_radii
|
|
})
|
|
end
|
|
|
|
private
|
|
|
|
# ─── Data builders ──────────────────────────────────────────────────────
|
|
|
|
def collect_fonts
|
|
walked.select { |path, _| path.first == "font" }.map do |path, node|
|
|
{ var: var_name(path), name: path.last, value: node["$value"] }
|
|
end
|
|
end
|
|
|
|
def collect_named_colors(names)
|
|
walked.filter_map do |path, node|
|
|
next unless path.first == "color" && path.length == 2 && names.include?(path[1])
|
|
build_color_entry(path, node)
|
|
end
|
|
end
|
|
|
|
def collect_budget
|
|
walked.filter_map do |path, node|
|
|
next unless path.first == "budget"
|
|
build_color_entry(path, node)
|
|
end
|
|
end
|
|
|
|
def collect_scales
|
|
scales = {}
|
|
walked.each do |path, node|
|
|
next unless path.first == "color" && path.length > 2
|
|
scales[path[1]] ||= []
|
|
scales[path[1]] << build_color_entry(path, node)
|
|
end
|
|
scales
|
|
end
|
|
|
|
def collect_utilities
|
|
walked.filter_map do |path, node|
|
|
next unless path.first == "utility"
|
|
name = path[1]
|
|
next unless yield(name)
|
|
ext = node["$extensions"] || {}
|
|
light_raw = node["$value"]
|
|
dark_raw = ext["sure.dark"]
|
|
{
|
|
name: path[1..].join("-"),
|
|
light_value: light_raw,
|
|
dark_value: dark_raw,
|
|
light_resolved: light_raw.is_a?(String) ? resolve_template(light_raw) : nil,
|
|
dark_resolved: dark_raw.is_a?(String) ? resolve_template(dark_raw) : nil,
|
|
compose: ext["sure.compose"]
|
|
}
|
|
end
|
|
end
|
|
|
|
def collect_shadows
|
|
walked.filter_map do |path, node|
|
|
next unless path.first == "shadow"
|
|
{
|
|
var: var_name(path),
|
|
name: path.last,
|
|
light_resolved: resolve_value(node),
|
|
light_raw: node["$value"],
|
|
dark_raw: node.dig("$extensions", "sure.dark")
|
|
}
|
|
end
|
|
end
|
|
|
|
def collect_radii
|
|
walked.filter_map do |path, node|
|
|
next unless path.first == "border" && path.length == 3
|
|
{ var: var_name(path), name: path.last, value: resolve_value(node) || node["$value"] }
|
|
end
|
|
end
|
|
|
|
def build_color_entry(path, node)
|
|
{
|
|
var: var_name(path),
|
|
name: path.last,
|
|
light_resolved: resolve_value(node) || node["$value"],
|
|
light_raw: node["$value"],
|
|
dark_resolved: resolve_dark(node),
|
|
dark_raw: node.dig("$extensions", "sure.dark")
|
|
}
|
|
end
|
|
|
|
# ─── Token walker ───────────────────────────────────────────────────────
|
|
|
|
def tokens
|
|
@tokens ||= JSON.parse(Rails.root.join("design/tokens/sure.tokens.json").read)
|
|
end
|
|
|
|
def walked
|
|
@walked ||= begin
|
|
result = []
|
|
walker = lambda do |node, path|
|
|
return unless node.is_a?(Hash)
|
|
if node.key?("$value") || node["$type"] == "utility"
|
|
result << [ path, node ]
|
|
return unless node["$value"].is_a?(Hash)
|
|
end
|
|
node.each do |k, v|
|
|
next if k.start_with?("$")
|
|
walker.call(v, path + [ k ])
|
|
end
|
|
end
|
|
walker.call(tokens, [])
|
|
result
|
|
end
|
|
end
|
|
|
|
# ─── Reference resolution ───────────────────────────────────────────────
|
|
|
|
def var_name(path)
|
|
cleaned = path.last == "DEFAULT" ? path[0..-2] : path
|
|
"--#{cleaned.join('-')}"
|
|
end
|
|
|
|
def resolve_value(node)
|
|
return nil unless node.is_a?(Hash)
|
|
v = node["$value"]
|
|
return nil unless v.is_a?(String)
|
|
resolve_template(v)
|
|
end
|
|
|
|
def resolve_dark(node)
|
|
raw = node.dig("$extensions", "sure.dark")
|
|
raw ? resolve_template(raw) : nil
|
|
end
|
|
|
|
def resolve_template(str)
|
|
str.gsub(/\{([^|}]+)(?:\|([^}]+))?\}/) do
|
|
ref_path = Regexp.last_match(1).split(".")
|
|
alpha = Regexp.last_match(2)
|
|
target = lookup(ref_path)
|
|
resolved = target ? (resolve_value(target) || target["$value"]) : Regexp.last_match(0)
|
|
alpha ? hex_to_rgba(resolved, alpha) : resolved
|
|
end
|
|
end
|
|
|
|
def lookup(path)
|
|
path.inject(tokens) { |h, k| h.is_a?(Hash) ? h[k] : nil }
|
|
end
|
|
|
|
def hex_to_rgba(hex, percent_str)
|
|
return hex unless hex.is_a?(String) && hex.start_with?("#")
|
|
h = hex.delete_prefix("#")
|
|
h = h.chars.map { |c| c * 2 }.join if h.length == 3
|
|
r, g, b = h[0, 2].to_i(16), h[2, 2].to_i(16), h[4, 2].to_i(16)
|
|
pct = percent_str.to_s.delete("%").to_f / 100.0
|
|
"rgba(#{r}, #{g}, #{b}, #{pct.round(3)})"
|
|
end
|
|
end
|