@weft-js/cli 0.1.1 → 0.1.3

package/src/style.mjs

@@ -11,7 +11,9 @@ import { loadConfig } from './load-config.mjs'
 import { isTestFile } from './tests.mjs'
 import { loadCompiler, resolveWeft } from './weft.mjs'
 
-const usageError = message => Object.assign(new Error(message), { code: 'E_USAGE' })
+import { closest, usageError } from './style/find.mjs'
+
+export { closest, findGroups } from './style/find.mjs'
 
 /** The installed weft's matrix module, or null when this weft has no style groups. */
 export async function styleModule(weft) {
@@ -23,7 +25,9 @@ export async function styleModule(weft) {
 /** Source files that can define or use groups: components and plain modules, not tests. */
 export function styleFiles(root, config = {}) {
   const exclude = [...(config.check?.exclude ?? []), ...(config.scope?.forbid ?? [])]
-  return discover(root, { include: ['**/*.{ts,tsx,jsx,mts}'], exclude }).filter(f => !isTestFile(f) && !f.endsWith('.d.ts'))
+  return discover(root, { include: ['**/*.{ts,tsx,jsx,mts}'], exclude }).filter(
+    (f) => !isTestFile(f) && !f.endsWith('.d.ts'),
+  )
 }
 
 /**
@@ -33,7 +37,11 @@ export function styleFiles(root, config = {}) {
 export async function styleMatrix(root, { write = false } = {}) {
   const weft = resolveWeft(root)
   const mod = await styleModule(weft)
-  if (!mod) throw Object.assign(new Error(`weft@${weft.version} has no style groups (@weft-js/core/style/matrix)`), { code: 'E_NO_STYLE' })
+  if (!mod)
+    throw Object.assign(
+      new Error(`weft@${weft.version} has no style groups (@weft-js/core/style/matrix)`),
+      { code: 'E_NO_STYLE' },
+    )
   const { config } = await loadConfig(root)
   const compiler = loadCompiler(weft)
   const scan = mod.scanProject(root, styleFiles(root, config), (...a) => compiler.transform(...a))
@@ -52,93 +60,6 @@ export function writeMatrixFile(root, matrix) {
   return true
 }
 
-const words = s => s.toLowerCase().split(/[\s\-_.:/=,]+|(?<=[a-z])(?=[A-Z])/).filter(Boolean)
-
-/** Edit distance with adjacent swaps as one edit (`ordre` → `order`). */
-function distance(a, b) {
-  const d = Array.from({ length: a.length + 1 }, (_, i) => Array.from({ length: b.length + 1 }, (__, j) => (i ? (j ? 0 : i) : j)))
-  for (let i = 1; i <= a.length; i++)
-    for (let j = 1; j <= b.length; j++) {
-      d[i][j] = Math.min(d[i - 1][j] + 1, d[i][j - 1] + 1, d[i - 1][j - 1] + (a[i - 1] === b[j - 1] ? 0 : 1))
-      if (i > 1 && j > 1 && a[i - 1] === b[j - 2] && a[i - 2] === b[j - 1]) d[i][j] = Math.min(d[i][j], d[i - 2][j - 2] + 1)
-    }
-  return d[a.length][b.length]
-}
-
-/** The names closest to `word` (edit distance within a third of its length, or containing it). */
-export function closest(word, names, n = 3) {
-  const w = word.toLowerCase()
-  const limit = Math.max(1, Math.floor(w.length / 3))
-  return names
-    .map(x => [distance(w, x.toLowerCase()), x])
-    .filter(([d, x]) => d <= limit || x.toLowerCase().includes(w) || w.includes(x.toLowerCase()))
-    .sort((a, b) => a[0] - b[0])
-    .slice(0, n)
-    .map(([, x]) => x)
-}
-
-/**
- * `weft style find <query>`: the groups that fit, best first. Every word of the query must hit the group's name,
- * doc, parts, axes, values, states or tokens (a name word one typo off counts); with no such group, groups that hit
- * any word.
- */
-export function findGroups(matrix, query) {
-  const terms = words(query ?? '')
-  if (!terms.length) throw usageError('weft style find <query>: say what the thing is (`card`, `status badge`, `critical`)')
-  const score = (name, g) => {
-    const fields = [
-      [words(name), 30],
-      [words(g.doc ?? ''), 10],
-      [[...g.parts, ...g.states, ...Object.keys(g.axes)].flatMap(words), 8],
-      [Object.values(g.axes).flatMap(v => (Array.isArray(v) ? v : [])).flatMap(words), 6],
-      [g.tokens.flatMap(words), 4],
-    ]
-    let total = name === query ? 100 : 0
-    const matched = []
-    let hits = 0
-    for (const t of terms) {
-      let best = 0
-      let why = null
-      for (const [ws, weight] of fields) {
-        for (const w of ws) {
-          const s = w === t ? weight : w.startsWith(t) || (t.length > 3 && w.includes(t)) ? weight * 0.7 : weight >= 30 && t.length > 3 && distance(w, t) === 1 ? weight * 0.5 : 0
-          if (s > best) [best, why] = [s, w]
-        }
-      }
-      if (best) {
-        hits++
-        matched.push(why)
-      }
-      total += best
-    }
-    return { total, hits, matched: [...new Set(matched)] }
-  }
-  const all = Object.entries(matrix.groups).map(([name, g]) => ({ name, g, ...score(name, g) })).filter(x => x.total > 0)
-  const full = all.filter(x => x.hits === terms.length)
-  const ranked = (full.length ? full : all).sort((a, b) => b.total - a.total || a.name.localeCompare(b.name))
-  // A name or doc hit outranks groups that only share a token (`row` → product-row, not every `layout: row`).
-  const picked = ranked.filter(x => x.total >= (ranked[0]?.total ?? 0) / 4)
-  return {
-    query,
-    groups: picked.map(({ name, g, total, matched }) => ({
-      name,
-      score: Math.round(total),
-      matched,
-      doc: g.doc,
-      file: g.file,
-      import: g.binding && g.exported ? { name: g.binding, from: g.file.replace(/:\d+$/, '') } : null,
-      axes: g.axes,
-      defaults: g.defaults,
-      parts: g.parts,
-      states: g.states,
-      uses: g.used.length,
-      similar: matrix.similar.filter(s => s[0] === name || s[1] === name).map(s => (s[0] === name ? s[1] : s[0])),
-    })),
-    partial: !full.length && all.length > 0,
-    total: Object.keys(matrix.groups).length,
-  }
-}
-
 const ARIA = new Set(['selected', 'pressed', 'checked', 'expanded', 'current', 'invalid', 'busy'])
 
 /**
@@ -147,21 +68,31 @@ const ARIA = new Set(['selected', 'pressed', 'checked', 'expanded', 'current', '
  */
 export function parseTarget(target) {
   const t = (target ?? '').trim()
-  if (!t) throw usageError('weft style explain <group|selector>: a group name (`order-card`), `order-card.title`, or a selector')
+  if (!t)
+    throw usageError(
+      'weft style explain <group|selector>: a group name (`order-card`), `order-card.title`, or a selector',
+    )
   const out = { group: null, part: null, axes: {}, states: [], accent: {} }
   const head = /^([a-z][\w-]*)(?:\.([\w-]+))?/i.exec(t)
   if (head && !t.startsWith('[')) {
     out.group = head[1]
     out.part = head[2] ?? null
   }
-  for (const m of t.matchAll(/\[\s*([\w-]+)\s*(?:[~|^$*]?=\s*(?:"([^"]*)"|'([^']*)'|([^\]\s]*)))?\s*\]/g)) {
+  for (const m of t.matchAll(
+    /\[\s*([\w-]+)\s*(?:[~|^$*]?=\s*(?:"([^"]*)"|'([^']*)'|([^\]\s]*)))?\s*\]/g,
+  )) {
     const [, attr, ...vals] = m
-    const value = vals.find(v => v !== undefined)
+    const value = vals.find((v) => v !== undefined)
     if (attr === 'data-g') out.group = value
     else if (attr === 'data-part') out.part = value
-    else if (attr === 'data-accent') for (const w of (value ?? '').split(/\s+/).filter(Boolean)) { const [k, v] = w.split(':'); out.accent[k] = v }
-    else if (attr.startsWith('aria-')) { if (value !== 'false') out.states.push(attr.slice(5)) }
-    else {
+    else if (attr === 'data-accent')
+      for (const w of (value ?? '').split(/\s+/).filter(Boolean)) {
+        const [k, v] = w.split(':')
+        out.accent[k] = v
+      }
+    else if (attr.startsWith('aria-')) {
+      if (value !== 'false') out.states.push(attr.slice(5))
+    } else {
       const name = attr.replace(/^data-/, '')
       if (value === undefined || value === '') out.states.push(name)
       else out.axes[name] = value
@@ -181,23 +112,44 @@ export function explainTarget({ matrix, scan, mod }, target, extra = {}) {
   const g = matrix.groups[t.group]
   if (!g) {
     const near = closest(t.group, Object.keys(matrix.groups))
-    throw Object.assign(new Error(`D025 no group \`${t.group}\`${near.length ? `; did you mean ${near.map(n => `\`${n}\``).join(' or ')}?` : ''} (\`weft style find\` searches by what it is)`), { code: 'E_UNKNOWN_GROUP' })
+    throw Object.assign(
+      new Error(
+        `D025 no group \`${t.group}\`${near.length ? `; did you mean ${near.map((n) => `\`${n}\``).join(' or ')}?` : ''} (\`weft style find\` searches by what it is)`,
+      ),
+      { code: 'E_UNKNOWN_GROUP' },
+    )
   }
-  const source = scan.groups.find(s => s.name === t.group)
+  const source = scan.groups.find((s) => s.name === t.group)
   // A state written as data-x="…" in a selector, or an axis passed as --x: sort them by what the group has.
   const axes = { ...t.axes, ...extra.axes }
   const states = [...t.states, ...(extra.states ?? [])]
-  for (const [k, v] of Object.entries(axes)) if (!(k in g.axes) && g.states.includes(k) && (v === 'true' || v === '')) { delete axes[k]; states.push(k) }
-  const selection = { axes, states: [...new Set(states)],accent: { ...t.accent, ...extra.accent }, part: extra.part ?? t.part ?? undefined }
+  for (const [k, v] of Object.entries(axes))
+    if (!(k in g.axes) && g.states.includes(k) && (v === 'true' || v === '')) {
+      delete axes[k]
+      states.push(k)
+    }
+  const selection = {
+    axes,
+    states: [...new Set(states)],
+    accent: { ...t.accent, ...extra.accent },
+    part: extra.part ?? t.part ?? undefined,
+  }
   let explained
   try {
     explained = mod.explainGroup(source, selection)
   } catch (e) {
-    if (e.constructor?.name === 'GroupError') throw Object.assign(new Error(`D025 ${e.message}`), { code: 'E_UNKNOWN_NAME' })
+    if (e.constructor?.name === 'GroupError')
+      throw Object.assign(new Error(`D025 ${e.message}`), { code: 'E_UNKNOWN_NAME' })
     throw e
   }
   const sel = explained.selection
-  const sites = g.used.filter(u => !u.part && Object.entries(sel.axes).every(([a, v]) => !u.axes[a] || u.axes[a] === 'dynamic' || u.axes[a].includes(v)))
+  const sites = g.used.filter(
+    (u) =>
+      !u.part &&
+      Object.entries(sel.axes).every(
+        ([a, v]) => !u.axes[a] || u.axes[a] === 'dynamic' || u.axes[a].includes(v),
+      ),
+  )
   return {
     group: t.group,
     doc: g.doc,
@@ -213,33 +165,51 @@ export function explainTarget({ matrix, scan, mod }, target, extra = {}) {
     css: explained.css,
     sites,
     accents: g.accents,
-    similar: matrix.similar.filter(s => s[0] === t.group || s[1] === t.group),
+    similar: matrix.similar.filter((s) => s[0] === t.group || s[1] === t.group),
   }
 }
 
 /** What the selection looks like in the DOM, as a person would find it in devtools. */
 function attributesOf(group, sel, part) {
-  const root = [`data-g="${group}"`, ...Object.entries(sel.axes).map(([a, v]) => `data-${a}="${v}"`), ...sel.states.map(s => (ARIA.has(s) ? `aria-${s}="true"` : `data-${s}`))]
-  const accent = Object.entries(sel.accent).sort(([a], [b]) => (a < b ? -1 : 1)).map(([k, v]) => `${k}:${v}`).join(' ')
+  const root = [
+    `data-g="${group}"`,
+    ...Object.entries(sel.axes).map(([a, v]) => `data-${a}="${v}"`),
+    ...sel.states.map((s) => (ARIA.has(s) ? `aria-${s}="true"` : `data-${s}`)),
+  ]
+  const accent = Object.entries(sel.accent)
+    .sort(([a], [b]) => (a < b ? -1 : 1))
+    .map(([k, v]) => `${k}:${v}`)
+    .join(' ')
   if (accent) root.push(`data-accent="${accent}"`)
   return { root: root.join(' '), ...(part ? { part: `data-part="${part}"` } : {}) }
 }
 
 export function formatFind(r) {
-  if (!r.groups.length) return `no group fits "${r.query}" (${r.total} groups). Define one with group() from @weft-js/core/style; \`weft docs style\` has the rules.`
-  const lines = r.groups.map(g => {
-    const axes = Object.entries(g.axes).map(([a, v]) => `${a}: ${Array.isArray(v) ? v.join('|') : v}`).join(' · ')
+  if (!r.groups.length)
+    return `no group fits "${r.query}" (${r.total} groups). Define one with group() from @weft-js/core/style; \`weft docs style\` has the rules.`
+  const lines = r.groups.map((g) => {
+    const axes = Object.entries(g.axes)
+      .map(([a, v]) => `${a}: ${Array.isArray(v) ? v.join('|') : v}`)
+      .join(' · ')
     return `${g.name.padEnd(18)} ${g.file}${g.doc ? `\n    ${g.doc}` : ''}\n    ${[axes, g.parts.length ? `parts: ${g.parts.join(', ')}` : '', g.states.length ? `states: ${g.states.join(', ')}` : '', `${g.uses} uses`].filter(Boolean).join(' · ')}`
   })
-  return (r.partial ? `no group matches every word of "${r.query}"; closest:\n` : '') + lines.join('\n')
+  return (
+    (r.partial ? `no group matches every word of "${r.query}"; closest:\n` : '') + lines.join('\n')
+  )
 }
 
 export function formatExplain(r) {
-  const out = [`${r.group}  ${r.file}${r.doc ? `  — ${r.doc}` : ''}`, `  <el ${r.attributes.root}>${r.attributes.part ? `  part: <el ${r.attributes.part}>` : ''}`]
+  const out = [
+    `${r.group}  ${r.file}${r.doc ? `  — ${r.doc}` : ''}`,
+    `  <el ${r.attributes.root}>${r.attributes.part ? `  part: <el ${r.attributes.part}>` : ''}`,
+  ]
   for (const el of r.elements) {
     if (!el.decls.length) continue
     out.push(`  ${el.element}:`)
-    for (const d of el.decls) out.push(`    ${d.overridden ? '~' : ' '} ${`${d.prop}: ${d.value}`.padEnd(64)} ← ${d.from} (${d.at})${d.overridden ? ', overridden' : ''}`)
+    for (const d of el.decls)
+      out.push(
+        `    ${d.overridden ? '~' : ' '} ${`${d.prop}: ${d.value}`.padEnd(64)} ← ${d.from} (${d.at})${d.overridden ? ', overridden' : ''}`,
+      )
   }
   out.push('', r.css.trimEnd())
   if (r.contextTone) out.push('', 'Reads its tone from the nearest data-tone (warp context tone).')
@@ -271,15 +241,35 @@ export function classSoup(files) {
       const classes = value.split(/\s+/).filter(Boolean)
       if (!classes.length) continue
       const before = text.slice(0, m.index)
-      const component = [...before.matchAll(/(?:function\s+([A-Z]\w*)|(?:const|let)\s+([A-Z]\w*)\s*=)/g)].at(-1)
+      const component = [
+        ...before.matchAll(/(?:function\s+([A-Z]\w*)|(?:const|let)\s+([A-Z]\w*)\s*=)/g),
+      ].at(-1)
       const tag = [...before.matchAll(/<([a-z][\w-]*)\b/g)].at(-1)?.[1] ?? 'div'
-      const base = component ? (component[1] ?? component[2]).replace(/([a-z0-9])([A-Z])/g, '$1-$2').toLowerCase() : rel.replace(/^.*\//, '').replace(/\.\w+$/, '').toLowerCase()
+      const base = component
+        ? (component[1] ?? component[2]).replace(/([a-z0-9])([A-Z])/g, '$1-$2').toLowerCase()
+        : rel
+            .replace(/^.*\//, '')
+            .replace(/\.\w+$/, '')
+            .toLowerCase()
       const n = (named.get(base) ?? 0) + 1
       named.set(base, n)
       const name = n === 1 ? base : `${base}-${tag}`
-      const at = { span: pos.span(m.index, m.index + m[0].length), offset: [m.index, m.index + m[0].length] }
+      const at = {
+        span: pos.span(m.index, m.index + m[0].length),
+        offset: [m.index, m.index + m[0].length],
+      }
       const site = { rel, at, name, count: classes.length }
-      if (classes.length > 8) out.push(diagnostic({ code: 'D020', severity: 'warning', file: rel, ...at, why: `<${tag}> carries ${classes.length} classes: nobody can read what it is or which variation it's in.`, help: groupHelp(name) }))
+      if (classes.length > 8)
+        out.push(
+          diagnostic({
+            code: 'D020',
+            severity: 'warning',
+            file: rel,
+            ...at,
+            why: `<${tag}> carries ${classes.length} classes: nobody can read what it is or which variation it's in.`,
+            help: groupHelp(name),
+          }),
+        )
       if (classes.length >= 4) {
         const key = [...classes].sort().join(' ')
         lists.set(key, [...(lists.get(key) ?? []), site])
@@ -290,31 +280,47 @@ export function classSoup(files) {
     if (sites.length < 2) continue
     for (const s of sites.slice(1)) {
       const first = sites[0]
-      out.push(diagnostic({
-        code: 'D020', severity: 'warning', file: s.rel, ...s.at,
-        why: `The same ${s.count} classes are written in ${sites.length} places (first at ${first.rel}:${first.at.span[0]}): one look, copied by hand.`,
-        help: groupHelp(first.name),
-        related: sites.filter(x => x !== s).map(x => ({ file: x.rel, span: x.at.span })),
-      }))
+      out.push(
+        diagnostic({
+          code: 'D020',
+          severity: 'warning',
+          file: s.rel,
+          ...s.at,
+          why: `The same ${s.count} classes are written in ${sites.length} places (first at ${first.rel}:${first.at.span[0]}): one look, copied by hand.`,
+          help: groupHelp(first.name),
+          related: sites.filter((x) => x !== s).map((x) => ({ file: x.rel, span: x.at.span })),
+        }),
+      )
     }
   }
   return out
 }
 
-const groupHelp = name => `Extract a group: \`export const ${name.replace(/-(\w)/g, (_, c) => c.toUpperCase())} = group('${name}', { base: { … } })\` and spread it (\`{...${name.replace(/-(\w)/g, (_, c) => c.toUpperCase())}()}\`). \`weft style find\` first: one may already fit.`
+const groupHelp = (name) =>
+  `Extract a group: \`export const ${name.replace(/-(\w)/g, (_, c) => c.toUpperCase())} = group('${name}', { base: { … } })\` and spread it (\`{...${name.replace(/-(\w)/g, (_, c) => c.toUpperCase())}()}\`). \`weft style find\` first: one may already fit.`
 
 /** Matrix diagnostics (D021–D025) as `weft check` diagnostics, located on the group or the site. */
 export function matrixDiagnostics(root, matrix) {
   const texts = new Map()
-  const text = file => {
-    if (!texts.has(file)) texts.set(file, existsSync(join(root, file)) ? readFileSync(join(root, file), 'utf8') : '')
+  const text = (file) => {
+    if (!texts.has(file))
+      texts.set(file, existsSync(join(root, file)) ? readFileSync(join(root, file), 'utf8') : '')
     return texts.get(file)
   }
-  return matrix.diagnostics.map(d => {
+  return matrix.diagnostics.map((d) => {
     const lines = text(d.file).split('\n')
     const line = Math.max(1, Math.min(d.line, lines.length))
     const col = (lines[line - 1]?.search(/\S/) ?? 0) + 1
-    const loc = d.line ? { span: [line, col, line, (lines[line - 1]?.length ?? 0) + 1] } : locate(text(d.file), d.group)
-    return diagnostic({ code: d.code, severity: d.severity, file: d.file, ...loc, why: d.message, help: d.help })
+    const loc = d.line
+      ? { span: [line, col, line, (lines[line - 1]?.length ?? 0) + 1] }
+      : locate(text(d.file), d.group)
+    return diagnostic({
+      code: d.code,
+      severity: d.severity,
+      file: d.file,
+      ...loc,
+      why: d.message,
+      help: d.help,
+    })
   })
 }