uifying 0.0.0-stage → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +84 -2
- package/dist/uifying.mjs +2036 -0
- package/package.json +34 -4
- package/skills/uifying/README.md +18 -0
- package/skills/uifying/SKILL.md +49 -0
package/package.json
CHANGED
|
@@ -1,6 +1,36 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "uifying",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"
|
|
5
|
-
"
|
|
6
|
-
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Spec-first UI consistency for AI coding agents.",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"bin": {
|
|
7
|
+
"uifying": "dist/uifying.mjs"
|
|
8
|
+
},
|
|
9
|
+
"files": [
|
|
10
|
+
"dist",
|
|
11
|
+
"skills",
|
|
12
|
+
"README.md"
|
|
13
|
+
],
|
|
14
|
+
"engines": {
|
|
15
|
+
"node": ">=20"
|
|
16
|
+
},
|
|
17
|
+
"license": "UNLICENSED",
|
|
18
|
+
"homepage": "https://uifying.com",
|
|
19
|
+
"repository": {
|
|
20
|
+
"type": "git",
|
|
21
|
+
"url": "https://github.com/uifying/uifying.git"
|
|
22
|
+
},
|
|
23
|
+
"bugs": {
|
|
24
|
+
"url": "https://github.com/uifying/uifying/issues"
|
|
25
|
+
},
|
|
26
|
+
"keywords": [
|
|
27
|
+
"ui",
|
|
28
|
+
"design-system",
|
|
29
|
+
"agent",
|
|
30
|
+
"cli",
|
|
31
|
+
"spec"
|
|
32
|
+
],
|
|
33
|
+
"publishConfig": {
|
|
34
|
+
"access": "public"
|
|
35
|
+
}
|
|
36
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# UIfying Agent Skill
|
|
2
|
+
|
|
3
|
+
This folder is the canonical, standalone source of the UIfying Agent Skill.
|
|
4
|
+
|
|
5
|
+
- `SKILL.md` — the skill content installed for Claude Code, Codex, and the project-local copy.
|
|
6
|
+
- Installed paths:
|
|
7
|
+
- `.uifying/skill/SKILL.md` (always written by `uifying init`)
|
|
8
|
+
- `.claude/skills/uifying/SKILL.md` for Claude Code
|
|
9
|
+
- A managed `uifying:managed` block in `AGENTS.md` for Codex
|
|
10
|
+
- The Codex block omits the YAML frontmatter; the standalone and Claude files keep it.
|
|
11
|
+
|
|
12
|
+
## Editing
|
|
13
|
+
|
|
14
|
+
1. Edit `SKILL.md`.
|
|
15
|
+
2. Run `pnpm build:packages`. This embeds the file into the CLI bundle.
|
|
16
|
+
3. Run `pnpm test` to confirm the installed skill still has its frontmatter and commands.
|
|
17
|
+
|
|
18
|
+
The skill is intentionally static. The current spec version and status live in `.uifying/spec.json`, so the skill does not become stale after `uifying spec approve`.
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: uifying
|
|
3
|
+
description: Use when creating or changing UI in a project with a .uifying/ directory. Read the approved UI spec, retrieve task-scoped context, reuse existing components, and run the consistency checker after implementation.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
<!-- uifying:managed:start -->
|
|
7
|
+
# UIfying — UI consistency workflow
|
|
8
|
+
|
|
9
|
+
This project has UIfying installed.
|
|
10
|
+
|
|
11
|
+
**Spec files:** `.uifying/spec.json` and `.uifying/spec.md`
|
|
12
|
+
**Preview:** `.uifying/preview/index.html`
|
|
13
|
+
|
|
14
|
+
## Before any UI work
|
|
15
|
+
|
|
16
|
+
1. Read `.uifying/spec.json` and `.uifying/spec.md`.
|
|
17
|
+
2. Run `uifying status`. If the spec is not approved, do not invent a new pattern. Show the preview with `uifying spec preview --serve` and ask the user to approve it with `uifying spec approve`.
|
|
18
|
+
3. Retrieve task-scoped context:
|
|
19
|
+
|
|
20
|
+
~~~bash
|
|
21
|
+
uifying context "<task description>" --json
|
|
22
|
+
~~~
|
|
23
|
+
|
|
24
|
+
4. Reuse the returned components and import paths. Follow the returned spec IDs and tokens.
|
|
25
|
+
5. If the task needs a pattern the spec does not cover, propose a spec change and a preview update first. Do not silently deviate.
|
|
26
|
+
|
|
27
|
+
## After UI work
|
|
28
|
+
|
|
29
|
+
1. Run the checker:
|
|
30
|
+
|
|
31
|
+
~~~bash
|
|
32
|
+
uifying check --base <base-branch>
|
|
33
|
+
~~~
|
|
34
|
+
|
|
35
|
+
2. Fix findings that have clear evidence. Do not delete or weaken a rule to make the check pass.
|
|
36
|
+
3. Re-run the checker after fixes. Report remaining ambiguous findings to the user.
|
|
37
|
+
4. Do not modify unrelated pages, global tokens, or the spec baseline without explicit approval.
|
|
38
|
+
|
|
39
|
+
## Source of truth
|
|
40
|
+
|
|
41
|
+
- The approved spec wins over current code for new UI.
|
|
42
|
+
- Current code is evidence, not the destination.
|
|
43
|
+
- The checker cites spec IDs, file paths, lines, and evidence.
|
|
44
|
+
- No source upload and no account are required.
|
|
45
|
+
|
|
46
|
+
## When a command is unavailable
|
|
47
|
+
|
|
48
|
+
Read `.uifying/spec.json` directly, follow its items and tokens, and report that the CLI could not be run. Do not guess the approved pattern.
|
|
49
|
+
<!-- uifying:managed:end -->
|