@columenlabs/lumen-ship 0.1.153 → 0.1.154

package/README.md

@@ -100,9 +100,10 @@ lumen-ship check kit-neutral [paths]   # no name from LUMEN_FORBIDDEN_NAMES (def
 lumen-ship check suppressions          # a useExhaustiveDependencies suppression needs a reason of 3+ words
 lumen-ship check settings-copy         # a Settings section description is one plain line of 64 characters or less
 lumen-ship check magic-numbers         # hard-coded px/rem class values may only go down
+lumen-ship check parts <folders>       # the kit's part pages: hint-text, text-action, raw-overlay may only go down
 ```
 
-Run each from a package folder in its `lint` script. `magic-numbers` reads the repo's `scripts/magic-numbers.baseline` (or `LUMEN_SHIP_BASELINE`): one `<folder> <count>` a line, lowered in the change that removes one.
+Run each from a package folder in its `lint` script; run `parts` from the repo root with the app folders (`lumen-ship check parts apps/*/web/src`). `magic-numbers` reads the repo's `scripts/magic-numbers.baseline` (or `LUMEN_SHIP_BASELINE`): one `<folder> <count>` a line, lowered in the change that removes one. `parts` reads `scripts/parts.baseline` (or `LUMEN_SHIP_PARTS_BASELINE`): one `<folder> <rule> <count>` a line; `--write-baseline` writes today's counts on a first run. Each rule is explained, with what to write instead, at https://lumen.columenlabs.com/parts/README.md.
 
 ## Versions
 

package/bin/lumen-ship

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 # lumen-ship: releases and lint guards shared by every app. Run from the repo root.
 #   lumen-ship release [patch | minor | notes | tag v<version>]   see scripts/release.sh
-#   lumen-ship check suppressions | settings-copy | magic-numbers | kit-neutral [paths]
+#   lumen-ship check suppressions | settings-copy | magic-numbers | kit-neutral | parts [paths]
 set -euo pipefail
 here=$(cd "$(dirname "$(readlink -f "$0")")/../scripts" && pwd)
 cmd=${1:-}
@@ -12,9 +12,9 @@ case "$cmd" in
     name=${1:-}
     shift || true
     case "$name" in
-      suppressions | settings-copy | magic-numbers | kit-neutral) exec "$here/check-$name.sh" "$@" ;;
+      suppressions | settings-copy | magic-numbers | kit-neutral | parts) exec "$here/check-$name.sh" "$@" ;;
     esac
-    echo "usage: lumen-ship check suppressions | settings-copy | magic-numbers | kit-neutral" >&2
+    echo "usage: lumen-ship check suppressions | settings-copy | magic-numbers | kit-neutral | parts" >&2
     exit 1
     ;;
 esac

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@columenlabs/lumen-ship",
-  "version": "0.1.153",
+  "version": "0.1.154",
   "description": "Lumen's shipping kit: release notes, the What's new changelog and lint guards.",
   "license": "MIT",
   "type": "module",

package/scripts/check-parts.sh

@@ -0,0 +1,67 @@
+#!/usr/bin/env bash
+# The kit's part pages (docs/parts in the Lumen repo) hold in an app: each rule below counts its
+# breaks per folder, and a count may only fall. The repo's scripts/parts.baseline (or
+# LUMEN_SHIP_PARTS_BASELINE) holds today's counts, one `<folder> <rule> <count>` a line; lower a
+# count in the change that removes a break. `--write-baseline` writes the counts as they are now,
+# for a first run. Run from the repo root with the app folders: lumen-ship check parts apps/*/web/src
+#   hint-text    a grey line under a field or title: <p className="... text-xs ... text-muted-foreground ...">
+#   text-action  a <Button> whose text is an action: an IconButton (or SaveButton) instead
+#   raw-overlay  an import of the kit's raw ui/sheet, ui/dialog, ui/select, ui/command or ui/combobox
+set -euo pipefail
+write=0
+if [ "${1:-}" = "--write-baseline" ]; then
+  write=1
+  shift
+fi
+if [ $# -eq 0 ]; then
+  echo "usage: lumen-ship check parts [--write-baseline] <folder>..." >&2
+  exit 1
+fi
+baseline=${LUMEN_SHIP_PARTS_BASELINE:-$(git rev-parse --show-toplevel)/scripts/parts.baseline}
+rules="hint-text text-action raw-overlay"
+
+# Prints `file:line` for each break of one rule in one folder.
+hits() {
+  local rule=$1 dir=$2
+  find "$dir" -type f -name '*.tsx' -not -path '*/node_modules/*' -print0 \
+    | xargs -0 -r perl -0777 -ne '
+      my $rule = "'"$rule"'";
+      my $re;
+      if ($rule eq "hint-text") {
+        $re = qr/<p\s[^>]*className="(?=[^"]*\btext-xs\b)(?=[^"]*\btext-muted-foreground\b)[^"]*"/;
+      } elsif ($rule eq "text-action") {
+        $re = qr/<Button\b[^>]*>\s*(?:<[A-Z]\w*[^>]*\/>\s*)?(?:\{[^}]*\?\s*)?\x27?(?:Save|Run|Test|Send|Sync|Refresh|Copy|Edit|Delete|Remove|Retry|Reset)\b/;
+      } else {
+        $re = qr/from\s+[\x27"]\@columenlabs\/lumen-ui\/ui\/(?:sheet|dialog|select|command|combobox)[\x27"]/;
+      }
+      while (/$re/g) {
+        my $line = 1 + (substr($_, 0, $-[0]) =~ tr/\n//);
+        print "$ARGV:$line\n";
+      }'
+}
+
+failed=0
+out=""
+for dir in "$@"; do
+  [ -d "$dir" ] || continue
+  for rule in $rules; do
+    list=$(hits "$rule" "$dir")
+    n=$(printf '%s' "$list" | grep -c . || true)
+    if [ "$write" = 1 ]; then
+      out+="$dir $rule $n"$'\n'
+      continue
+    fi
+    base=$( [ -f "$baseline" ] && awk -v d="$dir" -v r="$rule" '$1 == d && $2 == r { print $3 }' "$baseline" || true)
+    base=${base:-0}
+    if [ "$n" -gt "$base" ]; then
+      failed=1
+      echo "$dir: $n $rule, baseline $base (see docs/parts/README.md in the Lumen repo):" >&2
+      printf '%s\n' "$list" >&2
+    fi
+  done
+done
+if [ "$write" = 1 ]; then
+  printf '%s' "$out" | awk '$3 > 0' > "$baseline"
+  echo "wrote $baseline" >&2
+fi
+exit "$failed"