@unframed/cli 0.2.0 → 0.4.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 +9 -0
- package/dist/cli.js +7 -1
- package/dist/cli.js.map +1 -1
- package/dist/commands/skill.js +34 -0
- package/dist/commands/skill.js.map +1 -0
- package/package.json +6 -4
- package/registry.json +118 -11
- package/skill/unframed/SKILL.md +58 -0
- package/skill/unframed/references/components.md +1830 -0
- package/skill/unframed/references/frameworks.md +383 -0
- package/skill/unframed/references/theming.md +41 -0
package/README.md
CHANGED
|
@@ -14,6 +14,15 @@ npx @unframed/cli diff dialog # compare your copy with upstream
|
|
|
14
14
|
|
|
15
15
|
Files go to `src/components/uf-ui/` by default, in TypeScript or JavaScript. Edited files are never overwritten unless you pass `--overwrite`.
|
|
16
16
|
|
|
17
|
+
## For AI assistants
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npx @unframed/cli skill # .claude/skills/unframed (Claude Code)
|
|
21
|
+
npx @unframed/cli skill --dir .agents/skills # any assistant that reads Agent Skills
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Installs an [Agent Skill](https://agentskills.io): a `SKILL.md` with the rules for using Unframed, plus references with every component's API and examples, for this exact version. Run it again after upgrading.
|
|
25
|
+
|
|
17
26
|
**[Documentation](https://p-db.github.io/unframed-ui/)** · **[Storybook](https://p-db.github.io/unframed-ui/storybook/)** · **[GitHub](https://github.com/P-DB/unframed-ui)**
|
|
18
27
|
|
|
19
28
|
MIT licensed. Status: 0.x, APIs may change before 1.0.
|
package/dist/cli.js
CHANGED
|
@@ -4,6 +4,7 @@ import { add } from './commands/add.js';
|
|
|
4
4
|
import { diff } from './commands/diff.js';
|
|
5
5
|
import { init } from './commands/init.js';
|
|
6
6
|
import { list } from './commands/list.js';
|
|
7
|
+
import { skill } from './commands/skill.js';
|
|
7
8
|
import { color } from './lib/io.js';
|
|
8
9
|
const help = `${color.bold('unframed')}: copy Unframed components into your project, and own them.
|
|
9
10
|
|
|
@@ -16,15 +17,18 @@ ${color.bold('Commands')}
|
|
|
16
17
|
add tokens Copy tokens.css into your project
|
|
17
18
|
list Show all components and which ones you've added
|
|
18
19
|
diff [names...] Compare your copies with this version of Unframed
|
|
20
|
+
skill Teach your AI assistant Unframed: installs an agent skill
|
|
21
|
+
(SKILL.md) with this version's components and API
|
|
19
22
|
|
|
20
23
|
${color.bold('Options')}
|
|
21
24
|
--dir <path> init: components folder (default src/components/uf-ui)
|
|
25
|
+
skill: your assistant's skills folder (default .claude/skills)
|
|
22
26
|
--lang <ts|js> init: TypeScript or JavaScript files
|
|
23
27
|
--tokens <package|copy>
|
|
24
28
|
init: use @unframed/tokens, or copy tokens.css
|
|
25
29
|
--no-install init: print the install command instead of running it
|
|
26
30
|
--all add: every component
|
|
27
|
-
--overwrite add: replace files that differ, without asking
|
|
31
|
+
--overwrite add, skill: replace files that differ, without asking
|
|
28
32
|
-y, --yes Accept defaults; never prompt
|
|
29
33
|
-v, --version Print the version
|
|
30
34
|
-h, --help Print this help
|
|
@@ -91,6 +95,8 @@ export async function run(argv, io) {
|
|
|
91
95
|
return list(session);
|
|
92
96
|
case 'diff':
|
|
93
97
|
return diff(session, names);
|
|
98
|
+
case 'skill':
|
|
99
|
+
return await skill(session, { dir: values.dir, overwrite: values.overwrite });
|
|
94
100
|
default:
|
|
95
101
|
io.err(color.red(`Unknown command "${command}".`));
|
|
96
102
|
io.out(help);
|
package/dist/cli.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AACxC,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAC1C,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAC1C,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAC1C,OAAO,EAAE,KAAK,EAAW,MAAM,aAAa,CAAC;AAG7C,MAAM,IAAI,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC;;EAEpC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC;;;EAGnB,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC
|
|
1
|
+
{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AACxC,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAC1C,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAC1C,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAC1C,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAC5C,OAAO,EAAE,KAAK,EAAW,MAAM,aAAa,CAAC;AAG7C,MAAM,IAAI,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC;;EAEpC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC;;;EAGnB,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC;;;;;;;;;EAStB,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC;;;;;;;;;;;;CAYtB,CAAC;AAEF,SAAS,UAAU;IACjB,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,GAAG,CAAC,iBAAiB,EAAE,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;AAC/F,CAAC;AAED,8CAA8C;AAC9C,MAAM,CAAC,KAAK,UAAU,GAAG,CAAC,IAAc,EAAE,EAAM;IAC9C,IAAI,MAAM,CAAC;IACX,IAAI,CAAC;QACH,MAAM,GAAG,SAAS,CAAC;YACjB,IAAI,EAAE,IAAI;YACV,gBAAgB,EAAE,IAAI;YACtB,OAAO,EAAE;gBACP,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBACvB,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBACxB,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBAC1B,YAAY,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE;gBACjD,GAAG,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE;gBACxC,SAAS,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE;gBAC9C,GAAG,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE;gBACpD,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE;gBACxD,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE;aACtD;SACF,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAE,KAAe,CAAC,OAAO,CAAC,CAAC,CAAC;QAC5C,EAAE,CAAC,GAAG,CAAC,kCAAkC,CAAC,CAAC;QAC3C,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;IACvC,MAAM,CAAC,OAAO,EAAE,GAAG,KAAK,CAAC,GAAG,WAAW,CAAC;IACxC,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,EAAE,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;QACrB,OAAO,CAAC,CAAC;IACX,CAAC;IACD,IAAI,MAAM,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QAC5B,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACb,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,OAAO,GAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAEpE,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;QAChE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC,CAAC;QAClD,OAAO,CAAC,CAAC;IACX,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;QAC7E,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAC,CAAC;QAC3D,OAAO,CAAC,CAAC;IACX,CAAC;IAED,IAAI,CAAC;QACH,QAAQ,OAAO,EAAE,CAAC;YAChB,KAAK,MAAM;gBACT,OAAO,MAAM,IAAI,CAAC,OAAO,EAAE;oBACzB,GAAG,EAAE,MAAM,CAAC,GAAG;oBACf,QAAQ,EAAE,MAAM,CAAC,IAA4B;oBAC7C,MAAM,EAAE,MAAM,CAAC,MAAwC;oBACvD,OAAO,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC;iBAC/B,CAAC,CAAC;YACL,KAAK,KAAK;gBACR,OAAO,MAAM,GAAG,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;YACrF,KAAK,MAAM;gBACT,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;YACvB,KAAK,MAAM;gBACT,OAAO,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAC9B,KAAK,OAAO;gBACV,OAAO,MAAM,KAAK,CAAC,OAAO,EAAE,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;YAChF;gBACE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,oBAAoB,OAAO,IAAI,CAAC,CAAC,CAAC;gBACnD,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBACb,OAAO,CAAC,CAAC;QACb,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAE,KAAe,CAAC,OAAO,CAAC,CAAC,CAAC;QAC5C,OAAO,CAAC,CAAC;IACX,CAAC;AACH,CAAC"}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import { readdirSync, readFileSync } from 'node:fs';
|
|
2
|
+
import { join, relative } from 'node:path';
|
|
3
|
+
import { fileURLToPath } from 'node:url';
|
|
4
|
+
import { writeFile } from '../lib/files.js';
|
|
5
|
+
import { color } from '../lib/io.js';
|
|
6
|
+
/** Claude Code reads project skills from here; other assistants use their own folder (--dir). */
|
|
7
|
+
export const DEFAULT_SKILLS_DIR = '.claude/skills';
|
|
8
|
+
const source = fileURLToPath(new URL('../../skill/unframed/', import.meta.url));
|
|
9
|
+
/** Every file of the bundled skill, relative to its folder. */
|
|
10
|
+
function skillFiles(dir = source) {
|
|
11
|
+
return readdirSync(dir, { withFileTypes: true }).flatMap((entry) => entry.isDirectory() ? skillFiles(join(dir, entry.name)) : [relative(source, join(dir, entry.name))]);
|
|
12
|
+
}
|
|
13
|
+
/** Installs the Unframed agent skill (SKILL.md and its references) into the project. */
|
|
14
|
+
export async function skill(io, options) {
|
|
15
|
+
const target = join(io.cwd, options.dir ?? DEFAULT_SKILLS_DIR, 'unframed');
|
|
16
|
+
const files = skillFiles().map((file) => ({
|
|
17
|
+
src: file,
|
|
18
|
+
dest: join(target, file),
|
|
19
|
+
content: readFileSync(join(source, file), 'utf8'),
|
|
20
|
+
}));
|
|
21
|
+
io.out(`Installing the Unframed skill in ${relative(io.cwd, target) || '.'}`);
|
|
22
|
+
const results = [];
|
|
23
|
+
for (const file of files) {
|
|
24
|
+
const result = await writeFile(io, file, options.overwrite);
|
|
25
|
+
results.push(result);
|
|
26
|
+
if (result === 'created' || result === 'updated')
|
|
27
|
+
io.out(` ${color.green(result === 'created' ? '+' : '~')} ${relative(io.cwd, file.dest)}`);
|
|
28
|
+
}
|
|
29
|
+
io.out(`\n${color.green('✔')} Done. Your assistant now knows this version's components, their API and how to use them in your framework.` +
|
|
30
|
+
(options.dir ? '' : color.dim(`\n Claude Code reads ${DEFAULT_SKILLS_DIR}. For other assistants, pass their skills folder: --dir .agents/skills`)) +
|
|
31
|
+
color.dim('\n Run it again after upgrading Unframed to update the skill.'));
|
|
32
|
+
return results.includes('skipped') ? 2 : 0;
|
|
33
|
+
}
|
|
34
|
+
//# sourceMappingURL=skill.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"skill.js","sourceRoot":"","sources":["../../src/commands/skill.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACpD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,SAAS,EAAsC,MAAM,iBAAiB,CAAC;AAChF,OAAO,EAAE,KAAK,EAAW,MAAM,cAAc,CAAC;AAQ9C,iGAAiG;AACjG,MAAM,CAAC,MAAM,kBAAkB,GAAG,gBAAgB,CAAC;AAEnD,MAAM,MAAM,GAAG,aAAa,CAAC,IAAI,GAAG,CAAC,uBAAuB,EAAE,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAEhF,+DAA+D;AAC/D,SAAS,UAAU,CAAC,GAAG,GAAG,MAAM;IAC9B,OAAO,WAAW,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CACjE,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CACpG,CAAC;AACJ,CAAC;AAED,wFAAwF;AACxF,MAAM,CAAC,KAAK,UAAU,KAAK,CAAC,EAAM,EAAE,OAAqB;IACvD,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,IAAI,kBAAkB,EAAE,UAAU,CAAC,CAAC;IAC3E,MAAM,KAAK,GAAkB,UAAU,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACvD,GAAG,EAAE,IAAI;QACT,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC;QACxB,OAAO,EAAE,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC;KAClD,CAAC,CAAC,CAAC;IAEJ,EAAE,CAAC,GAAG,CAAC,oCAAoC,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC;IAC9E,MAAM,OAAO,GAAkB,EAAE,CAAC;IAClC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;QAC5D,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrB,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS;YAAE,EAAE,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAChJ,CAAC;IAED,EAAE,CAAC,GAAG,CACJ,KAAK,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,6GAA6G;QAChI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,yBAAyB,kBAAkB,wEAAwE,CAAC,CAAC;QACnJ,KAAK,CAAC,GAAG,CAAC,gEAAgE,CAAC,CAC9E,CAAC;IACF,OAAO,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC7C,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@unframed/cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.4.0",
|
|
4
4
|
"description": "Copy Unframed web components into your project, and own the code.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Patrizio Di Bartolomeo",
|
|
@@ -23,13 +23,15 @@
|
|
|
23
23
|
},
|
|
24
24
|
"files": [
|
|
25
25
|
"dist",
|
|
26
|
-
"registry.json"
|
|
26
|
+
"registry.json",
|
|
27
|
+
"skill"
|
|
27
28
|
],
|
|
28
29
|
"scripts": {
|
|
29
30
|
"registry": "node scripts/build-registry.mjs",
|
|
30
|
-
"build": "npm run registry && rm -rf dist && tsc -p tsconfig.json",
|
|
31
|
+
"build": "npm run registry && npm run skill && rm -rf dist && tsc -p tsconfig.json",
|
|
31
32
|
"test": "npm run build && vitest run",
|
|
32
|
-
"typecheck": "npm run registry && tsc -p tsconfig.json --noEmit"
|
|
33
|
+
"typecheck": "npm run registry && tsc -p tsconfig.json --noEmit",
|
|
34
|
+
"skill": "node scripts/build-skill.mjs"
|
|
33
35
|
},
|
|
34
36
|
"engines": {
|
|
35
37
|
"node": ">=20"
|