@xylabs/ts-scripts-yarn3 7.4.18 → 7.4.19
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.body.md +86 -0
- package/README.md +108 -0
- package/dist/actions/claude-commands.mjs +1 -1
- package/dist/actions/claude-commands.mjs.map +1 -1
- package/dist/actions/claude-rules.mjs +1 -1
- package/dist/actions/claude-rules.mjs.map +1 -1
- package/dist/actions/compile.mjs.map +1 -1
- package/dist/actions/cycle.mjs.map +1 -1
- package/dist/actions/dead.mjs.map +1 -1
- package/dist/actions/deploy-major.mjs.map +1 -1
- package/dist/actions/deploy-minor.mjs.map +1 -1
- package/dist/actions/deploy-next.mjs.map +1 -1
- package/dist/actions/deploy.mjs.map +1 -1
- package/dist/actions/fix.mjs.map +1 -1
- package/dist/actions/gen-docs.mjs.map +1 -1
- package/dist/actions/index.mjs +146 -41
- package/dist/actions/index.mjs.map +1 -1
- package/dist/actions/knip.mjs.map +1 -1
- package/dist/actions/lint.mjs.map +1 -1
- package/dist/actions/publint.mjs.map +1 -1
- package/dist/actions/publish.mjs.map +1 -1
- package/dist/actions/readme-gen.mjs +136 -20
- package/dist/actions/readme-gen.mjs.map +1 -1
- package/dist/actions/readme-init.mjs +83 -0
- package/dist/actions/readme-init.mjs.map +1 -0
- package/dist/actions/rebuild.mjs.map +1 -1
- package/dist/actions/reinstall.mjs.map +1 -1
- package/dist/actions/relint.mjs.map +1 -1
- package/dist/actions/retest.mjs +2 -2
- package/dist/actions/retest.mjs.map +1 -1
- package/dist/actions/sonar.mjs.map +1 -1
- package/dist/actions/test.mjs.map +1 -1
- package/dist/actions/up.mjs.map +1 -1
- package/dist/actions/updo.mjs.map +1 -1
- package/dist/actions/upplug.mjs.map +1 -1
- package/dist/actions/upyarn.mjs.map +1 -1
- package/dist/bin/xy.mjs +817 -576
- package/dist/bin/xy.mjs.map +1 -1
- package/dist/index.d.ts +42 -13
- package/dist/index.mjs +820 -573
- package/dist/index.mjs.map +1 -1
- package/dist/lib/claudeMdTemplate.mjs +1 -1
- package/dist/lib/claudeMdTemplate.mjs.map +1 -1
- package/dist/lib/generateReadmeFiles.mjs +118 -21
- package/dist/lib/generateReadmeFiles.mjs.map +1 -1
- package/dist/lib/index.mjs +120 -23
- package/dist/lib/index.mjs.map +1 -1
- package/dist/lib/runSteps.mjs.map +1 -1
- package/dist/lib/runXy.mjs.map +1 -1
- package/dist/xy/build/buildCommand.mjs +161 -0
- package/dist/xy/build/buildCommand.mjs.map +1 -0
- package/dist/xy/build/compileCommand.mjs +174 -0
- package/dist/xy/build/compileCommand.mjs.map +1 -0
- package/dist/xy/build/compileOnlyCommand.mjs +175 -0
- package/dist/xy/build/compileOnlyCommand.mjs.map +1 -0
- package/dist/xy/build/copyAssetsCommand.mjs +84 -0
- package/dist/xy/build/copyAssetsCommand.mjs.map +1 -0
- package/dist/xy/{xyBuildCommands.mjs → build/index.mjs} +111 -93
- package/dist/xy/build/index.mjs.map +1 -0
- package/dist/xy/build/rebuildCommand.mjs +114 -0
- package/dist/xy/build/rebuildCommand.mjs.map +1 -0
- package/dist/xy/build/recompileCommand.mjs +204 -0
- package/dist/xy/build/recompileCommand.mjs.map +1 -0
- package/dist/xy/common/claude/commandsCommand.mjs +107 -0
- package/dist/xy/common/claude/commandsCommand.mjs.map +1 -0
- package/dist/xy/common/claude/index.mjs +332 -0
- package/dist/xy/common/claude/index.mjs.map +1 -0
- package/dist/xy/common/claude/initCommand.mjs +283 -0
- package/dist/xy/common/claude/initCommand.mjs.map +1 -0
- package/dist/xy/common/claude/rulesCommand.mjs +129 -0
- package/dist/xy/common/claude/rulesCommand.mjs.map +1 -0
- package/dist/xy/common/claude/settingsCommand.mjs +90 -0
- package/dist/xy/common/claude/settingsCommand.mjs.map +1 -0
- package/dist/xy/common/cleanDocsCommand.mjs +45 -0
- package/dist/xy/common/cleanDocsCommand.mjs.map +1 -0
- package/dist/xy/common/deadCommand.mjs +116 -0
- package/dist/xy/common/deadCommand.mjs.map +1 -0
- package/dist/xy/common/genDocsCommand.mjs +125 -0
- package/dist/xy/common/genDocsCommand.mjs.map +1 -0
- package/dist/xy/common/gitignoreGenCommand.mjs +98 -0
- package/dist/xy/common/gitignoreGenCommand.mjs.map +1 -0
- package/dist/xy/common/gitlintCommand.mjs +82 -0
- package/dist/xy/common/gitlintCommand.mjs.map +1 -0
- package/dist/xy/{xyCommonCommands.mjs → common/index.mjs} +451 -241
- package/dist/xy/common/index.mjs.map +1 -0
- package/dist/xy/common/licenseCommand.mjs +100 -0
- package/dist/xy/common/licenseCommand.mjs.map +1 -0
- package/dist/xy/common/npmignoreGenCommand.mjs +98 -0
- package/dist/xy/common/npmignoreGenCommand.mjs.map +1 -0
- package/dist/xy/common/readme/genCommand.mjs +321 -0
- package/dist/xy/common/readme/genCommand.mjs.map +1 -0
- package/dist/xy/common/readme/index.mjs +361 -0
- package/dist/xy/common/readme/index.mjs.map +1 -0
- package/dist/xy/common/readme/initCommand.mjs +103 -0
- package/dist/xy/common/readme/initCommand.mjs.map +1 -0
- package/dist/xy/common/retestCommand.mjs +111 -0
- package/dist/xy/common/retestCommand.mjs.map +1 -0
- package/dist/xy/common/testCommand.mjs +108 -0
- package/dist/xy/common/testCommand.mjs.map +1 -0
- package/dist/xy/common/upplugCommand.mjs +113 -0
- package/dist/xy/common/upplugCommand.mjs.map +1 -0
- package/dist/xy/common/upyarnCommand.mjs +108 -0
- package/dist/xy/common/upyarnCommand.mjs.map +1 -0
- package/dist/xy/common/yarn3OnlyCommand.mjs +70 -0
- package/dist/xy/common/yarn3OnlyCommand.mjs.map +1 -0
- package/dist/xy/deploy/deployCommand.mjs +139 -0
- package/dist/xy/deploy/deployCommand.mjs.map +1 -0
- package/dist/xy/deploy/deployMajorCommand.mjs +139 -0
- package/dist/xy/deploy/deployMajorCommand.mjs.map +1 -0
- package/dist/xy/deploy/deployMinorCommand.mjs +139 -0
- package/dist/xy/deploy/deployMinorCommand.mjs.map +1 -0
- package/dist/xy/deploy/deployNextCommand.mjs +139 -0
- package/dist/xy/deploy/deployNextCommand.mjs.map +1 -0
- package/dist/xy/{xyDeployCommands.mjs → deploy/index.mjs} +53 -53
- package/dist/xy/deploy/index.mjs.map +1 -0
- package/dist/xy/deploy/publishCommand.mjs +108 -0
- package/dist/xy/deploy/publishCommand.mjs.map +1 -0
- package/dist/xy/index.mjs +817 -576
- package/dist/xy/index.mjs.map +1 -1
- package/dist/xy/install/cleanCommand.mjs +140 -0
- package/dist/xy/install/cleanCommand.mjs.map +1 -0
- package/dist/xy/install/dupdepsCommand.mjs +191 -0
- package/dist/xy/install/dupdepsCommand.mjs.map +1 -0
- package/dist/xy/{xyInstallCommands.mjs → install/index.mjs} +71 -68
- package/dist/xy/install/index.mjs.map +1 -0
- package/dist/xy/install/reinstallCommand.mjs +140 -0
- package/dist/xy/install/reinstallCommand.mjs.map +1 -0
- package/dist/xy/install/staticsCommand.mjs +191 -0
- package/dist/xy/install/staticsCommand.mjs.map +1 -0
- package/dist/{actions/clean-jest.mjs → xy/install/upCommand.mjs} +15 -6
- package/dist/xy/install/upCommand.mjs.map +1 -0
- package/dist/xy/install/updoCommand.mjs +112 -0
- package/dist/xy/install/updoCommand.mjs.map +1 -0
- package/dist/xy/lint/cycleCommand.mjs +163 -0
- package/dist/xy/lint/cycleCommand.mjs.map +1 -0
- package/dist/xy/lint/deplintCommand.mjs +814 -0
- package/dist/xy/lint/deplintCommand.mjs.map +1 -0
- package/dist/xy/lint/fixCommand.mjs +168 -0
- package/dist/xy/lint/fixCommand.mjs.map +1 -0
- package/dist/xy/{xyLintCommands.mjs → lint/index.mjs} +176 -145
- package/dist/xy/lint/index.mjs.map +1 -0
- package/dist/xy/lint/knipCommand.mjs +121 -0
- package/dist/xy/lint/knipCommand.mjs.map +1 -0
- package/dist/xy/lint/lintCommand.mjs +186 -0
- package/dist/xy/lint/lintCommand.mjs.map +1 -0
- package/dist/xy/lint/publintCommand.mjs +187 -0
- package/dist/xy/lint/publintCommand.mjs.map +1 -0
- package/dist/xy/lint/relintCommand.mjs +163 -0
- package/dist/xy/lint/relintCommand.mjs.map +1 -0
- package/dist/xy/lint/sonarCommand.mjs +121 -0
- package/dist/xy/lint/sonarCommand.mjs.map +1 -0
- package/dist/xy/xy.mjs +815 -574
- package/dist/xy/xy.mjs.map +1 -1
- package/package.json +2 -2
- package/templates/readme/README.body.md +11 -0
- package/templates/readme/README.template.md +22 -0
- package/dist/actions/clean-jest.mjs.map +0 -1
- package/dist/xy/xyBuildCommands.mjs.map +0 -1
- package/dist/xy/xyCommonCommands.mjs.map +0 -1
- package/dist/xy/xyDeployCommands.mjs.map +0 -1
- package/dist/xy/xyInstallCommands.mjs.map +0 -1
- package/dist/xy/xyLintCommands.mjs.map +0 -1
- /package/templates/{CLAUDE-project.md → claude/CLAUDE-project.md} +0 -0
- /package/templates/{commands → claude/commands}/xylabs-build.md +0 -0
- /package/templates/{commands → claude/commands}/xylabs-clean.md +0 -0
- /package/templates/{commands → claude/commands}/xylabs-compile.md +0 -0
- /package/templates/{commands → claude/commands}/xylabs-cycle.md +0 -0
- /package/templates/{commands → claude/commands}/xylabs-deplint.md +0 -0
- /package/templates/{commands → claude/commands}/xylabs-deploy-major.md +0 -0
- /package/templates/{commands → claude/commands}/xylabs-deploy-minor.md +0 -0
- /package/templates/{commands → claude/commands}/xylabs-deploy.md +0 -0
- /package/templates/{commands → claude/commands}/xylabs-fix.md +0 -0
- /package/templates/{commands → claude/commands}/xylabs-knip.md +0 -0
- /package/templates/{commands → claude/commands}/xylabs-lint.md +0 -0
- /package/templates/{commands → claude/commands}/xylabs-publint.md +0 -0
- /package/templates/{commands → claude/commands}/xylabs-rebuild.md +0 -0
- /package/templates/{commands → claude/commands}/xylabs-test.md +0 -0
- /package/templates/{rules → claude/rules}/xylabs-architecture.md +0 -0
- /package/templates/{rules → claude/rules}/xylabs-build.md +0 -0
- /package/templates/{rules → claude/rules}/xylabs-dependencies.md +0 -0
- /package/templates/{rules → claude/rules}/xylabs-error-handling.md +0 -0
- /package/templates/{rules → claude/rules}/xylabs-frameworks.md +0 -0
- /package/templates/{rules → claude/rules}/xylabs-git-workflow.md +0 -0
- /package/templates/{rules → claude/rules}/xylabs-linting.md +0 -0
- /package/templates/{rules → claude/rules}/xylabs-naming.md +0 -0
- /package/templates/{rules → claude/rules}/xylabs-style.md +0 -0
- /package/templates/{rules → claude/rules}/xylabs-typescript.md +0 -0
|
@@ -4,7 +4,7 @@ import { createRequire } from "module";
|
|
|
4
4
|
import PATH from "path";
|
|
5
5
|
var require2 = createRequire(import.meta.url);
|
|
6
6
|
var packageRoot = PATH.dirname(require2.resolve("@xylabs/ts-scripts-yarn3/package.json"));
|
|
7
|
-
var templatesDir = PATH.resolve(packageRoot, "templates");
|
|
7
|
+
var templatesDir = PATH.resolve(packageRoot, "templates", "claude");
|
|
8
8
|
var XYLABS_RULES_PREFIX = "xylabs-";
|
|
9
9
|
var XYLABS_COMMANDS_PREFIX = "xylabs-";
|
|
10
10
|
var claudeMdRuleTemplates = () => {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/lib/claudeMdTemplate.ts"],"sourcesContent":["import { readdirSync, readFileSync } from 'node:fs'\nimport { createRequire } from 'node:module'\nimport PATH from 'node:path'\n\nconst require = createRequire(import.meta.url)\nconst packageRoot = PATH.dirname(require.resolve('@xylabs/ts-scripts-yarn3/package.json'))\nconst templatesDir = PATH.resolve(packageRoot, 'templates')\n\nexport const XYLABS_RULES_PREFIX = 'xylabs-'\nexport const XYLABS_COMMANDS_PREFIX = 'xylabs-'\n\nexport const claudeMdRuleTemplates = (): Record<string, string> => {\n const rulesDir = PATH.resolve(templatesDir, 'rules')\n const files = readdirSync(rulesDir).filter(f => f.startsWith(XYLABS_RULES_PREFIX) && f.endsWith('.md'))\n const result: Record<string, string> = {}\n for (const file of files) {\n result[file] = readFileSync(PATH.resolve(rulesDir, file), 'utf8')\n }\n return result\n}\n\nexport const claudeCommandTemplates = (): Record<string, string> => {\n const commandsDir = PATH.resolve(templatesDir, 'commands')\n const files = readdirSync(commandsDir).filter(f => f.startsWith(XYLABS_COMMANDS_PREFIX) && f.endsWith('.md'))\n const result: Record<string, string> = {}\n for (const file of files) {\n result[file] = readFileSync(PATH.resolve(commandsDir, file), 'utf8')\n }\n return result\n}\n\nexport const claudeMdProjectTemplate = (): string =>\n readFileSync(PATH.resolve(templatesDir, 'CLAUDE-project.md'), 'utf8')\n"],"mappings":";AAAA,SAAS,aAAa,oBAAoB;AAC1C,SAAS,qBAAqB;AAC9B,OAAO,UAAU;AAEjB,IAAMA,WAAU,cAAc,YAAY,GAAG;AAC7C,IAAM,cAAc,KAAK,QAAQA,SAAQ,QAAQ,uCAAuC,CAAC;AACzF,IAAM,eAAe,KAAK,QAAQ,aAAa,
|
|
1
|
+
{"version":3,"sources":["../../src/lib/claudeMdTemplate.ts"],"sourcesContent":["import { readdirSync, readFileSync } from 'node:fs'\nimport { createRequire } from 'node:module'\nimport PATH from 'node:path'\n\nconst require = createRequire(import.meta.url)\nconst packageRoot = PATH.dirname(require.resolve('@xylabs/ts-scripts-yarn3/package.json'))\nconst templatesDir = PATH.resolve(packageRoot, 'templates', 'claude')\n\nexport const XYLABS_RULES_PREFIX = 'xylabs-'\nexport const XYLABS_COMMANDS_PREFIX = 'xylabs-'\n\nexport const claudeMdRuleTemplates = (): Record<string, string> => {\n const rulesDir = PATH.resolve(templatesDir, 'rules')\n const files = readdirSync(rulesDir).filter(f => f.startsWith(XYLABS_RULES_PREFIX) && f.endsWith('.md'))\n const result: Record<string, string> = {}\n for (const file of files) {\n result[file] = readFileSync(PATH.resolve(rulesDir, file), 'utf8')\n }\n return result\n}\n\nexport const claudeCommandTemplates = (): Record<string, string> => {\n const commandsDir = PATH.resolve(templatesDir, 'commands')\n const files = readdirSync(commandsDir).filter(f => f.startsWith(XYLABS_COMMANDS_PREFIX) && f.endsWith('.md'))\n const result: Record<string, string> = {}\n for (const file of files) {\n result[file] = readFileSync(PATH.resolve(commandsDir, file), 'utf8')\n }\n return result\n}\n\nexport const claudeMdProjectTemplate = (): string =>\n readFileSync(PATH.resolve(templatesDir, 'CLAUDE-project.md'), 'utf8')\n"],"mappings":";AAAA,SAAS,aAAa,oBAAoB;AAC1C,SAAS,qBAAqB;AAC9B,OAAO,UAAU;AAEjB,IAAMA,WAAU,cAAc,YAAY,GAAG;AAC7C,IAAM,cAAc,KAAK,QAAQA,SAAQ,QAAQ,uCAAuC,CAAC;AACzF,IAAM,eAAe,KAAK,QAAQ,aAAa,aAAa,QAAQ;AAE7D,IAAM,sBAAsB;AAC5B,IAAM,yBAAyB;AAE/B,IAAM,wBAAwB,MAA8B;AACjE,QAAM,WAAW,KAAK,QAAQ,cAAc,OAAO;AACnD,QAAM,QAAQ,YAAY,QAAQ,EAAE,OAAO,OAAK,EAAE,WAAW,mBAAmB,KAAK,EAAE,SAAS,KAAK,CAAC;AACtG,QAAM,SAAiC,CAAC;AACxC,aAAW,QAAQ,OAAO;AACxB,WAAO,IAAI,IAAI,aAAa,KAAK,QAAQ,UAAU,IAAI,GAAG,MAAM;AAAA,EAClE;AACA,SAAO;AACT;AAEO,IAAM,yBAAyB,MAA8B;AAClE,QAAM,cAAc,KAAK,QAAQ,cAAc,UAAU;AACzD,QAAM,QAAQ,YAAY,WAAW,EAAE,OAAO,OAAK,EAAE,WAAW,sBAAsB,KAAK,EAAE,SAAS,KAAK,CAAC;AAC5G,QAAM,SAAiC,CAAC;AACxC,aAAW,QAAQ,OAAO;AACxB,WAAO,IAAI,IAAI,aAAa,KAAK,QAAQ,aAAa,IAAI,GAAG,MAAM;AAAA,EACrE;AACA,SAAO;AACT;AAEO,IAAM,0BAA0B,MACrC,aAAa,KAAK,QAAQ,cAAc,mBAAmB,GAAG,MAAM;","names":["require"]}
|
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
// src/lib/generateReadmeFiles.ts
|
|
2
2
|
import { execSync } from "child_process";
|
|
3
|
-
import FS from "fs";
|
|
4
|
-
import {
|
|
3
|
+
import FS, { readFileSync } from "fs";
|
|
4
|
+
import {
|
|
5
|
+
mkdir,
|
|
6
|
+
readFile,
|
|
7
|
+
writeFile
|
|
8
|
+
} from "fs/promises";
|
|
9
|
+
import { createRequire } from "module";
|
|
5
10
|
import PATH from "path";
|
|
11
|
+
import { createInterface } from "readline";
|
|
6
12
|
import chalk from "chalk";
|
|
7
13
|
|
|
8
14
|
// src/lib/yarn/workspace/yarnWorkspaces.ts
|
|
@@ -31,6 +37,9 @@ var INIT_CWD = () => {
|
|
|
31
37
|
};
|
|
32
38
|
|
|
33
39
|
// src/lib/generateReadmeFiles.ts
|
|
40
|
+
var require2 = createRequire(import.meta.url);
|
|
41
|
+
var packageRoot = PATH.dirname(require2.resolve("@xylabs/ts-scripts-yarn3/package.json"));
|
|
42
|
+
var readmeTemplatesDir = PATH.resolve(packageRoot, "templates", "readme");
|
|
34
43
|
function fillTemplate(template, data) {
|
|
35
44
|
const additionalData = { ...data, safeName: data.name.replaceAll("/", "__").replaceAll("@", "") };
|
|
36
45
|
return template.replaceAll(/\{\{(.*?)\}\}/g, (_, key) => additionalData[key.trim()] ?? "");
|
|
@@ -120,41 +129,129 @@ ${indent}### ${item.name}
|
|
|
120
129
|
}
|
|
121
130
|
return content;
|
|
122
131
|
}
|
|
132
|
+
function askConfirmation(question) {
|
|
133
|
+
const rl = createInterface({ input: process.stdin, output: process.stdout });
|
|
134
|
+
return new Promise((resolve) => {
|
|
135
|
+
rl.question(question, (answer) => {
|
|
136
|
+
rl.close();
|
|
137
|
+
resolve(answer.toLowerCase() === "y" || answer.toLowerCase() === "yes");
|
|
138
|
+
});
|
|
139
|
+
});
|
|
140
|
+
}
|
|
141
|
+
var DEFAULT_README_TEMPLATE = readFileSync(PATH.resolve(readmeTemplatesDir, "README.template.md"), "utf8");
|
|
142
|
+
var DEFAULT_README_BODY = readFileSync(PATH.resolve(readmeTemplatesDir, "README.body.md"), "utf8");
|
|
143
|
+
function applyLogoConfig(template, logoUrl, logoLinkUrl) {
|
|
144
|
+
let result = template;
|
|
145
|
+
if (logoUrl) {
|
|
146
|
+
result = result.replace(/\[logo]: .+/, `[logo]: ${logoUrl}`);
|
|
147
|
+
if (logoLinkUrl) {
|
|
148
|
+
result = result.replace(/\[!\[logo]\[]][^)]*\)/, `[![logo][]](${logoLinkUrl})`);
|
|
149
|
+
}
|
|
150
|
+
} else {
|
|
151
|
+
result = result.replace(/\[!\[logo]\[]][^\n]*\n*/, "");
|
|
152
|
+
result = result.replace(/\[logo]: [^\n]*\n?/, "");
|
|
153
|
+
}
|
|
154
|
+
return result;
|
|
155
|
+
}
|
|
156
|
+
function resolveTemplatePath(templatePath) {
|
|
157
|
+
const cwd = INIT_CWD() ?? ".";
|
|
158
|
+
return templatePath ?? PATH.join(cwd, ".xy", "README.template.md");
|
|
159
|
+
}
|
|
160
|
+
async function loadOrCreateTemplate(resolvedTemplatePath) {
|
|
161
|
+
try {
|
|
162
|
+
const template = await readFile(resolvedTemplatePath, "utf8");
|
|
163
|
+
return { created: false, template };
|
|
164
|
+
} catch {
|
|
165
|
+
console.log(chalk.yellow(`Template not found: ${resolvedTemplatePath}`));
|
|
166
|
+
const shouldCreate = await askConfirmation("Would you like to create a stock template? (y/N) ");
|
|
167
|
+
if (!shouldCreate) {
|
|
168
|
+
throw new Error("Template creation declined");
|
|
169
|
+
}
|
|
170
|
+
const template = DEFAULT_README_TEMPLATE;
|
|
171
|
+
await scaffoldTemplate(resolvedTemplatePath, template);
|
|
172
|
+
return { created: true, template };
|
|
173
|
+
}
|
|
174
|
+
}
|
|
175
|
+
async function scaffoldTemplate(resolvedTemplatePath, template) {
|
|
176
|
+
const xyDir = PATH.dirname(resolvedTemplatePath);
|
|
177
|
+
await mkdir(xyDir, { recursive: true });
|
|
178
|
+
await writeFile(resolvedTemplatePath, template);
|
|
179
|
+
console.log(chalk.green(`Created template: ${resolvedTemplatePath}`));
|
|
180
|
+
const bodyPath = PATH.join(xyDir, "README.body.md");
|
|
181
|
+
await writeFile(bodyPath, DEFAULT_README_BODY);
|
|
182
|
+
console.log(chalk.green(`Created body template: ${bodyPath}`));
|
|
183
|
+
}
|
|
184
|
+
async function resolveBody(location, defaultBody) {
|
|
185
|
+
const localBodyPath = PATH.join(location, "README.body.md");
|
|
186
|
+
try {
|
|
187
|
+
return await readFile(localBodyPath, "utf8");
|
|
188
|
+
} catch {
|
|
189
|
+
return defaultBody;
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
async function generateReadmeForWorkspace(location, name, template, defaultBody, typedoc, verbose) {
|
|
193
|
+
try {
|
|
194
|
+
const pkgJsonPath = PATH.join(location, "package.json");
|
|
195
|
+
const pkgJson = JSON.parse(await readFile(pkgJsonPath, "utf8"));
|
|
196
|
+
const body = await resolveBody(location, defaultBody);
|
|
197
|
+
const typedocContent = typedoc ? generateTypedoc(location, ["src/index*.ts"]) : "";
|
|
198
|
+
const readmeContent = fillTemplate(template, {
|
|
199
|
+
...pkgJson,
|
|
200
|
+
body,
|
|
201
|
+
typedoc: typedocContent
|
|
202
|
+
});
|
|
203
|
+
await writeFile(PATH.join(location, "README.md"), readmeContent);
|
|
204
|
+
if (verbose) console.log(chalk.green(` ${name}`));
|
|
205
|
+
return true;
|
|
206
|
+
} catch (ex) {
|
|
207
|
+
const error = ex;
|
|
208
|
+
console.warn(chalk.yellow(` Skipped ${location}: ${error.message}`));
|
|
209
|
+
return false;
|
|
210
|
+
}
|
|
211
|
+
}
|
|
123
212
|
async function generateReadmeFiles({
|
|
213
|
+
logoLinkUrl,
|
|
214
|
+
logoUrl,
|
|
124
215
|
pkg,
|
|
125
216
|
templatePath,
|
|
126
217
|
typedoc = false,
|
|
127
|
-
verbose
|
|
218
|
+
verbose = false
|
|
128
219
|
}) {
|
|
129
220
|
console.log(chalk.green("Generate README Files"));
|
|
130
|
-
const
|
|
131
|
-
const resolvedTemplatePath = templatePath ?? PATH.join(cwd, "scripts", "README.template.md");
|
|
221
|
+
const resolvedTemplatePath = resolveTemplatePath(templatePath);
|
|
132
222
|
let template;
|
|
223
|
+
let templateCreated;
|
|
133
224
|
try {
|
|
134
|
-
template = await
|
|
225
|
+
({ template, created: templateCreated } = await loadOrCreateTemplate(resolvedTemplatePath));
|
|
135
226
|
} catch {
|
|
136
|
-
console.error(chalk.red(`Template not found: ${resolvedTemplatePath}`));
|
|
137
227
|
return 1;
|
|
138
228
|
}
|
|
139
|
-
|
|
229
|
+
template = applyLogoConfig(template, logoUrl, logoLinkUrl);
|
|
230
|
+
if (templateCreated) {
|
|
231
|
+
console.log(chalk.green("Generating README files for all packages..."));
|
|
232
|
+
}
|
|
233
|
+
const xyDir = PATH.dirname(resolvedTemplatePath);
|
|
234
|
+
const xyBodyPath = PATH.join(xyDir, "README.body.md");
|
|
235
|
+
let defaultBody;
|
|
236
|
+
try {
|
|
237
|
+
defaultBody = await readFile(xyBodyPath, "utf8");
|
|
238
|
+
} catch {
|
|
239
|
+
defaultBody = DEFAULT_README_BODY;
|
|
240
|
+
}
|
|
241
|
+
const workspaces = pkg && !templateCreated ? [yarnWorkspace(pkg)] : yarnWorkspaces();
|
|
140
242
|
let failed = false;
|
|
141
243
|
for (const { location, name } of workspaces) {
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
const pkgJson = JSON.parse(await readFile(pkgJsonPath, "utf8"));
|
|
145
|
-
const typedocContent = typedoc ? generateTypedoc(location, ["src/index*.ts"]) : "";
|
|
146
|
-
const readmeContent = fillTemplate(template, { ...pkgJson, typedoc: typedocContent });
|
|
147
|
-
await writeFile(PATH.join(location, "README.md"), readmeContent);
|
|
148
|
-
if (verbose) console.log(chalk.green(` ${name}`));
|
|
149
|
-
} catch (ex) {
|
|
150
|
-
const error = ex;
|
|
151
|
-
console.warn(chalk.yellow(` Skipped ${location}: ${error.message}`));
|
|
152
|
-
failed = true;
|
|
153
|
-
}
|
|
244
|
+
const success = await generateReadmeForWorkspace(location, name, template, defaultBody, typedoc, verbose);
|
|
245
|
+
if (!success) failed = true;
|
|
154
246
|
}
|
|
155
247
|
return failed ? 1 : 0;
|
|
156
248
|
}
|
|
157
249
|
export {
|
|
158
|
-
|
|
250
|
+
DEFAULT_README_BODY,
|
|
251
|
+
DEFAULT_README_TEMPLATE,
|
|
252
|
+
applyLogoConfig,
|
|
253
|
+
generateReadmeFiles,
|
|
254
|
+
resolveTemplatePath,
|
|
255
|
+
scaffoldTemplate
|
|
159
256
|
};
|
|
160
257
|
//# sourceMappingURL=generateReadmeFiles.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/lib/generateReadmeFiles.ts","../../src/lib/yarn/workspace/yarnWorkspaces.ts","../../src/lib/yarn/workspace/yarnWorkspace.ts","../../src/lib/yarn/yarnInitCwd.ts"],"sourcesContent":["import { execSync } from 'node:child_process'\nimport FS from 'node:fs'\nimport { readFile, writeFile } from 'node:fs/promises'\nimport PATH from 'node:path'\n\nimport chalk from 'chalk'\n\nimport {\n INIT_CWD, yarnWorkspace, yarnWorkspaces,\n} from './yarn/index.ts'\n\ninterface GenerateReadmeFilesParams {\n pkg?: string\n templatePath?: string\n typedoc?: boolean\n verbose?: boolean\n}\n\nfunction fillTemplate(template: string, data: Record<string, string>): string {\n const additionalData: Record<string, string> = { ...data, safeName: data.name.replaceAll('/', '__').replaceAll('@', '') }\n return template.replaceAll(/\\{\\{(.*?)\\}\\}/g, (_, key: string) => additionalData[key.trim()] ?? '')\n}\n\nfunction generateTypedoc(packageLocation: string, entryPoints: string[]): string {\n const tempDir = PATH.join(packageLocation, '.temp-typedoc')\n\n try {\n if (!FS.existsSync(tempDir)) {\n FS.mkdirSync(tempDir, { recursive: true })\n }\n\n const typedocConfig = {\n disableSources: true,\n entryPointStrategy: 'expand',\n entryPoints: entryPoints.map(ep => PATH.resolve(packageLocation, ep)),\n excludeExternals: true,\n excludeInternal: true,\n excludePrivate: true,\n githubPages: false,\n hideBreadcrumbs: true,\n hideGenerator: true,\n hidePageTitle: true,\n out: tempDir,\n plugin: ['typedoc-plugin-markdown'],\n readme: 'none',\n skipErrorChecking: true,\n sort: ['source-order'],\n theme: 'markdown',\n useCodeBlocks: true,\n }\n\n const typedocJsonPath = PATH.join(tempDir, 'typedoc.json')\n FS.writeFileSync(typedocJsonPath, JSON.stringify(typedocConfig, null, 2))\n\n try {\n execSync(`npx typedoc --options ${typedocJsonPath}`, {\n cwd: process.cwd(),\n stdio: ['ignore', 'pipe', 'pipe'],\n })\n } catch {\n return ''\n }\n\n return consolidateMarkdown(tempDir)\n } catch {\n return ''\n } finally {\n try {\n FS.rmSync(tempDir, { force: true, recursive: true })\n } catch {\n // ignore cleanup errors\n }\n }\n}\n\nfunction consolidateMarkdown(tempDir: string): string {\n let consolidated = '## Reference\\n\\n'\n\n const mainReadmePath = PATH.join(tempDir, 'README.md')\n if (FS.existsSync(mainReadmePath)) {\n const mainContent = FS.readFileSync(mainReadmePath, 'utf8')\n .replace(/^---(.|\\n)*?---\\n/, '')\n .replace(/^# .+\\n/, '')\n .replaceAll(/\\]\\((.+?)\\.md\\)/g, '](#$1)')\n\n consolidated += mainContent + '\\n\\n'\n }\n\n consolidated += processDirectory(tempDir)\n\n return consolidated\n .replaceAll(/\\n\\n\\n+/g, '\\n\\n')\n .replaceAll(/^#### /gm, '### ')\n .replaceAll(/^##### /gm, '#### ')\n .replaceAll(/^###### /gm, '##### ')\n}\n\nfunction processDirectory(dir: string, level = 0): string {\n const indent = ' '.repeat(level)\n let content = ''\n\n try {\n const items = FS.readdirSync(dir, { withFileTypes: true })\n\n for (const item of items) {\n if (item.isDirectory()) continue\n if (item.name === 'README.md' || !item.name.endsWith('.md')) continue\n\n const fileContent = FS.readFileSync(PATH.join(dir, item.name), 'utf8')\n .replace(/^---(.|\\n)*?---\\n/, '')\n const moduleName = item.name.replace('.md', '')\n\n content += `\\n\\n${indent}### <a id=\"${moduleName}\"></a>${moduleName}\\n\\n`\n content += fileContent\n .replace(/^# .+\\n/, '')\n .replaceAll(/\\]\\((.+?)\\.md\\)/g, '](#$1)')\n }\n\n for (const item of items) {\n if (!item.isDirectory()) continue\n if (item.name === 'spec' || item.name.includes('.spec')) continue\n\n content += `\\n\\n${indent}### ${item.name}\\n`\n content += processDirectory(PATH.join(dir, item.name), level + 1)\n }\n } catch {\n // skip unreadable directories\n }\n\n return content\n}\n\nexport async function generateReadmeFiles({\n pkg, templatePath, typedoc = false, verbose,\n}: GenerateReadmeFilesParams): Promise<number> {\n console.log(chalk.green('Generate README Files'))\n const cwd = INIT_CWD() ?? '.'\n const resolvedTemplatePath = templatePath ?? PATH.join(cwd, 'scripts', 'README.template.md')\n\n let template: string\n try {\n template = await readFile(resolvedTemplatePath, 'utf8')\n } catch {\n console.error(chalk.red(`Template not found: ${resolvedTemplatePath}`))\n return 1\n }\n\n const workspaces = pkg ? [yarnWorkspace(pkg)] : yarnWorkspaces()\n let failed = false\n\n for (const { location, name } of workspaces) {\n try {\n const pkgJsonPath = PATH.join(location, 'package.json')\n const pkgJson = JSON.parse(await readFile(pkgJsonPath, 'utf8'))\n const typedocContent = typedoc ? generateTypedoc(location, ['src/index*.ts']) : ''\n const readmeContent = fillTemplate(template, { ...pkgJson, typedoc: typedocContent })\n await writeFile(PATH.join(location, 'README.md'), readmeContent)\n if (verbose) console.log(chalk.green(` ${name}`))\n } catch (ex) {\n const error = ex as Error\n console.warn(chalk.yellow(` Skipped ${location}: ${error.message}`))\n failed = true\n }\n }\n\n return failed ? 1 : 0\n}\n","import { spawnSync } from 'node:child_process'\n\nimport type { Workspace } from './Workspace.ts'\n\nexport const yarnWorkspaces = (): Workspace[] => {\n const result = spawnSync('yarn', ['workspaces', 'list', '--json', '--recursive'], { encoding: 'utf8', shell: true })\n if (result.error) {\n throw result.error\n }\n return (\n result.stdout\n .toString()\n // NOTE: This probably doesn't work on Windows\n // TODO: Replace /r/n with /n first\n .split('\\n')\n .slice(0, -1)\n .map((item) => {\n return JSON.parse(item)\n })\n )\n}\n","import type { Workspace } from './Workspace.ts'\nimport { yarnWorkspaces } from './yarnWorkspaces.ts'\n\nexport const yarnWorkspace = (pkg: string): Workspace => {\n const workspace = yarnWorkspaces().find(({ name }) => name === pkg)\n if (!workspace) throw new Error(`Workspace ${pkg} not found`)\n return workspace\n}\n","export const INIT_CWD = () => {\n if (!process.env.INIT_CWD) console.error('Missing INIT_CWD')\n return process.env.INIT_CWD\n}\n"],"mappings":";AAAA,SAAS,gBAAgB;AACzB,OAAO,QAAQ;AACf,SAAS,UAAU,iBAAiB;AACpC,OAAO,UAAU;AAEjB,OAAO,WAAW;;;ACLlB,SAAS,iBAAiB;AAInB,IAAM,iBAAiB,MAAmB;AAC/C,QAAM,SAAS,UAAU,QAAQ,CAAC,cAAc,QAAQ,UAAU,aAAa,GAAG,EAAE,UAAU,QAAQ,OAAO,KAAK,CAAC;AACnH,MAAI,OAAO,OAAO;AAChB,UAAM,OAAO;AAAA,EACf;AACA,SACE,OAAO,OACJ,SAAS,EAGT,MAAM,IAAI,EACV,MAAM,GAAG,EAAE,EACX,IAAI,CAAC,SAAS;AACb,WAAO,KAAK,MAAM,IAAI;AAAA,EACxB,CAAC;AAEP;;;ACjBO,IAAM,gBAAgB,CAAC,QAA2B;AACvD,QAAM,YAAY,eAAe,EAAE,KAAK,CAAC,EAAE,KAAK,MAAM,SAAS,GAAG;AAClE,MAAI,CAAC,UAAW,OAAM,IAAI,MAAM,aAAa,GAAG,YAAY;AAC5D,SAAO;AACT;;;ACPO,IAAM,WAAW,MAAM;AAC5B,MAAI,CAAC,QAAQ,IAAI,SAAU,SAAQ,MAAM,kBAAkB;AAC3D,SAAO,QAAQ,IAAI;AACrB;;;AHeA,SAAS,aAAa,UAAkB,MAAsC;AAC5E,QAAM,iBAAyC,EAAE,GAAG,MAAM,UAAU,KAAK,KAAK,WAAW,KAAK,IAAI,EAAE,WAAW,KAAK,EAAE,EAAE;AACxH,SAAO,SAAS,WAAW,kBAAkB,CAAC,GAAG,QAAgB,eAAe,IAAI,KAAK,CAAC,KAAK,EAAE;AACnG;AAEA,SAAS,gBAAgB,iBAAyB,aAA+B;AAC/E,QAAM,UAAU,KAAK,KAAK,iBAAiB,eAAe;AAE1D,MAAI;AACF,QAAI,CAAC,GAAG,WAAW,OAAO,GAAG;AAC3B,SAAG,UAAU,SAAS,EAAE,WAAW,KAAK,CAAC;AAAA,IAC3C;AAEA,UAAM,gBAAgB;AAAA,MACpB,gBAAgB;AAAA,MAChB,oBAAoB;AAAA,MACpB,aAAa,YAAY,IAAI,QAAM,KAAK,QAAQ,iBAAiB,EAAE,CAAC;AAAA,MACpE,kBAAkB;AAAA,MAClB,iBAAiB;AAAA,MACjB,gBAAgB;AAAA,MAChB,aAAa;AAAA,MACb,iBAAiB;AAAA,MACjB,eAAe;AAAA,MACf,eAAe;AAAA,MACf,KAAK;AAAA,MACL,QAAQ,CAAC,yBAAyB;AAAA,MAClC,QAAQ;AAAA,MACR,mBAAmB;AAAA,MACnB,MAAM,CAAC,cAAc;AAAA,MACrB,OAAO;AAAA,MACP,eAAe;AAAA,IACjB;AAEA,UAAM,kBAAkB,KAAK,KAAK,SAAS,cAAc;AACzD,OAAG,cAAc,iBAAiB,KAAK,UAAU,eAAe,MAAM,CAAC,CAAC;AAExE,QAAI;AACF,eAAS,yBAAyB,eAAe,IAAI;AAAA,QACnD,KAAK,QAAQ,IAAI;AAAA,QACjB,OAAO,CAAC,UAAU,QAAQ,MAAM;AAAA,MAClC,CAAC;AAAA,IACH,QAAQ;AACN,aAAO;AAAA,IACT;AAEA,WAAO,oBAAoB,OAAO;AAAA,EACpC,QAAQ;AACN,WAAO;AAAA,EACT,UAAE;AACA,QAAI;AACF,SAAG,OAAO,SAAS,EAAE,OAAO,MAAM,WAAW,KAAK,CAAC;AAAA,IACrD,QAAQ;AAAA,IAER;AAAA,EACF;AACF;AAEA,SAAS,oBAAoB,SAAyB;AACpD,MAAI,eAAe;AAEnB,QAAM,iBAAiB,KAAK,KAAK,SAAS,WAAW;AACrD,MAAI,GAAG,WAAW,cAAc,GAAG;AACjC,UAAM,cAAc,GAAG,aAAa,gBAAgB,MAAM,EACvD,QAAQ,qBAAqB,EAAE,EAC/B,QAAQ,WAAW,EAAE,EACrB,WAAW,oBAAoB,QAAQ;AAE1C,oBAAgB,cAAc;AAAA,EAChC;AAEA,kBAAgB,iBAAiB,OAAO;AAExC,SAAO,aACJ,WAAW,YAAY,MAAM,EAC7B,WAAW,YAAY,MAAM,EAC7B,WAAW,aAAa,OAAO,EAC/B,WAAW,cAAc,QAAQ;AACtC;AAEA,SAAS,iBAAiB,KAAa,QAAQ,GAAW;AACxD,QAAM,SAAS,KAAK,OAAO,KAAK;AAChC,MAAI,UAAU;AAEd,MAAI;AACF,UAAM,QAAQ,GAAG,YAAY,KAAK,EAAE,eAAe,KAAK,CAAC;AAEzD,eAAW,QAAQ,OAAO;AACxB,UAAI,KAAK,YAAY,EAAG;AACxB,UAAI,KAAK,SAAS,eAAe,CAAC,KAAK,KAAK,SAAS,KAAK,EAAG;AAE7D,YAAM,cAAc,GAAG,aAAa,KAAK,KAAK,KAAK,KAAK,IAAI,GAAG,MAAM,EAClE,QAAQ,qBAAqB,EAAE;AAClC,YAAM,aAAa,KAAK,KAAK,QAAQ,OAAO,EAAE;AAE9C,iBAAW;AAAA;AAAA,EAAO,MAAM,cAAc,UAAU,SAAS,UAAU;AAAA;AAAA;AACnE,iBAAW,YACR,QAAQ,WAAW,EAAE,EACrB,WAAW,oBAAoB,QAAQ;AAAA,IAC5C;AAEA,eAAW,QAAQ,OAAO;AACxB,UAAI,CAAC,KAAK,YAAY,EAAG;AACzB,UAAI,KAAK,SAAS,UAAU,KAAK,KAAK,SAAS,OAAO,EAAG;AAEzD,iBAAW;AAAA;AAAA,EAAO,MAAM,OAAO,KAAK,IAAI;AAAA;AACxC,iBAAW,iBAAiB,KAAK,KAAK,KAAK,KAAK,IAAI,GAAG,QAAQ,CAAC;AAAA,IAClE;AAAA,EACF,QAAQ;AAAA,EAER;AAEA,SAAO;AACT;AAEA,eAAsB,oBAAoB;AAAA,EACxC;AAAA,EAAK;AAAA,EAAc,UAAU;AAAA,EAAO;AACtC,GAA+C;AAC7C,UAAQ,IAAI,MAAM,MAAM,uBAAuB,CAAC;AAChD,QAAM,MAAM,SAAS,KAAK;AAC1B,QAAM,uBAAuB,gBAAgB,KAAK,KAAK,KAAK,WAAW,oBAAoB;AAE3F,MAAI;AACJ,MAAI;AACF,eAAW,MAAM,SAAS,sBAAsB,MAAM;AAAA,EACxD,QAAQ;AACN,YAAQ,MAAM,MAAM,IAAI,uBAAuB,oBAAoB,EAAE,CAAC;AACtE,WAAO;AAAA,EACT;AAEA,QAAM,aAAa,MAAM,CAAC,cAAc,GAAG,CAAC,IAAI,eAAe;AAC/D,MAAI,SAAS;AAEb,aAAW,EAAE,UAAU,KAAK,KAAK,YAAY;AAC3C,QAAI;AACF,YAAM,cAAc,KAAK,KAAK,UAAU,cAAc;AACtD,YAAM,UAAU,KAAK,MAAM,MAAM,SAAS,aAAa,MAAM,CAAC;AAC9D,YAAM,iBAAiB,UAAU,gBAAgB,UAAU,CAAC,eAAe,CAAC,IAAI;AAChF,YAAM,gBAAgB,aAAa,UAAU,EAAE,GAAG,SAAS,SAAS,eAAe,CAAC;AACpF,YAAM,UAAU,KAAK,KAAK,UAAU,WAAW,GAAG,aAAa;AAC/D,UAAI,QAAS,SAAQ,IAAI,MAAM,MAAM,KAAK,IAAI,EAAE,CAAC;AAAA,IACnD,SAAS,IAAI;AACX,YAAM,QAAQ;AACd,cAAQ,KAAK,MAAM,OAAO,aAAa,QAAQ,KAAK,MAAM,OAAO,EAAE,CAAC;AACpE,eAAS;AAAA,IACX;AAAA,EACF;AAEA,SAAO,SAAS,IAAI;AACtB;","names":[]}
|
|
1
|
+
{"version":3,"sources":["../../src/lib/generateReadmeFiles.ts","../../src/lib/yarn/workspace/yarnWorkspaces.ts","../../src/lib/yarn/workspace/yarnWorkspace.ts","../../src/lib/yarn/yarnInitCwd.ts"],"sourcesContent":["import { execSync } from 'node:child_process'\nimport FS, { readFileSync } from 'node:fs'\nimport {\n mkdir, readFile, writeFile,\n} from 'node:fs/promises'\nimport { createRequire } from 'node:module'\nimport PATH from 'node:path'\nimport { createInterface } from 'node:readline'\n\nimport chalk from 'chalk'\n\nimport {\n INIT_CWD, yarnWorkspace, yarnWorkspaces,\n} from './yarn/index.ts'\n\nconst require = createRequire(import.meta.url)\nconst packageRoot = PATH.dirname(require.resolve('@xylabs/ts-scripts-yarn3/package.json'))\nconst readmeTemplatesDir = PATH.resolve(packageRoot, 'templates', 'readme')\n\ninterface GenerateReadmeFilesParams {\n logoLinkUrl?: string\n logoUrl?: string\n pkg?: string\n templatePath?: string\n typedoc?: boolean\n verbose?: boolean\n}\n\nfunction fillTemplate(template: string, data: Record<string, string>): string {\n const additionalData: Record<string, string> = { ...data, safeName: data.name.replaceAll('/', '__').replaceAll('@', '') }\n return template.replaceAll(/\\{\\{(.*?)\\}\\}/g, (_, key: string) => additionalData[key.trim()] ?? '')\n}\n\nfunction generateTypedoc(packageLocation: string, entryPoints: string[]): string {\n const tempDir = PATH.join(packageLocation, '.temp-typedoc')\n\n try {\n if (!FS.existsSync(tempDir)) {\n FS.mkdirSync(tempDir, { recursive: true })\n }\n\n const typedocConfig = {\n disableSources: true,\n entryPointStrategy: 'expand',\n entryPoints: entryPoints.map(ep => PATH.resolve(packageLocation, ep)),\n excludeExternals: true,\n excludeInternal: true,\n excludePrivate: true,\n githubPages: false,\n hideBreadcrumbs: true,\n hideGenerator: true,\n hidePageTitle: true,\n out: tempDir,\n plugin: ['typedoc-plugin-markdown'],\n readme: 'none',\n skipErrorChecking: true,\n sort: ['source-order'],\n theme: 'markdown',\n useCodeBlocks: true,\n }\n\n const typedocJsonPath = PATH.join(tempDir, 'typedoc.json')\n FS.writeFileSync(typedocJsonPath, JSON.stringify(typedocConfig, null, 2))\n\n try {\n execSync(`npx typedoc --options ${typedocJsonPath}`, {\n cwd: process.cwd(),\n stdio: ['ignore', 'pipe', 'pipe'],\n })\n } catch {\n return ''\n }\n\n return consolidateMarkdown(tempDir)\n } catch {\n return ''\n } finally {\n try {\n FS.rmSync(tempDir, { force: true, recursive: true })\n } catch {\n // ignore cleanup errors\n }\n }\n}\n\nfunction consolidateMarkdown(tempDir: string): string {\n let consolidated = '## Reference\\n\\n'\n\n const mainReadmePath = PATH.join(tempDir, 'README.md')\n if (FS.existsSync(mainReadmePath)) {\n const mainContent = FS.readFileSync(mainReadmePath, 'utf8')\n .replace(/^---(.|\\n)*?---\\n/, '')\n .replace(/^# .+\\n/, '')\n .replaceAll(/\\]\\((.+?)\\.md\\)/g, '](#$1)')\n\n consolidated += mainContent + '\\n\\n'\n }\n\n consolidated += processDirectory(tempDir)\n\n return consolidated\n .replaceAll(/\\n\\n\\n+/g, '\\n\\n')\n .replaceAll(/^#### /gm, '### ')\n .replaceAll(/^##### /gm, '#### ')\n .replaceAll(/^###### /gm, '##### ')\n}\n\nfunction processDirectory(dir: string, level = 0): string {\n const indent = ' '.repeat(level)\n let content = ''\n\n try {\n const items = FS.readdirSync(dir, { withFileTypes: true })\n\n for (const item of items) {\n if (item.isDirectory()) continue\n if (item.name === 'README.md' || !item.name.endsWith('.md')) continue\n\n const fileContent = FS.readFileSync(PATH.join(dir, item.name), 'utf8')\n .replace(/^---(.|\\n)*?---\\n/, '')\n const moduleName = item.name.replace('.md', '')\n\n content += `\\n\\n${indent}### <a id=\"${moduleName}\"></a>${moduleName}\\n\\n`\n content += fileContent\n .replace(/^# .+\\n/, '')\n .replaceAll(/\\]\\((.+?)\\.md\\)/g, '](#$1)')\n }\n\n for (const item of items) {\n if (!item.isDirectory()) continue\n if (item.name === 'spec' || item.name.includes('.spec')) continue\n\n content += `\\n\\n${indent}### ${item.name}\\n`\n content += processDirectory(PATH.join(dir, item.name), level + 1)\n }\n } catch {\n // skip unreadable directories\n }\n\n return content\n}\n\nfunction askConfirmation(question: string): Promise<boolean> {\n const rl = createInterface({ input: process.stdin, output: process.stdout })\n return new Promise((resolve) => {\n rl.question(question, (answer) => {\n rl.close()\n resolve(answer.toLowerCase() === 'y' || answer.toLowerCase() === 'yes')\n })\n })\n}\n\nexport const DEFAULT_README_TEMPLATE = readFileSync(PATH.resolve(readmeTemplatesDir, 'README.template.md'), 'utf8')\nexport const DEFAULT_README_BODY = readFileSync(PATH.resolve(readmeTemplatesDir, 'README.body.md'), 'utf8')\n\nexport function applyLogoConfig(template: string, logoUrl?: string, logoLinkUrl?: string): string {\n let result = template\n if (logoUrl) {\n result = result.replace(/\\[logo]: .+/, `[logo]: ${logoUrl}`)\n if (logoLinkUrl) {\n result = result.replace(/\\[!\\[logo]\\[]][^)]*\\)/, `[![logo][]](${logoLinkUrl})`)\n }\n } else {\n result = result.replace(/\\[!\\[logo]\\[]][^\\n]*\\n*/, '')\n result = result.replace(/\\[logo]: [^\\n]*\\n?/, '')\n }\n return result\n}\n\nexport function resolveTemplatePath(templatePath: string | undefined): string {\n const cwd = INIT_CWD() ?? '.'\n return templatePath ?? PATH.join(cwd, '.xy', 'README.template.md')\n}\n\nasync function loadOrCreateTemplate(resolvedTemplatePath: string): Promise<{\n created: boolean\n template: string\n}> {\n try {\n const template = await readFile(resolvedTemplatePath, 'utf8')\n return { created: false, template }\n } catch {\n console.log(chalk.yellow(`Template not found: ${resolvedTemplatePath}`))\n const shouldCreate = await askConfirmation('Would you like to create a stock template? (y/N) ')\n if (!shouldCreate) {\n throw new Error('Template creation declined')\n }\n const template = DEFAULT_README_TEMPLATE\n await scaffoldTemplate(resolvedTemplatePath, template)\n return { created: true, template }\n }\n}\n\nexport async function scaffoldTemplate(resolvedTemplatePath: string, template: string): Promise<void> {\n const xyDir = PATH.dirname(resolvedTemplatePath)\n await mkdir(xyDir, { recursive: true })\n await writeFile(resolvedTemplatePath, template)\n console.log(chalk.green(`Created template: ${resolvedTemplatePath}`))\n const bodyPath = PATH.join(xyDir, 'README.body.md')\n await writeFile(bodyPath, DEFAULT_README_BODY)\n console.log(chalk.green(`Created body template: ${bodyPath}`))\n}\n\nasync function resolveBody(location: string, defaultBody: string): Promise<string> {\n const localBodyPath = PATH.join(location, 'README.body.md')\n try {\n return await readFile(localBodyPath, 'utf8')\n } catch {\n return defaultBody\n }\n}\n\nasync function generateReadmeForWorkspace(\n location: string,\n name: string,\n template: string,\n defaultBody: string,\n typedoc: boolean,\n verbose: boolean,\n): Promise<boolean> {\n try {\n const pkgJsonPath = PATH.join(location, 'package.json')\n const pkgJson = JSON.parse(await readFile(pkgJsonPath, 'utf8'))\n const body = await resolveBody(location, defaultBody)\n const typedocContent = typedoc ? generateTypedoc(location, ['src/index*.ts']) : ''\n const readmeContent = fillTemplate(template, {\n ...pkgJson, body, typedoc: typedocContent,\n })\n await writeFile(PATH.join(location, 'README.md'), readmeContent)\n if (verbose) console.log(chalk.green(` ${name}`))\n return true\n } catch (ex) {\n const error = ex as Error\n console.warn(chalk.yellow(` Skipped ${location}: ${error.message}`))\n return false\n }\n}\n\nexport async function generateReadmeFiles({\n logoLinkUrl, logoUrl, pkg, templatePath, typedoc = false, verbose = false,\n}: GenerateReadmeFilesParams): Promise<number> {\n console.log(chalk.green('Generate README Files'))\n const resolvedTemplatePath = resolveTemplatePath(templatePath)\n\n let template: string\n let templateCreated: boolean\n try {\n ({ template, created: templateCreated } = await loadOrCreateTemplate(resolvedTemplatePath))\n } catch {\n return 1\n }\n\n template = applyLogoConfig(template, logoUrl, logoLinkUrl)\n\n if (templateCreated) {\n console.log(chalk.green('Generating README files for all packages...'))\n }\n\n const xyDir = PATH.dirname(resolvedTemplatePath)\n const xyBodyPath = PATH.join(xyDir, 'README.body.md')\n let defaultBody: string\n try {\n defaultBody = await readFile(xyBodyPath, 'utf8')\n } catch {\n defaultBody = DEFAULT_README_BODY\n }\n\n const workspaces = pkg && !templateCreated ? [yarnWorkspace(pkg)] : yarnWorkspaces()\n let failed = false\n\n for (const { location, name } of workspaces) {\n const success = await generateReadmeForWorkspace(location, name, template, defaultBody, typedoc, verbose)\n if (!success) failed = true\n }\n\n return failed ? 1 : 0\n}\n","import { spawnSync } from 'node:child_process'\n\nimport type { Workspace } from './Workspace.ts'\n\nexport const yarnWorkspaces = (): Workspace[] => {\n const result = spawnSync('yarn', ['workspaces', 'list', '--json', '--recursive'], { encoding: 'utf8', shell: true })\n if (result.error) {\n throw result.error\n }\n return (\n result.stdout\n .toString()\n // NOTE: This probably doesn't work on Windows\n // TODO: Replace /r/n with /n first\n .split('\\n')\n .slice(0, -1)\n .map((item) => {\n return JSON.parse(item)\n })\n )\n}\n","import type { Workspace } from './Workspace.ts'\nimport { yarnWorkspaces } from './yarnWorkspaces.ts'\n\nexport const yarnWorkspace = (pkg: string): Workspace => {\n const workspace = yarnWorkspaces().find(({ name }) => name === pkg)\n if (!workspace) throw new Error(`Workspace ${pkg} not found`)\n return workspace\n}\n","export const INIT_CWD = () => {\n if (!process.env.INIT_CWD) console.error('Missing INIT_CWD')\n return process.env.INIT_CWD\n}\n"],"mappings":";AAAA,SAAS,gBAAgB;AACzB,OAAO,MAAM,oBAAoB;AACjC;AAAA,EACE;AAAA,EAAO;AAAA,EAAU;AAAA,OACZ;AACP,SAAS,qBAAqB;AAC9B,OAAO,UAAU;AACjB,SAAS,uBAAuB;AAEhC,OAAO,WAAW;;;ACTlB,SAAS,iBAAiB;AAInB,IAAM,iBAAiB,MAAmB;AAC/C,QAAM,SAAS,UAAU,QAAQ,CAAC,cAAc,QAAQ,UAAU,aAAa,GAAG,EAAE,UAAU,QAAQ,OAAO,KAAK,CAAC;AACnH,MAAI,OAAO,OAAO;AAChB,UAAM,OAAO;AAAA,EACf;AACA,SACE,OAAO,OACJ,SAAS,EAGT,MAAM,IAAI,EACV,MAAM,GAAG,EAAE,EACX,IAAI,CAAC,SAAS;AACb,WAAO,KAAK,MAAM,IAAI;AAAA,EACxB,CAAC;AAEP;;;ACjBO,IAAM,gBAAgB,CAAC,QAA2B;AACvD,QAAM,YAAY,eAAe,EAAE,KAAK,CAAC,EAAE,KAAK,MAAM,SAAS,GAAG;AAClE,MAAI,CAAC,UAAW,OAAM,IAAI,MAAM,aAAa,GAAG,YAAY;AAC5D,SAAO;AACT;;;ACPO,IAAM,WAAW,MAAM;AAC5B,MAAI,CAAC,QAAQ,IAAI,SAAU,SAAQ,MAAM,kBAAkB;AAC3D,SAAO,QAAQ,IAAI;AACrB;;;AHYA,IAAMA,WAAU,cAAc,YAAY,GAAG;AAC7C,IAAM,cAAc,KAAK,QAAQA,SAAQ,QAAQ,uCAAuC,CAAC;AACzF,IAAM,qBAAqB,KAAK,QAAQ,aAAa,aAAa,QAAQ;AAW1E,SAAS,aAAa,UAAkB,MAAsC;AAC5E,QAAM,iBAAyC,EAAE,GAAG,MAAM,UAAU,KAAK,KAAK,WAAW,KAAK,IAAI,EAAE,WAAW,KAAK,EAAE,EAAE;AACxH,SAAO,SAAS,WAAW,kBAAkB,CAAC,GAAG,QAAgB,eAAe,IAAI,KAAK,CAAC,KAAK,EAAE;AACnG;AAEA,SAAS,gBAAgB,iBAAyB,aAA+B;AAC/E,QAAM,UAAU,KAAK,KAAK,iBAAiB,eAAe;AAE1D,MAAI;AACF,QAAI,CAAC,GAAG,WAAW,OAAO,GAAG;AAC3B,SAAG,UAAU,SAAS,EAAE,WAAW,KAAK,CAAC;AAAA,IAC3C;AAEA,UAAM,gBAAgB;AAAA,MACpB,gBAAgB;AAAA,MAChB,oBAAoB;AAAA,MACpB,aAAa,YAAY,IAAI,QAAM,KAAK,QAAQ,iBAAiB,EAAE,CAAC;AAAA,MACpE,kBAAkB;AAAA,MAClB,iBAAiB;AAAA,MACjB,gBAAgB;AAAA,MAChB,aAAa;AAAA,MACb,iBAAiB;AAAA,MACjB,eAAe;AAAA,MACf,eAAe;AAAA,MACf,KAAK;AAAA,MACL,QAAQ,CAAC,yBAAyB;AAAA,MAClC,QAAQ;AAAA,MACR,mBAAmB;AAAA,MACnB,MAAM,CAAC,cAAc;AAAA,MACrB,OAAO;AAAA,MACP,eAAe;AAAA,IACjB;AAEA,UAAM,kBAAkB,KAAK,KAAK,SAAS,cAAc;AACzD,OAAG,cAAc,iBAAiB,KAAK,UAAU,eAAe,MAAM,CAAC,CAAC;AAExE,QAAI;AACF,eAAS,yBAAyB,eAAe,IAAI;AAAA,QACnD,KAAK,QAAQ,IAAI;AAAA,QACjB,OAAO,CAAC,UAAU,QAAQ,MAAM;AAAA,MAClC,CAAC;AAAA,IACH,QAAQ;AACN,aAAO;AAAA,IACT;AAEA,WAAO,oBAAoB,OAAO;AAAA,EACpC,QAAQ;AACN,WAAO;AAAA,EACT,UAAE;AACA,QAAI;AACF,SAAG,OAAO,SAAS,EAAE,OAAO,MAAM,WAAW,KAAK,CAAC;AAAA,IACrD,QAAQ;AAAA,IAER;AAAA,EACF;AACF;AAEA,SAAS,oBAAoB,SAAyB;AACpD,MAAI,eAAe;AAEnB,QAAM,iBAAiB,KAAK,KAAK,SAAS,WAAW;AACrD,MAAI,GAAG,WAAW,cAAc,GAAG;AACjC,UAAM,cAAc,GAAG,aAAa,gBAAgB,MAAM,EACvD,QAAQ,qBAAqB,EAAE,EAC/B,QAAQ,WAAW,EAAE,EACrB,WAAW,oBAAoB,QAAQ;AAE1C,oBAAgB,cAAc;AAAA,EAChC;AAEA,kBAAgB,iBAAiB,OAAO;AAExC,SAAO,aACJ,WAAW,YAAY,MAAM,EAC7B,WAAW,YAAY,MAAM,EAC7B,WAAW,aAAa,OAAO,EAC/B,WAAW,cAAc,QAAQ;AACtC;AAEA,SAAS,iBAAiB,KAAa,QAAQ,GAAW;AACxD,QAAM,SAAS,KAAK,OAAO,KAAK;AAChC,MAAI,UAAU;AAEd,MAAI;AACF,UAAM,QAAQ,GAAG,YAAY,KAAK,EAAE,eAAe,KAAK,CAAC;AAEzD,eAAW,QAAQ,OAAO;AACxB,UAAI,KAAK,YAAY,EAAG;AACxB,UAAI,KAAK,SAAS,eAAe,CAAC,KAAK,KAAK,SAAS,KAAK,EAAG;AAE7D,YAAM,cAAc,GAAG,aAAa,KAAK,KAAK,KAAK,KAAK,IAAI,GAAG,MAAM,EAClE,QAAQ,qBAAqB,EAAE;AAClC,YAAM,aAAa,KAAK,KAAK,QAAQ,OAAO,EAAE;AAE9C,iBAAW;AAAA;AAAA,EAAO,MAAM,cAAc,UAAU,SAAS,UAAU;AAAA;AAAA;AACnE,iBAAW,YACR,QAAQ,WAAW,EAAE,EACrB,WAAW,oBAAoB,QAAQ;AAAA,IAC5C;AAEA,eAAW,QAAQ,OAAO;AACxB,UAAI,CAAC,KAAK,YAAY,EAAG;AACzB,UAAI,KAAK,SAAS,UAAU,KAAK,KAAK,SAAS,OAAO,EAAG;AAEzD,iBAAW;AAAA;AAAA,EAAO,MAAM,OAAO,KAAK,IAAI;AAAA;AACxC,iBAAW,iBAAiB,KAAK,KAAK,KAAK,KAAK,IAAI,GAAG,QAAQ,CAAC;AAAA,IAClE;AAAA,EACF,QAAQ;AAAA,EAER;AAEA,SAAO;AACT;AAEA,SAAS,gBAAgB,UAAoC;AAC3D,QAAM,KAAK,gBAAgB,EAAE,OAAO,QAAQ,OAAO,QAAQ,QAAQ,OAAO,CAAC;AAC3E,SAAO,IAAI,QAAQ,CAAC,YAAY;AAC9B,OAAG,SAAS,UAAU,CAAC,WAAW;AAChC,SAAG,MAAM;AACT,cAAQ,OAAO,YAAY,MAAM,OAAO,OAAO,YAAY,MAAM,KAAK;AAAA,IACxE,CAAC;AAAA,EACH,CAAC;AACH;AAEO,IAAM,0BAA0B,aAAa,KAAK,QAAQ,oBAAoB,oBAAoB,GAAG,MAAM;AAC3G,IAAM,sBAAsB,aAAa,KAAK,QAAQ,oBAAoB,gBAAgB,GAAG,MAAM;AAEnG,SAAS,gBAAgB,UAAkB,SAAkB,aAA8B;AAChG,MAAI,SAAS;AACb,MAAI,SAAS;AACX,aAAS,OAAO,QAAQ,eAAe,WAAW,OAAO,EAAE;AAC3D,QAAI,aAAa;AACf,eAAS,OAAO,QAAQ,yBAAyB,eAAe,WAAW,GAAG;AAAA,IAChF;AAAA,EACF,OAAO;AACL,aAAS,OAAO,QAAQ,2BAA2B,EAAE;AACrD,aAAS,OAAO,QAAQ,sBAAsB,EAAE;AAAA,EAClD;AACA,SAAO;AACT;AAEO,SAAS,oBAAoB,cAA0C;AAC5E,QAAM,MAAM,SAAS,KAAK;AAC1B,SAAO,gBAAgB,KAAK,KAAK,KAAK,OAAO,oBAAoB;AACnE;AAEA,eAAe,qBAAqB,sBAGjC;AACD,MAAI;AACF,UAAM,WAAW,MAAM,SAAS,sBAAsB,MAAM;AAC5D,WAAO,EAAE,SAAS,OAAO,SAAS;AAAA,EACpC,QAAQ;AACN,YAAQ,IAAI,MAAM,OAAO,uBAAuB,oBAAoB,EAAE,CAAC;AACvE,UAAM,eAAe,MAAM,gBAAgB,mDAAmD;AAC9F,QAAI,CAAC,cAAc;AACjB,YAAM,IAAI,MAAM,4BAA4B;AAAA,IAC9C;AACA,UAAM,WAAW;AACjB,UAAM,iBAAiB,sBAAsB,QAAQ;AACrD,WAAO,EAAE,SAAS,MAAM,SAAS;AAAA,EACnC;AACF;AAEA,eAAsB,iBAAiB,sBAA8B,UAAiC;AACpG,QAAM,QAAQ,KAAK,QAAQ,oBAAoB;AAC/C,QAAM,MAAM,OAAO,EAAE,WAAW,KAAK,CAAC;AACtC,QAAM,UAAU,sBAAsB,QAAQ;AAC9C,UAAQ,IAAI,MAAM,MAAM,qBAAqB,oBAAoB,EAAE,CAAC;AACpE,QAAM,WAAW,KAAK,KAAK,OAAO,gBAAgB;AAClD,QAAM,UAAU,UAAU,mBAAmB;AAC7C,UAAQ,IAAI,MAAM,MAAM,0BAA0B,QAAQ,EAAE,CAAC;AAC/D;AAEA,eAAe,YAAY,UAAkB,aAAsC;AACjF,QAAM,gBAAgB,KAAK,KAAK,UAAU,gBAAgB;AAC1D,MAAI;AACF,WAAO,MAAM,SAAS,eAAe,MAAM;AAAA,EAC7C,QAAQ;AACN,WAAO;AAAA,EACT;AACF;AAEA,eAAe,2BACb,UACA,MACA,UACA,aACA,SACA,SACkB;AAClB,MAAI;AACF,UAAM,cAAc,KAAK,KAAK,UAAU,cAAc;AACtD,UAAM,UAAU,KAAK,MAAM,MAAM,SAAS,aAAa,MAAM,CAAC;AAC9D,UAAM,OAAO,MAAM,YAAY,UAAU,WAAW;AACpD,UAAM,iBAAiB,UAAU,gBAAgB,UAAU,CAAC,eAAe,CAAC,IAAI;AAChF,UAAM,gBAAgB,aAAa,UAAU;AAAA,MAC3C,GAAG;AAAA,MAAS;AAAA,MAAM,SAAS;AAAA,IAC7B,CAAC;AACD,UAAM,UAAU,KAAK,KAAK,UAAU,WAAW,GAAG,aAAa;AAC/D,QAAI,QAAS,SAAQ,IAAI,MAAM,MAAM,KAAK,IAAI,EAAE,CAAC;AACjD,WAAO;AAAA,EACT,SAAS,IAAI;AACX,UAAM,QAAQ;AACd,YAAQ,KAAK,MAAM,OAAO,aAAa,QAAQ,KAAK,MAAM,OAAO,EAAE,CAAC;AACpE,WAAO;AAAA,EACT;AACF;AAEA,eAAsB,oBAAoB;AAAA,EACxC;AAAA,EAAa;AAAA,EAAS;AAAA,EAAK;AAAA,EAAc,UAAU;AAAA,EAAO,UAAU;AACtE,GAA+C;AAC7C,UAAQ,IAAI,MAAM,MAAM,uBAAuB,CAAC;AAChD,QAAM,uBAAuB,oBAAoB,YAAY;AAE7D,MAAI;AACJ,MAAI;AACJ,MAAI;AACF,KAAC,EAAE,UAAU,SAAS,gBAAgB,IAAI,MAAM,qBAAqB,oBAAoB;AAAA,EAC3F,QAAQ;AACN,WAAO;AAAA,EACT;AAEA,aAAW,gBAAgB,UAAU,SAAS,WAAW;AAEzD,MAAI,iBAAiB;AACnB,YAAQ,IAAI,MAAM,MAAM,6CAA6C,CAAC;AAAA,EACxE;AAEA,QAAM,QAAQ,KAAK,QAAQ,oBAAoB;AAC/C,QAAM,aAAa,KAAK,KAAK,OAAO,gBAAgB;AACpD,MAAI;AACJ,MAAI;AACF,kBAAc,MAAM,SAAS,YAAY,MAAM;AAAA,EACjD,QAAQ;AACN,kBAAc;AAAA,EAChB;AAEA,QAAM,aAAa,OAAO,CAAC,kBAAkB,CAAC,cAAc,GAAG,CAAC,IAAI,eAAe;AACnF,MAAI,SAAS;AAEb,aAAW,EAAE,UAAU,KAAK,KAAK,YAAY;AAC3C,UAAM,UAAU,MAAM,2BAA2B,UAAU,MAAM,UAAU,aAAa,SAAS,OAAO;AACxG,QAAI,CAAC,QAAS,UAAS;AAAA,EACzB;AAEA,SAAO,SAAS,IAAI;AACtB;","names":["require"]}
|
package/dist/lib/index.mjs
CHANGED
|
@@ -17,7 +17,7 @@ import { createRequire } from "module";
|
|
|
17
17
|
import PATH from "path";
|
|
18
18
|
var require2 = createRequire(import.meta.url);
|
|
19
19
|
var packageRoot = PATH.dirname(require2.resolve("@xylabs/ts-scripts-yarn3/package.json"));
|
|
20
|
-
var templatesDir = PATH.resolve(packageRoot, "templates");
|
|
20
|
+
var templatesDir = PATH.resolve(packageRoot, "templates", "claude");
|
|
21
21
|
var XYLABS_RULES_PREFIX = "xylabs-";
|
|
22
22
|
var XYLABS_COMMANDS_PREFIX = "xylabs-";
|
|
23
23
|
var claudeMdRuleTemplates = () => {
|
|
@@ -378,10 +378,19 @@ var generateIgnoreFiles = (filename, pkg) => {
|
|
|
378
378
|
|
|
379
379
|
// src/lib/generateReadmeFiles.ts
|
|
380
380
|
import { execSync as execSync2 } from "child_process";
|
|
381
|
-
import FS from "fs";
|
|
382
|
-
import {
|
|
381
|
+
import FS, { readFileSync as readFileSync5 } from "fs";
|
|
382
|
+
import {
|
|
383
|
+
mkdir,
|
|
384
|
+
readFile,
|
|
385
|
+
writeFile
|
|
386
|
+
} from "fs/promises";
|
|
387
|
+
import { createRequire as createRequire2 } from "module";
|
|
383
388
|
import PATH2 from "path";
|
|
389
|
+
import { createInterface } from "readline";
|
|
384
390
|
import chalk5 from "chalk";
|
|
391
|
+
var require3 = createRequire2(import.meta.url);
|
|
392
|
+
var packageRoot2 = PATH2.dirname(require3.resolve("@xylabs/ts-scripts-yarn3/package.json"));
|
|
393
|
+
var readmeTemplatesDir = PATH2.resolve(packageRoot2, "templates", "readme");
|
|
385
394
|
function fillTemplate(template, data) {
|
|
386
395
|
const additionalData = { ...data, safeName: data.name.replaceAll("/", "__").replaceAll("@", "") };
|
|
387
396
|
return template.replaceAll(/\{\{(.*?)\}\}/g, (_, key) => additionalData[key.trim()] ?? "");
|
|
@@ -471,37 +480,120 @@ ${indent}### ${item.name}
|
|
|
471
480
|
}
|
|
472
481
|
return content;
|
|
473
482
|
}
|
|
483
|
+
function askConfirmation(question) {
|
|
484
|
+
const rl = createInterface({ input: process.stdin, output: process.stdout });
|
|
485
|
+
return new Promise((resolve) => {
|
|
486
|
+
rl.question(question, (answer) => {
|
|
487
|
+
rl.close();
|
|
488
|
+
resolve(answer.toLowerCase() === "y" || answer.toLowerCase() === "yes");
|
|
489
|
+
});
|
|
490
|
+
});
|
|
491
|
+
}
|
|
492
|
+
var DEFAULT_README_TEMPLATE = readFileSync5(PATH2.resolve(readmeTemplatesDir, "README.template.md"), "utf8");
|
|
493
|
+
var DEFAULT_README_BODY = readFileSync5(PATH2.resolve(readmeTemplatesDir, "README.body.md"), "utf8");
|
|
494
|
+
function applyLogoConfig(template, logoUrl, logoLinkUrl) {
|
|
495
|
+
let result = template;
|
|
496
|
+
if (logoUrl) {
|
|
497
|
+
result = result.replace(/\[logo]: .+/, `[logo]: ${logoUrl}`);
|
|
498
|
+
if (logoLinkUrl) {
|
|
499
|
+
result = result.replace(/\[!\[logo]\[]][^)]*\)/, `[![logo][]](${logoLinkUrl})`);
|
|
500
|
+
}
|
|
501
|
+
} else {
|
|
502
|
+
result = result.replace(/\[!\[logo]\[]][^\n]*\n*/, "");
|
|
503
|
+
result = result.replace(/\[logo]: [^\n]*\n?/, "");
|
|
504
|
+
}
|
|
505
|
+
return result;
|
|
506
|
+
}
|
|
507
|
+
function resolveTemplatePath(templatePath) {
|
|
508
|
+
const cwd = INIT_CWD() ?? ".";
|
|
509
|
+
return templatePath ?? PATH2.join(cwd, ".xy", "README.template.md");
|
|
510
|
+
}
|
|
511
|
+
async function loadOrCreateTemplate(resolvedTemplatePath) {
|
|
512
|
+
try {
|
|
513
|
+
const template = await readFile(resolvedTemplatePath, "utf8");
|
|
514
|
+
return { created: false, template };
|
|
515
|
+
} catch {
|
|
516
|
+
console.log(chalk5.yellow(`Template not found: ${resolvedTemplatePath}`));
|
|
517
|
+
const shouldCreate = await askConfirmation("Would you like to create a stock template? (y/N) ");
|
|
518
|
+
if (!shouldCreate) {
|
|
519
|
+
throw new Error("Template creation declined");
|
|
520
|
+
}
|
|
521
|
+
const template = DEFAULT_README_TEMPLATE;
|
|
522
|
+
await scaffoldTemplate(resolvedTemplatePath, template);
|
|
523
|
+
return { created: true, template };
|
|
524
|
+
}
|
|
525
|
+
}
|
|
526
|
+
async function scaffoldTemplate(resolvedTemplatePath, template) {
|
|
527
|
+
const xyDir = PATH2.dirname(resolvedTemplatePath);
|
|
528
|
+
await mkdir(xyDir, { recursive: true });
|
|
529
|
+
await writeFile(resolvedTemplatePath, template);
|
|
530
|
+
console.log(chalk5.green(`Created template: ${resolvedTemplatePath}`));
|
|
531
|
+
const bodyPath = PATH2.join(xyDir, "README.body.md");
|
|
532
|
+
await writeFile(bodyPath, DEFAULT_README_BODY);
|
|
533
|
+
console.log(chalk5.green(`Created body template: ${bodyPath}`));
|
|
534
|
+
}
|
|
535
|
+
async function resolveBody(location, defaultBody) {
|
|
536
|
+
const localBodyPath = PATH2.join(location, "README.body.md");
|
|
537
|
+
try {
|
|
538
|
+
return await readFile(localBodyPath, "utf8");
|
|
539
|
+
} catch {
|
|
540
|
+
return defaultBody;
|
|
541
|
+
}
|
|
542
|
+
}
|
|
543
|
+
async function generateReadmeForWorkspace(location, name, template, defaultBody, typedoc, verbose) {
|
|
544
|
+
try {
|
|
545
|
+
const pkgJsonPath = PATH2.join(location, "package.json");
|
|
546
|
+
const pkgJson = JSON.parse(await readFile(pkgJsonPath, "utf8"));
|
|
547
|
+
const body = await resolveBody(location, defaultBody);
|
|
548
|
+
const typedocContent = typedoc ? generateTypedoc(location, ["src/index*.ts"]) : "";
|
|
549
|
+
const readmeContent = fillTemplate(template, {
|
|
550
|
+
...pkgJson,
|
|
551
|
+
body,
|
|
552
|
+
typedoc: typedocContent
|
|
553
|
+
});
|
|
554
|
+
await writeFile(PATH2.join(location, "README.md"), readmeContent);
|
|
555
|
+
if (verbose) console.log(chalk5.green(` ${name}`));
|
|
556
|
+
return true;
|
|
557
|
+
} catch (ex) {
|
|
558
|
+
const error = ex;
|
|
559
|
+
console.warn(chalk5.yellow(` Skipped ${location}: ${error.message}`));
|
|
560
|
+
return false;
|
|
561
|
+
}
|
|
562
|
+
}
|
|
474
563
|
async function generateReadmeFiles({
|
|
564
|
+
logoLinkUrl,
|
|
565
|
+
logoUrl,
|
|
475
566
|
pkg,
|
|
476
567
|
templatePath,
|
|
477
568
|
typedoc = false,
|
|
478
|
-
verbose
|
|
569
|
+
verbose = false
|
|
479
570
|
}) {
|
|
480
571
|
console.log(chalk5.green("Generate README Files"));
|
|
481
|
-
const
|
|
482
|
-
const resolvedTemplatePath = templatePath ?? PATH2.join(cwd, "scripts", "README.template.md");
|
|
572
|
+
const resolvedTemplatePath = resolveTemplatePath(templatePath);
|
|
483
573
|
let template;
|
|
574
|
+
let templateCreated;
|
|
484
575
|
try {
|
|
485
|
-
template = await
|
|
576
|
+
({ template, created: templateCreated } = await loadOrCreateTemplate(resolvedTemplatePath));
|
|
486
577
|
} catch {
|
|
487
|
-
console.error(chalk5.red(`Template not found: ${resolvedTemplatePath}`));
|
|
488
578
|
return 1;
|
|
489
579
|
}
|
|
490
|
-
|
|
580
|
+
template = applyLogoConfig(template, logoUrl, logoLinkUrl);
|
|
581
|
+
if (templateCreated) {
|
|
582
|
+
console.log(chalk5.green("Generating README files for all packages..."));
|
|
583
|
+
}
|
|
584
|
+
const xyDir = PATH2.dirname(resolvedTemplatePath);
|
|
585
|
+
const xyBodyPath = PATH2.join(xyDir, "README.body.md");
|
|
586
|
+
let defaultBody;
|
|
587
|
+
try {
|
|
588
|
+
defaultBody = await readFile(xyBodyPath, "utf8");
|
|
589
|
+
} catch {
|
|
590
|
+
defaultBody = DEFAULT_README_BODY;
|
|
591
|
+
}
|
|
592
|
+
const workspaces = pkg && !templateCreated ? [yarnWorkspace(pkg)] : yarnWorkspaces();
|
|
491
593
|
let failed = false;
|
|
492
594
|
for (const { location, name } of workspaces) {
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
const pkgJson = JSON.parse(await readFile(pkgJsonPath, "utf8"));
|
|
496
|
-
const typedocContent = typedoc ? generateTypedoc(location, ["src/index*.ts"]) : "";
|
|
497
|
-
const readmeContent = fillTemplate(template, { ...pkgJson, typedoc: typedocContent });
|
|
498
|
-
await writeFile(PATH2.join(location, "README.md"), readmeContent);
|
|
499
|
-
if (verbose) console.log(chalk5.green(` ${name}`));
|
|
500
|
-
} catch (ex) {
|
|
501
|
-
const error = ex;
|
|
502
|
-
console.warn(chalk5.yellow(` Skipped ${location}: ${error.message}`));
|
|
503
|
-
failed = true;
|
|
504
|
-
}
|
|
595
|
+
const success = await generateReadmeForWorkspace(location, name, template, defaultBody, typedoc, verbose);
|
|
596
|
+
if (!success) failed = true;
|
|
505
597
|
}
|
|
506
598
|
return failed ? 1 : 0;
|
|
507
599
|
}
|
|
@@ -528,10 +620,10 @@ var loadConfig = async (params) => {
|
|
|
528
620
|
};
|
|
529
621
|
|
|
530
622
|
// src/lib/parsedPackageJSON.ts
|
|
531
|
-
import { readFileSync as
|
|
623
|
+
import { readFileSync as readFileSync6 } from "fs";
|
|
532
624
|
var parsedPackageJSON = (path) => {
|
|
533
625
|
const pathToPackageJSON = path ?? process.env.npm_package_json ?? "";
|
|
534
|
-
const packageJSON =
|
|
626
|
+
const packageJSON = readFileSync6(pathToPackageJSON).toString();
|
|
535
627
|
return JSON.parse(packageJSON);
|
|
536
628
|
};
|
|
537
629
|
|
|
@@ -633,11 +725,14 @@ var runXyWithWarning = (command) => {
|
|
|
633
725
|
};
|
|
634
726
|
export {
|
|
635
727
|
CROSS_PLATFORM_NEWLINE,
|
|
728
|
+
DEFAULT_README_BODY,
|
|
729
|
+
DEFAULT_README_TEMPLATE,
|
|
636
730
|
DuplicateDetector,
|
|
637
731
|
INIT_CWD,
|
|
638
732
|
WINDOWS_NEWLINE_REGEX,
|
|
639
733
|
XYLABS_COMMANDS_PREFIX,
|
|
640
734
|
XYLABS_RULES_PREFIX,
|
|
735
|
+
applyLogoConfig,
|
|
641
736
|
checkResult,
|
|
642
737
|
claudeCommandTemplates,
|
|
643
738
|
claudeMdProjectTemplate,
|
|
@@ -658,6 +753,7 @@ export {
|
|
|
658
753
|
processEx,
|
|
659
754
|
readLines,
|
|
660
755
|
readNonEmptyLines,
|
|
756
|
+
resolveTemplatePath,
|
|
661
757
|
runStepAsync,
|
|
662
758
|
runSteps,
|
|
663
759
|
runStepsAsync,
|
|
@@ -665,6 +761,7 @@ export {
|
|
|
665
761
|
runXyWithWarning,
|
|
666
762
|
safeExit,
|
|
667
763
|
safeExitAsync,
|
|
764
|
+
scaffoldTemplate,
|
|
668
765
|
tryReadFileSync,
|
|
669
766
|
union,
|
|
670
767
|
withErrnoException,
|