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/README.md
CHANGED
|
@@ -1,3 +1,85 @@
|
|
|
1
|
-
#
|
|
1
|
+
# UIfying
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Spec-first UI consistency for AI coding agents.
|
|
4
|
+
|
|
5
|
+
UIfying scans a project, writes a project-specific UI spec, renders a UI-only preview, installs an Agent Skill, retrieves task-scoped context, and checks new UI against the approved spec.
|
|
6
|
+
|
|
7
|
+
## Requirements
|
|
8
|
+
|
|
9
|
+
- Node.js 20 or newer
|
|
10
|
+
- React 18+ or Next.js with TypeScript/TSX
|
|
11
|
+
- Tailwind CSS v3 or v4, or CSS variables
|
|
12
|
+
- Git recommended for incremental checks
|
|
13
|
+
|
|
14
|
+
## Install
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npm install -g uifying
|
|
18
|
+
uifying --version
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Or run it without a global install:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
npx uifying --help
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Quick start
|
|
28
|
+
|
|
29
|
+
From the project root:
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
uifying init
|
|
33
|
+
uifying spec preview --serve
|
|
34
|
+
uifying spec approve
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Then retrieve context and check new work:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
uifying context "add a user table with an edit dialog"
|
|
41
|
+
uifying check --base main
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Commands
|
|
45
|
+
|
|
46
|
+
| Command | Purpose |
|
|
47
|
+
|---|---|
|
|
48
|
+
| `uifying init` | Scan the project and write the draft spec, preview, and skill |
|
|
49
|
+
| `uifying spec preview [--serve]` | Regenerate or serve the UI-only preview |
|
|
50
|
+
| `uifying spec approve` | Approve the spec as the UI contract |
|
|
51
|
+
| `uifying context "<task>"` | Retrieve components, rules, and tokens for a task |
|
|
52
|
+
| `uifying check` | Check changed files against the spec |
|
|
53
|
+
| `uifying doctor` | Diagnose the local setup |
|
|
54
|
+
| `uifying status` | Print the current spec |
|
|
55
|
+
|
|
56
|
+
All commands accept `--root <dir>`. Run `uifying --help` for the full list.
|
|
57
|
+
|
|
58
|
+
## What it writes
|
|
59
|
+
|
|
60
|
+
```text
|
|
61
|
+
.uifying/
|
|
62
|
+
├── spec.json / spec.md
|
|
63
|
+
├── tokens.json / components.json / patterns.json
|
|
64
|
+
├── evidence.json / baseline.json
|
|
65
|
+
├── preview/index.html
|
|
66
|
+
└── skill/SKILL.md
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
The `.uifying/` directory is plain JSON and HTML and should be committed with the project.
|
|
70
|
+
|
|
71
|
+
## Agent Skill
|
|
72
|
+
|
|
73
|
+
The canonical skill lives in `skills/uifying/SKILL.md` in the source repository. `uifying init --agent claude` writes `.claude/skills/uifying/SKILL.md`; `--agent codex` writes a managed block in `AGENTS.md`. The project-local copy is always written to `.uifying/skill/SKILL.md`.
|
|
74
|
+
|
|
75
|
+
## Privacy
|
|
76
|
+
|
|
77
|
+
Analysis, preview, and checks run locally. No account, API key, or source upload is required.
|
|
78
|
+
|
|
79
|
+
## Status
|
|
80
|
+
|
|
81
|
+
`0.1.0` is a source preview. The checker implements six rules, Git-diff-aware checks, and JSON reports. Visual/DOM checks, prop/variant validation, and scoped exceptions are not included yet.
|
|
82
|
+
|
|
83
|
+
## License
|
|
84
|
+
|
|
85
|
+
UNLICENSED. This preview is not yet open source; contact the maintainer before redistributing.
|