Files
pbakaus_impeccable/skill/scripts/context-signals.mjs
T
3e38e595c7 Add platform axis (web / ios / android / adaptive) (#269)
* Add a platform axis (web / ios / android / adaptive) to the skill

Orthogonal to register: register decides whether design IS or SERVES the
product; platform decides the delivery target and which native conventions
apply. Set `## Platform` in PRODUCT.md; a missing field defaults to `web`,
so legacy projects are unaffected.

- extractPlatform() in skill/scripts/context.mjs (mirrors extractRegister);
  the CLI appends a NEXT STEP directive to read the native reference(s).
  `adaptive` (Flutter / RN / KMP shipping both iOS and Android) loads both
  ios.md and android.md.
- New reference/ios.md (Apple HIG distilled) and reference/android.md
  (Material 3 distilled); reference/web.md is a thin pointer. The native
  refs frame register's role as narrow: platform conformance is the bar,
  brand lives in the expressive layer the platform gives you, never by
  breaking the rails.
- Setup step 5 loads the native reference(s) when platform is native. Live
  mode and the detect CLI stay web-only, gated off ios/android/adaptive.
- init asks platform right after register; adapt/audit/animate/layout carry
  short platform divergence notes; all secondary spots thread `adaptive`.
- a11y stays in audit.md (loading it at design time makes output timid), so
  the native refs carry no Accessibility section; audit.md's Platform
  section owns native a11y.
- Tests: extractPlatform unit coverage + skill-behavior scenario 10
  (PRODUCT.md platform ios -> agent loads ios.md).

Source-first: only skill/, scripts/, tests/, CLAUDE.md, NOTICE.md, the
changelog and version are committed; the sync workflow regenerates the
provider trees and ./plugin on merge.

ios.md / android.md are distilled from the MIT-licensed
ehmo/platform-design-skills; attribution in NOTICE.md.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* Address review: gate web tools on native platforms, drop version churn

Maintainer-review fixes applied with AI assistance (Claude Code), on top
of the rebased platform-axis commit:

- Design hook (post-edit and Cursor pre-edit) now resolves the project
  platform via loadContext + extractPlatform and skips its web rule scan
  for ios / android / adaptive projects, so React Native / Flutter code
  never draws web-shaped findings (new hook-lib resolveProjectPlatform /
  isNativePlatform helpers, covered by unit and subprocess tests).
- context.mjs CLI warns on an unrecognized ## Platform value (e.g. a
  toolchain name like `flutter`) instead of silently defaulting to web;
  extractRegister / extractPlatform now share extractSectionValue.
- Removed reference/web.md: nothing loaded it; CLAUDE.md carries the
  "web has no extra rulebook" explanation.
- init.md: skip live-mode config (Step 6) for native platforms; note the
  per-app PRODUCT.md pattern for repos shipping web + native.
- android.md: Material-everywhere apps that also ship on iPhone still
  owe iOS OS guarantees (safe areas, Reduce Motion, edge-swipe back).
- ios.md: reworded a design-time line that framed Dynamic Type as an
  accessibility check (a11y stays owned by audit.md).
- Renumbered the new skill-behavior scenario to 14 after main's 10-13;
  updated CLAUDE.md scenario list; added android + unrecognized-value
  CLI test cases.
- No version or changelog changes: versioning happens at release time.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* Tighten platform reference prose

Editorial pass on the platform-axis text, applied with AI assistance
(Claude Code) under maintainer direction:

- ios.md / android.md rewritten to house style: single-line paragraphs
  (no hard wraps), one-sentence scope intro, deduplicated intro/slop-test,
  register-compression down to two sentences. In-file attribution
  paragraphs removed (NOTICE.md owns attribution); "read on top of the
  register reference" cruft removed (SKILL step 5 and the context.mjs
  directive already say it). Bans sections dropped: they restated the
  rules above them; the two additive items (tab-bar overload,
  hover-dependent affordances) folded into rules. ~40% smaller each.
- Sub-command Platform sections (adapt, audit, animate, layout), SKILL
  step 5, init.md platform prose, and the context.mjs directive trimmed
  the same way.

Build (prose validators, counts) and both test runners green.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* Treat an empty PRODUCT.md section as absent, not the next heading

Copilot review catch: extractSectionValue read the next `## ...` heading
as the section value when a field was left empty, which made the CLI
warn "value `## Product Purpose` is not recognized". Stop at the next
heading and return null instead. Regression tests for extractPlatform,
extractRegister, and the CLI warning path. Applied with AI assistance
(Claude Code) under maintainer direction.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* Only read a token list of both native targets as adaptive

Bugbot catch: after the exact platform tokens failed, any Platform line
containing the words ios and android was classified adaptive, so
negated or explanatory prose ("web only, not ios or android") silently
loaded both native refs and skipped the hook, with no warning. The
combo parse now accepts only list separators and the two platform
words; anything else falls through to the CLI's unrecognized-value
WARNING. Regression tests added. Applied with AI assistance (Claude
Code) under maintainer direction.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-authored-by: Paul Bakaus <paul.bakaus@gmail.com>
2026-07-08 17:11:31 -07:00

227 lines
7.9 KiB
JavaScript

#!/usr/bin/env node
/**
* Context-signals gatherer for the bare `{{command_prefix}}impeccable`
* (no-argument) path. Collects cheap, deterministic signals about the current
* project and emits them as JSON.
*
* It does NOT score or rank. The agent reasons over the raw signals using its
* knowledge of the command catalog (see SKILL.md routing rule 1). Deliberately
* light: no LLM calls, no detector run (`npx impeccable detect` is heavier and
* opt-in), no file writes. Every probe is best-effort and never throws; the
* output is always valid JSON.
*
* Signals:
* - setup: PRODUCT.md / DESIGN.md presence, register, whether code exists
* - critique: the latest cached critique score (.impeccable/critique)
* - git: branch + files changed vs the default branch (a scope hint)
* - devServer: whether a local dev server answers on a common port (gates live)
*/
import fs from 'node:fs';
import net from 'node:net';
import path from 'node:path';
import { fileURLToPath } from 'node:url';
import { execFileSync } from 'node:child_process';
import { loadContext, extractRegister, extractPlatform } from './context.mjs';
import { getCritiqueDir } from './lib/impeccable-paths.mjs';
/** Is there code here at all, or just context files / an empty repo? */
function hasCode(cwd) {
if (fs.existsSync(path.join(cwd, 'package.json'))) return true;
for (const d of ['src', 'app', 'pages', 'site', 'public', 'components', 'lib']) {
if (fs.existsSync(path.join(cwd, d))) return true;
}
return false;
}
/**
* The most recent critique snapshot across all targets. Filenames are
* timestamp-prefixed (`<iso>__<slug>.md`), so a lexical sort is chronological.
* Parses the small frontmatter for score + P0/P1 counts.
*/
function latestCritique(cwd) {
try {
const dir = getCritiqueDir(cwd);
if (!fs.existsSync(dir)) return null;
const files = fs.readdirSync(dir).filter((f) => f.endsWith('.md')).sort();
if (!files.length) return null;
const newest = files[files.length - 1];
const text = fs.readFileSync(path.join(dir, newest), 'utf-8');
const front = text.split('---')[1] || '';
const get = (k) => {
const m = front.match(new RegExp(`^${k}:\\s*(.+)$`, 'm'));
return m ? m[1].trim() : null;
};
const num = (v) => {
const n = Number(v);
return Number.isFinite(n) ? n : null;
};
return {
slug: get('slug'),
score: num(get('score')),
p0: num(get('p0')),
p1: num(get('p1')),
timestamp: get('timestamp'),
file: path.relative(cwd, path.join(dir, newest)),
};
} catch {
return null;
}
}
/** Branch + a scope hint: files changed vs the default branch, else working tree. */
function gitSignals(cwd) {
const run = (args, { trim = true } = {}) => {
try {
const out = execFileSync('git', args, {
cwd,
encoding: 'utf-8',
stdio: ['ignore', 'pipe', 'ignore'],
});
return trim ? out.trim() : out;
} catch {
return null;
}
};
if (run(['rev-parse', '--is-inside-work-tree']) !== 'true') {
return { isRepo: false, branch: null, base: null, changedFiles: [], changedCount: 0 };
}
const branch = run(['rev-parse', '--abbrev-ref', 'HEAD']);
let base = null;
for (const b of ['main', 'master']) {
if (run(['rev-parse', '--verify', '--quiet', b]) !== null) {
base = b;
break;
}
}
const diffBase = base && branch && branch !== base ? base : null;
const fromDiff = diffBase ? run(['diff', '--name-only', `${diffBase}...HEAD`]) : null;
// porcelain lines are `XY PATH`: a 2-char status + a space, then the path.
// Don't trim the combined output — an unstaged-modified line starts with a
// leading space (` M path`), and a global trim would eat the first line's
// status column and shift the slice. Renames render as `old -> new`.
const fromStatus = run(['-c', 'core.quotepath=false', 'status', '--porcelain'], { trim: false });
let changed = [];
if (fromDiff) {
changed = fromDiff.split('\n').filter(Boolean);
} else if (fromStatus) {
changed = fromStatus.split(/\r?\n/).filter(Boolean).map((l) => {
const p = l.slice(3);
const arrow = p.indexOf(' -> ');
return arrow === -1 ? p : p.slice(arrow + 4);
});
}
return {
isRepo: true,
branch,
base: diffBase,
changedFiles: changed.slice(0, 50),
changedCount: changed.length,
};
}
const COMMON_DEV_PORTS = [4321, 3000, 5173, 5174, 8080, 8000, 4200];
function probePort(port, timeout = 250) {
return new Promise((resolve) => {
const sock = new net.Socket();
let settled = false;
const finish = (ok) => {
if (settled) return;
settled = true;
try { sock.destroy(); } catch { /* ignore */ }
resolve(ok);
};
sock.setTimeout(timeout);
sock.once('connect', () => finish(true));
sock.once('timeout', () => finish(false));
sock.once('error', () => finish(false));
sock.connect(port, '127.0.0.1');
});
}
async function devServerSignals() {
const open = [];
await Promise.all(
COMMON_DEV_PORTS.map(async (p) => {
if (await probePort(p)) open.push(p);
}),
);
open.sort((a, b) => a - b);
return { running: open.length > 0, ports: open };
}
// Extensions the detector scans (mirrors the engine's walkDir set + HTML).
const SCANNABLE_EXT = new Set([
'.html', '.htm', '.css', '.scss',
'.jsx', '.tsx', '.js', '.ts', '.vue', '.svelte', '.astro',
]);
// Where UI source typically lives. The detector walks these and skips
// node_modules / dist / build / .next / .nuxt automatically.
const SOURCE_DIRS = ['src', 'app', 'components', 'pages', 'public'];
/**
* Local paths the agent should point the bundled detector at — never a URL.
* A URL means a costly Puppeteer browser render, and a probed dev-server port
* may not even belong to this project. An HTML *file* or a source tree is
* scanned by the cheap, jsdom-free static engine. This script does NOT run the
* detector; it just surfaces the target(s) so the agent can run
* `node <scripts>/detect.mjs --json <targets>` and fold the hits in.
*/
function scanTargets(cwd, git) {
// 1. Dirty tree wins: scan exactly the markup/style files in flight. It's
// what the user is working on, it's a small set, and it's local.
if (git.isRepo && git.changedFiles.length) {
const changed = git.changedFiles
.filter((f) => SCANNABLE_EXT.has(path.extname(f).toLowerCase()))
.filter((f) => fs.existsSync(path.join(cwd, f)));
if (changed.length) return { targets: changed.slice(0, 50), via: 'git-changes' };
}
// 2. Otherwise scan the local source dirs that exist.
const dirs = SOURCE_DIRS.filter((d) => fs.existsSync(path.join(cwd, d)));
if (dirs.length) return { targets: dirs, via: 'source-dir' };
// 3. A root HTML entry, or the project root as a last resort when there's
// code but no conventional source dir (walkDir still skips heavy dirs).
if (fs.existsSync(path.join(cwd, 'index.html'))) return { targets: ['index.html'], via: 'html' };
if (hasCode(cwd)) return { targets: ['.'], via: 'root' };
return { targets: [], via: null };
}
export async function gatherSignals(cwd = process.cwd()) {
const ctx = loadContext(cwd);
const git = gitSignals(cwd);
return {
setup: {
hasProduct: ctx.hasProduct,
productPath: ctx.productPath,
hasDesign: ctx.hasDesign,
designPath: ctx.designPath,
hasCode: hasCode(cwd),
register: extractRegister(ctx.product),
platform: extractPlatform(ctx.product),
},
critique: { latest: latestCritique(cwd) },
git,
devServer: await devServerSignals(),
scan: scanTargets(cwd, git),
};
}
async function cli() {
const signals = await gatherSignals(process.cwd());
process.stdout.write(`${JSON.stringify(signals, null, 2)}\n`);
}
function invokedAsScript() {
const arg = process.argv[1];
if (!arg) return false;
try {
return fs.realpathSync(arg) === fs.realpathSync(fileURLToPath(import.meta.url));
} catch {
return false;
}
}
if (invokedAsScript()) {
cli();
}