@yadeck/create-slide 0.1.2 → 0.1.3
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/dist/index.d.ts +12 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +76 -18
- package/dist/index.js.map +1 -1
- package/package.json +3 -2
- package/template/AGENTS.md +2 -0
- package/template/package.json +2 -2
- package/template-plugin/AGENTS.md +48 -0
- package/template-plugin/README.md +40 -0
- package/template-plugin/_gitignore +3 -0
- package/template-plugin/example/deck.yaml +7 -0
- package/template-plugin/package.json +46 -0
- package/template-plugin/slide.config.ts +12 -0
- package/template-plugin/src/index.ts +13 -0
- package/template-plugin/src/layouts.test.tsx +21 -0
- package/template-plugin/src/layouts.tsx +20 -0
- package/template-plugin/tsconfig.json +16 -0
package/dist/index.d.ts
CHANGED
|
@@ -1,3 +1,14 @@
|
|
|
1
|
-
|
|
1
|
+
/** 雛形を置いた結果。パスは作った先のディレクトリからの相対 */
|
|
2
|
+
export interface ScaffoldResult {
|
|
3
|
+
created: string[];
|
|
4
|
+
/** 同じ名前のものが既にあったので、手を付けなかったもの */
|
|
5
|
+
skipped: string[];
|
|
6
|
+
}
|
|
7
|
+
export declare function linkAgentFiles(root: string, result?: ScaffoldResult): ScaffoldResult;
|
|
8
|
+
/**
|
|
9
|
+
* dest に deck リポジトリの雛形を置く。空でないディレクトリにも足せるが、
|
|
10
|
+
* package.json が既にあると依存や scripts を合成できないので、何もせずエラーにする
|
|
11
|
+
*/
|
|
12
|
+
export declare function scaffold(dest: string, templateDir?: string): ScaffoldResult;
|
|
2
13
|
export declare function main(argv: string[]): void;
|
|
3
14
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAgBA,mCAAmC;AACnC,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,iCAAiC;IACjC,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AA2DD,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,GAAE,cAA6C,GAAG,cAAc,CAsBlH;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,SAAe,GAAG,cAAc,CASjF;AAED,wBAAgB,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAkBzC"}
|
package/dist/index.js
CHANGED
|
@@ -2,31 +2,61 @@ import * as fs from "node:fs";
|
|
|
2
2
|
import * as path from "node:path";
|
|
3
3
|
import { fileURLToPath } from "node:url";
|
|
4
4
|
const TEMPLATE_DIR = fileURLToPath(new URL("../template/", import.meta.url));
|
|
5
|
+
/** `--plugin`: プラグインのリポジトリ(Layout、見本の deck、テスト、プレビューの設定) */
|
|
6
|
+
const PLUGIN_TEMPLATE_DIR = fileURLToPath(new URL("../template-plugin/", import.meta.url));
|
|
7
|
+
const USAGE = `usage: npx @yadeck/create-slide <dir> deck のリポジトリを作る
|
|
8
|
+
npx @yadeck/create-slide --plugin <dir> プラグインのリポジトリを作る(名前は yadeck-plugin-* を推奨)`;
|
|
5
9
|
/** テンプレートでは `_` 始まりで持つ dotfile を本来の名前に戻す(npm publish で落ちるのを避ける) */
|
|
6
10
|
function targetName(name) {
|
|
7
11
|
return name.startsWith("_") ? `.${name.slice(1)}` : name;
|
|
8
12
|
}
|
|
9
|
-
|
|
13
|
+
/**
|
|
14
|
+
* テンプレートを dest に写す。既にあるファイルは上書きせず skipped に積む。
|
|
15
|
+
* 原稿やメモがあるリポジトリにも後から足せるようにするため
|
|
16
|
+
*/
|
|
17
|
+
function copyDir(src, dest, root, vars, result) {
|
|
10
18
|
fs.mkdirSync(dest, { recursive: true });
|
|
11
19
|
for (const entry of fs.readdirSync(src, { withFileTypes: true })) {
|
|
12
20
|
const from = path.join(src, entry.name);
|
|
13
21
|
const to = path.join(dest, targetName(entry.name));
|
|
14
22
|
if (entry.isDirectory()) {
|
|
15
|
-
copyDir(from, to, vars);
|
|
23
|
+
copyDir(from, to, root, vars, result);
|
|
24
|
+
continue;
|
|
25
|
+
}
|
|
26
|
+
const rel = path.relative(root, to);
|
|
27
|
+
if (fs.existsSync(to)) {
|
|
28
|
+
result.skipped.push(rel);
|
|
16
29
|
continue;
|
|
17
30
|
}
|
|
18
31
|
let content = fs.readFileSync(from, "utf8");
|
|
19
32
|
for (const [k, v] of Object.entries(vars))
|
|
20
33
|
content = content.replaceAll(`{{${k}}}`, v);
|
|
21
34
|
fs.writeFileSync(to, content);
|
|
35
|
+
result.created.push(rel);
|
|
22
36
|
}
|
|
23
37
|
}
|
|
24
38
|
/** 正本 `.agents/skills`(Codex)を Claude Code / Antigravity の置き場所からも参照できるようにする */
|
|
25
39
|
const SKILL_DIRS = [".claude/skills", ".agent/skills"];
|
|
40
|
+
/** lstat で見る(壊れたシンボリックリンクも「ある」とみなし、上書きしない) */
|
|
41
|
+
function exists(p) {
|
|
42
|
+
try {
|
|
43
|
+
fs.lstatSync(p);
|
|
44
|
+
return true;
|
|
45
|
+
}
|
|
46
|
+
catch {
|
|
47
|
+
return false;
|
|
48
|
+
}
|
|
49
|
+
}
|
|
26
50
|
/**
|
|
27
51
|
* 相対シンボリックリンクを作る。作れない環境(Windows の権限など)ではコピーに倒す。
|
|
52
|
+
* 既に同じ名前のものがあれば何もしない
|
|
28
53
|
*/
|
|
29
|
-
function linkOrCopy(target, linkPath) {
|
|
54
|
+
function linkOrCopy(target, linkPath, root, result) {
|
|
55
|
+
const rel = path.relative(root, linkPath);
|
|
56
|
+
if (exists(linkPath)) {
|
|
57
|
+
result.skipped.push(rel);
|
|
58
|
+
return;
|
|
59
|
+
}
|
|
30
60
|
fs.mkdirSync(path.dirname(linkPath), { recursive: true });
|
|
31
61
|
try {
|
|
32
62
|
fs.symlinkSync(path.relative(path.dirname(linkPath), target), linkPath, "dir");
|
|
@@ -34,36 +64,64 @@ function linkOrCopy(target, linkPath) {
|
|
|
34
64
|
catch {
|
|
35
65
|
fs.cpSync(target, linkPath, { recursive: true });
|
|
36
66
|
}
|
|
67
|
+
result.created.push(rel);
|
|
37
68
|
}
|
|
38
|
-
export function linkAgentFiles(root) {
|
|
69
|
+
export function linkAgentFiles(root, result = { created: [], skipped: [] }) {
|
|
39
70
|
const skillsRoot = path.join(root, ".agents", "skills");
|
|
40
71
|
if (fs.existsSync(skillsRoot)) {
|
|
41
72
|
for (const skill of fs.readdirSync(skillsRoot)) {
|
|
42
73
|
for (const dir of SKILL_DIRS)
|
|
43
|
-
linkOrCopy(path.join(skillsRoot, skill), path.join(root, dir, skill));
|
|
74
|
+
linkOrCopy(path.join(skillsRoot, skill), path.join(root, dir, skill), root, result);
|
|
44
75
|
}
|
|
45
76
|
}
|
|
46
77
|
const agentsMd = path.join(root, "AGENTS.md");
|
|
78
|
+
const claudeMd = path.join(root, "CLAUDE.md");
|
|
47
79
|
if (fs.existsSync(agentsMd)) {
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
fs.symlinkSync("AGENTS.md", claudeMd);
|
|
80
|
+
if (exists(claudeMd)) {
|
|
81
|
+
result.skipped.push("CLAUDE.md");
|
|
51
82
|
}
|
|
52
|
-
|
|
53
|
-
|
|
83
|
+
else {
|
|
84
|
+
try {
|
|
85
|
+
fs.symlinkSync("AGENTS.md", claudeMd);
|
|
86
|
+
}
|
|
87
|
+
catch {
|
|
88
|
+
fs.copyFileSync(agentsMd, claudeMd);
|
|
89
|
+
}
|
|
90
|
+
result.created.push("CLAUDE.md");
|
|
54
91
|
}
|
|
55
92
|
}
|
|
93
|
+
return result;
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* dest に deck リポジトリの雛形を置く。空でないディレクトリにも足せるが、
|
|
97
|
+
* package.json が既にあると依存や scripts を合成できないので、何もせずエラーにする
|
|
98
|
+
*/
|
|
99
|
+
export function scaffold(dest, templateDir = TEMPLATE_DIR) {
|
|
100
|
+
if (fs.existsSync(path.join(dest, "package.json"))) {
|
|
101
|
+
throw new Error(`${path.join(dest, "package.json")} が既にあります。YADECK の依存と scripts は手で足してください: https://onfi.github.io/yadeck/guide/getting-started`);
|
|
102
|
+
}
|
|
103
|
+
const result = { created: [], skipped: [] };
|
|
104
|
+
copyDir(templateDir, dest, dest, { name: path.basename(dest) }, result);
|
|
105
|
+
return linkAgentFiles(dest, result);
|
|
56
106
|
}
|
|
57
107
|
export function main(argv) {
|
|
58
|
-
const
|
|
59
|
-
|
|
60
|
-
|
|
108
|
+
const plugin = argv.includes("--plugin");
|
|
109
|
+
const rest = argv.filter((a) => a !== "--plugin");
|
|
110
|
+
const name = rest[0];
|
|
111
|
+
if (!name || rest.length > 1 || name.startsWith("-"))
|
|
112
|
+
throw new Error(USAGE);
|
|
61
113
|
const dest = path.resolve(process.cwd(), name);
|
|
62
|
-
|
|
63
|
-
|
|
114
|
+
const { skipped } = scaffold(dest, plugin ? PLUGIN_TEMPLATE_DIR : TEMPLATE_DIR);
|
|
115
|
+
if (skipped.length > 0) {
|
|
116
|
+
console.log(`既にあるので、そのままにしたもの:\n${skipped.map((s) => ` ${s}`).join("\n")}\n`);
|
|
117
|
+
}
|
|
118
|
+
const cd = dest === process.cwd() ? "" : ` cd ${name}\n`;
|
|
119
|
+
const next = plugin
|
|
120
|
+
? `${cd} npm install\n npm run dev # example/ の見本をプレビュー\n npm test\n`
|
|
121
|
+
: `${cd} npm install\n npm run dev\n`;
|
|
122
|
+
console.log(`created ${dest}\n\n${next}`);
|
|
123
|
+
if (plugin && !/^(@[^/]+\/)?yadeck-plugin-/.test(path.basename(dest))) {
|
|
124
|
+
console.log(" 名前は yadeck-plugin-* にすると、プラグインの一覧や npx yadeck add で見つけやすくなります\n");
|
|
64
125
|
}
|
|
65
|
-
copyDir(TEMPLATE_DIR, dest, { name: path.basename(dest) });
|
|
66
|
-
linkAgentFiles(dest);
|
|
67
|
-
console.log(`created ${dest}\n\n cd ${name}\n npm install\n npm run dev\n`);
|
|
68
126
|
}
|
|
69
127
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,MAAM,YAAY,GAAG,aAAa,CAAC,IAAI,GAAG,CAAC,cAAc,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,MAAM,YAAY,GAAG,aAAa,CAAC,IAAI,GAAG,CAAC,cAAc,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAC7E,4DAA4D;AAC5D,MAAM,mBAAmB,GAAG,aAAa,CAAC,IAAI,GAAG,CAAC,qBAAqB,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAE3F,MAAM,KAAK,GAAG;yFAC2E,CAAC;AAE1F,mEAAmE;AACnE,SAAS,UAAU,CAAC,IAAY;IAC9B,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;AAC3D,CAAC;AASD;;;GAGG;AACH,SAAS,OAAO,CAAC,GAAW,EAAE,IAAY,EAAE,IAAY,EAAE,IAA4B,EAAE,MAAsB;IAC5G,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACxC,KAAK,MAAM,KAAK,IAAI,EAAE,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;QACjE,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QACxC,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QACnD,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;YACxB,OAAO,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;YACtC,SAAS;QACX,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpC,IAAI,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC;YACtB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACzB,SAAS;QACX,CAAC;QACD,IAAI,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC5C,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;YAAE,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QACvF,EAAE,CAAC,aAAa,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAC9B,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;AACH,CAAC;AAED,+EAA+E;AAC/E,MAAM,UAAU,GAAG,CAAC,gBAAgB,EAAE,eAAe,CAAC,CAAC;AAEvD,8CAA8C;AAC9C,SAAS,MAAM,CAAC,CAAS;IACvB,IAAI,CAAC;QACH,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAChB,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,UAAU,CAAC,MAAc,EAAE,QAAgB,EAAE,IAAY,EAAE,MAAsB;IACxF,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC1C,IAAI,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QACrB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzB,OAAO;IACT,CAAC;IACD,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1D,IAAI,CAAC;QACH,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;IACjF,CAAC;IAAC,MAAM,CAAC;QACP,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACnD,CAAC;IACD,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC3B,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,IAAY,EAAE,SAAyB,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;IAChG,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;IACxD,IAAI,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAC9B,KAAK,MAAM,KAAK,IAAI,EAAE,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC;YAC/C,KAAK,MAAM,GAAG,IAAI,UAAU;gBAAE,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QACpH,CAAC;IACH,CAAC;IACD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAC9C,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAC9C,IAAI,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5B,IAAI,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YACrB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACnC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC;gBACH,EAAE,CAAC,WAAW,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;YACxC,CAAC;YAAC,MAAM,CAAC;gBACP,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YACtC,CAAC;YACD,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,QAAQ,CAAC,IAAY,EAAE,WAAW,GAAG,YAAY;IAC/D,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC;QACnD,MAAM,IAAI,KAAK,CACb,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,8FAA8F,CACjI,CAAC;IACJ,CAAC;IACD,MAAM,MAAM,GAAmB,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IAC5D,OAAO,CAAC,WAAW,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;IACxE,OAAO,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,UAAU,IAAI,CAAC,IAAc;IACjC,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IACzC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,UAAU,CAAC,CAAC;IAClD,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IACrB,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;IAC7E,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,CAAC;IAC/C,MAAM,EAAE,OAAO,EAAE,GAAG,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;IAChF,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,OAAO,CAAC,GAAG,CAAC,sBAAsB,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjF,CAAC;IACD,MAAM,EAAE,GAAG,IAAI,KAAK,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,IAAI,IAAI,CAAC;IAC1D,MAAM,IAAI,GAAG,MAAM;QACjB,CAAC,CAAC,GAAG,EAAE,qEAAqE;QAC5E,CAAC,CAAC,GAAG,EAAE,gCAAgC,CAAC;IAC1C,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,OAAO,IAAI,EAAE,CAAC,CAAC;IAC1C,IAAI,MAAM,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QACtE,OAAO,CAAC,GAAG,CAAC,mEAAmE,CAAC,CAAC;IACnF,CAAC;AACH,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@yadeck/create-slide",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.3",
|
|
4
4
|
"description": "YADECK: scaffold a deck repository (npx @yadeck/create-slide my-deck)",
|
|
5
5
|
"homepage": "https://onfi.github.io/yadeck/",
|
|
6
6
|
"repository": {
|
|
@@ -18,7 +18,8 @@
|
|
|
18
18
|
"files": [
|
|
19
19
|
"dist",
|
|
20
20
|
"bin",
|
|
21
|
-
"template"
|
|
21
|
+
"template",
|
|
22
|
+
"template-plugin"
|
|
22
23
|
],
|
|
23
24
|
"scripts": {
|
|
24
25
|
"build": "tsc -b"
|
package/template/AGENTS.md
CHANGED
|
@@ -83,7 +83,9 @@ skill `yadeck` の手順に従う。要点は次のとおり。
|
|
|
83
83
|
|
|
84
84
|
## 見せ方が足りないとき
|
|
85
85
|
|
|
86
|
+
- npm に公開されているプラグインは `npx yadeck add <パッケージ>` で入れる。`slide.config.ts` への追記と schema の更新まで行い、使えるようになった tags を表示する
|
|
86
87
|
- `src/` に Layout(React コンポーネント)を書き、`definePlugin` で tags に bind して `slide.config.ts` の `plugins` に足す。data の書き方は変わらない
|
|
88
|
+
- 他の deck でも使いたい Layout は、`npx @yadeck/create-slide --plugin yadeck-plugin-<名前>` でプラグインのリポジトリにして npm に公開する
|
|
87
89
|
- `bind` の `description` には、見た目より先に「どういう内容のページで使うか」を書く。schema に出て、エージェントが tags を選ぶ手がかりになる
|
|
88
90
|
- 意図して枠の外へ出す装飾には `aria-hidden="true"` を付ける(`check` の対象から外れる)
|
|
89
91
|
- チャートや three.js など、npm の React コンポーネントもそのまま import して使える。ブラウザで動かす必要があるものは `bind` に `client: true` を付ける
|
package/template/package.json
CHANGED
|
@@ -11,8 +11,8 @@
|
|
|
11
11
|
"png": "yadeck png"
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@yadeck/slide-components-basic": "^0.1.
|
|
15
|
-
"@yadeck/slide-core": "^0.1.
|
|
14
|
+
"@yadeck/slide-components-basic": "^0.1.3",
|
|
15
|
+
"@yadeck/slide-core": "^0.1.3",
|
|
16
16
|
"react": "^19.3.0",
|
|
17
17
|
"react-dom": "^19.3.0",
|
|
18
18
|
"zod": "^4.6.0"
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# AGENTS.md
|
|
2
|
+
|
|
3
|
+
このリポジトリは YADECK のプラグインです。YADECK は、data(YAML)に「何を伝えるか」だけを書き、見た目は view(React の Layout)が決めるスライドジェネレータです。プラグインは Layout を tags に bind して、deck に新しい見せ方を足します。
|
|
4
|
+
|
|
5
|
+
- ドキュメント: https://onfi.github.io/yadeck/guide/plugin
|
|
6
|
+
|
|
7
|
+
## 構成
|
|
8
|
+
|
|
9
|
+
| パス | 中身 |
|
|
10
|
+
|---|---|
|
|
11
|
+
| `src/index.ts` | `definePlugin` で Layout を tags に bind し、default export する |
|
|
12
|
+
| `src/layouts.tsx` | Layout(React コンポーネント)と、その data の型(zod) |
|
|
13
|
+
| `src/*.test.tsx` | Layout のテスト(vitest) |
|
|
14
|
+
| `example/deck.yaml` | 見本の deck。bind した tags をひととおり使う。npm に同梱し、プラグインの一覧のサムネイルにも使う |
|
|
15
|
+
| `slide.config.ts` | 見本をプレビューするための設定。公開はしない |
|
|
16
|
+
|
|
17
|
+
## コマンド
|
|
18
|
+
|
|
19
|
+
| コマンド | 使いどころ |
|
|
20
|
+
|---|---|
|
|
21
|
+
| `npm run dev` | 見本のプレビュー(http://localhost:3000/)。`src/` を変えると再読み込み |
|
|
22
|
+
| `npm test` | Layout を変えたら必ず |
|
|
23
|
+
| `npm run check` | 見本のはみ出し・切れ・コードの縮みを検査する。error は直す |
|
|
24
|
+
| `npm run png` | 見本を `.slide/preview/png/` に書き出す。見た目を確かめるときは PNG を読む |
|
|
25
|
+
| `npm run build` | `dist/` に出力する |
|
|
26
|
+
|
|
27
|
+
## Layout を書くときの約束
|
|
28
|
+
|
|
29
|
+
- **data に見た目を持たせない。** 型(zod)に色・位置・大きさのフィールドを足さない。何を伝えるかだけを書かせる
|
|
30
|
+
- **型のフィールドには `.describe()` を付ける。** schema に出て、deck を書く AI が読む
|
|
31
|
+
- **`bind` の `description` は「どういう内容のページで使うか」から書く。** AI が tags を選ぶ手がかりになる。見た目の説明は後ろに
|
|
32
|
+
- **色や文字の大きさはテーマのトークンを使う。** `bg-primary`、`text-surface`、`text-display` など。deck のテーマに従わせる
|
|
33
|
+
- **items は `<Block>` で描く。** 発表者ノート(`note`)も items に入っていて、`<Block>` で描くと発表者モードに出る
|
|
34
|
+
- **意図して枠の外へ出す装飾には `aria-hidden="true"` を付ける。** `check` の対象から外れる
|
|
35
|
+
- **ブラウザで動かす必要があるもの(WebGL、チャートのアニメーションなど)は、`bind` に `client: true` を付ける**
|
|
36
|
+
|
|
37
|
+
## 足したら
|
|
38
|
+
|
|
39
|
+
1. `src/index.ts` で bind する
|
|
40
|
+
2. `example/deck.yaml` に、その tags を使ったページを足す
|
|
41
|
+
3. `npm test` と `npm run check` を通す
|
|
42
|
+
4. `npm run png` で書き出した PNG を見て、見た目を確かめる
|
|
43
|
+
|
|
44
|
+
## 公開の決まり
|
|
45
|
+
|
|
46
|
+
- `package.json` の `keywords` に `yadeck-plugin` を入れたままにする(プラグインの一覧はこれで集める)
|
|
47
|
+
- 名前は `yadeck-plugin-*` か `@scope/yadeck-plugin-*`
|
|
48
|
+
- `@yadeck/slide-core`、`react`、`zod` は peerDependencies
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# {{name}}
|
|
2
|
+
|
|
3
|
+
[YADECK](https://onfi.github.io/yadeck/) のプラグイン。
|
|
4
|
+
|
|
5
|
+
## 使う
|
|
6
|
+
|
|
7
|
+
deck のリポジトリで:
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
npx yadeck add {{name}}
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
`slide.config.ts` の `plugins` に足され、使える tags が schema に入ります。
|
|
14
|
+
|
|
15
|
+
## 開発する
|
|
16
|
+
|
|
17
|
+
```sh
|
|
18
|
+
npm install
|
|
19
|
+
npx playwright install chromium # check / png を使うとき
|
|
20
|
+
npm run dev # example/ の見本をプレビュー(src を変えると再読み込み)
|
|
21
|
+
npm test # Layout のテスト
|
|
22
|
+
npm run check # 見本のはみ出し・切れを検査
|
|
23
|
+
npm run png # 見本を .slide/preview/png/ に書き出す
|
|
24
|
+
npm run build # dist/ に出力
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## 公開する
|
|
28
|
+
|
|
29
|
+
```sh
|
|
30
|
+
npm publish
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
YADECK のプラグインの一覧に載せるため、次の決まりを守ります。
|
|
34
|
+
|
|
35
|
+
- `package.json` の `keywords` に `yadeck-plugin` を入れる
|
|
36
|
+
- 名前は `yadeck-plugin-*` か `@scope/yadeck-plugin-*` にする
|
|
37
|
+
- `example/deck.yaml` に、bind した tags をひととおり使った見本を置く(一覧のサムネイルに使う)
|
|
38
|
+
- `@yadeck/slide-core`、`react`、`zod` は peerDependencies にする(deck と同じ実体を使うため)
|
|
39
|
+
|
|
40
|
+
詳しくは https://onfi.github.io/yadeck/guide/plugin
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "{{name}}",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "YADECK plugin",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"keywords": [
|
|
7
|
+
"yadeck-plugin"
|
|
8
|
+
],
|
|
9
|
+
"main": "./dist/index.js",
|
|
10
|
+
"types": "./dist/index.d.ts",
|
|
11
|
+
"exports": {
|
|
12
|
+
".": {
|
|
13
|
+
"types": "./dist/index.d.ts",
|
|
14
|
+
"default": "./dist/index.js"
|
|
15
|
+
}
|
|
16
|
+
},
|
|
17
|
+
"files": [
|
|
18
|
+
"dist",
|
|
19
|
+
"example"
|
|
20
|
+
],
|
|
21
|
+
"scripts": {
|
|
22
|
+
"dev": "yadeck dev",
|
|
23
|
+
"build": "tsc",
|
|
24
|
+
"test": "vitest run",
|
|
25
|
+
"schema": "yadeck schema",
|
|
26
|
+
"check": "yadeck check",
|
|
27
|
+
"png": "yadeck png",
|
|
28
|
+
"prepublishOnly": "npm run build && npm test"
|
|
29
|
+
},
|
|
30
|
+
"peerDependencies": {
|
|
31
|
+
"@yadeck/slide-core": "^0.1.3",
|
|
32
|
+
"react": "^19.0.0",
|
|
33
|
+
"zod": "^4.0.0"
|
|
34
|
+
},
|
|
35
|
+
"devDependencies": {
|
|
36
|
+
"@types/react": "^19.3.0",
|
|
37
|
+
"@yadeck/slide-components-basic": "^0.1.3",
|
|
38
|
+
"@yadeck/slide-core": "^0.1.3",
|
|
39
|
+
"playwright": "^1.65.0",
|
|
40
|
+
"react": "^19.3.0",
|
|
41
|
+
"react-dom": "^19.3.0",
|
|
42
|
+
"typescript": "^5.9.0",
|
|
43
|
+
"vitest": "^5.1.0",
|
|
44
|
+
"zod": "^4.6.0"
|
|
45
|
+
}
|
|
46
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { defineConfig } from "@yadeck/slide-core";
|
|
2
|
+
import basic from "@yadeck/slide-components-basic";
|
|
3
|
+
import plugin from "./src/index.js";
|
|
4
|
+
|
|
5
|
+
// example/ の見本をプレビューする設定(npm run dev / check / png)。npm に公開するのは dist と example だけで、この設定は含めない。
|
|
6
|
+
// 見本の HTML と PNG は、tsc の出力(dist/)と混ざらないよう .slide/preview/ に出す
|
|
7
|
+
export default defineConfig({
|
|
8
|
+
plugins: [basic, plugin],
|
|
9
|
+
decks: "example",
|
|
10
|
+
outDir: ".slide/preview",
|
|
11
|
+
fonts: ["Noto Sans JP:400,700", "JetBrains Mono:400"],
|
|
12
|
+
});
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { SlideLayout, definePlugin } from "@yadeck/slide-core";
|
|
2
|
+
import { HeroSlide, heroType } from "./layouts.js";
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* deck の slide.config.ts の plugins に足して使う(npx yadeck add で入る)。
|
|
6
|
+
* description は schema に出て、AI が tags を選ぶ手がかりになる。見た目より先に「どういう内容のページで使うか」を書く
|
|
7
|
+
*/
|
|
8
|
+
export default definePlugin((c) => {
|
|
9
|
+
c.bind(SlideLayout, ["hero"], HeroSlide, {
|
|
10
|
+
type: heroType,
|
|
11
|
+
description: "発表の核になる一言を、全面に大きく見せる。message に一言、items に補足を書く",
|
|
12
|
+
});
|
|
13
|
+
});
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { describe, expect, it } from "vitest";
|
|
2
|
+
import { createContainer, loadDeckFromYaml, renderDeck, validateDeck } from "@yadeck/slide-core";
|
|
3
|
+
import basic from "@yadeck/slide-components-basic";
|
|
4
|
+
import plugin from "./index.js";
|
|
5
|
+
|
|
6
|
+
const container = createContainer([basic, plugin]);
|
|
7
|
+
|
|
8
|
+
describe("hero", () => {
|
|
9
|
+
it("message を大きく出し、補足を添える", () => {
|
|
10
|
+
const deck = loadDeckFromYaml(`- hero: { message: 一言, $items: [補足] }`);
|
|
11
|
+
expect(validateDeck(container, deck)).toEqual([]);
|
|
12
|
+
const html = renderDeck(deck, { container });
|
|
13
|
+
expect(html).toContain("一言");
|
|
14
|
+
expect(html).toContain("補足");
|
|
15
|
+
});
|
|
16
|
+
|
|
17
|
+
it("message が無ければ検証で落ちる", () => {
|
|
18
|
+
const deck = loadDeckFromYaml(`- hero: { $items: [補足] }`);
|
|
19
|
+
expect(validateDeck(container, deck)).toEqual([{ path: "s1.message", message: expect.any(String) }]);
|
|
20
|
+
});
|
|
21
|
+
});
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
import { Block, RichText, type SlideOf } from "@yadeck/slide-core";
|
|
3
|
+
|
|
4
|
+
/** hero の data。色や位置などの見た目は持たせず、何を伝えるかだけを書かせる */
|
|
5
|
+
export const heroType = z.object({
|
|
6
|
+
message: z.string().describe("全面に大きく出す一言。markdown 可"),
|
|
7
|
+
});
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* 一言を中央に大きく出し、items(補足や発表者ノート)をその下に描く。
|
|
11
|
+
* 色や文字の大きさは deck のテーマのトークン(bg-primary、text-surface、text-display など)で指定し、テーマに従わせる
|
|
12
|
+
*/
|
|
13
|
+
export const HeroSlide = (slide: SlideOf<typeof heroType>) => (
|
|
14
|
+
<div className="absolute inset-0 flex flex-col items-center justify-center gap-10 bg-primary px-20 py-14 text-center text-surface">
|
|
15
|
+
<RichText as="p" className="m-0 text-display leading-tight font-bold" text={slide.message} />
|
|
16
|
+
{slide.items.map((b) => (
|
|
17
|
+
<Block key={b.id} data={b} />
|
|
18
|
+
))}
|
|
19
|
+
</div>
|
|
20
|
+
);
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
{
|
|
2
|
+
"compilerOptions": {
|
|
3
|
+
"target": "ES2022",
|
|
4
|
+
"module": "NodeNext",
|
|
5
|
+
"moduleResolution": "NodeNext",
|
|
6
|
+
"lib": ["ES2022", "DOM"],
|
|
7
|
+
"jsx": "react-jsx",
|
|
8
|
+
"strict": true,
|
|
9
|
+
"declaration": true,
|
|
10
|
+
"rootDir": "src",
|
|
11
|
+
"outDir": "dist",
|
|
12
|
+
"skipLibCheck": true
|
|
13
|
+
},
|
|
14
|
+
"include": ["src"],
|
|
15
|
+
"exclude": ["src/**/*.test.ts", "src/**/*.test.tsx"]
|
|
16
|
+
}
|