@nshiab/setup-data-project 2.0.3 → 3.0.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 +76 -28
- package/dist/main.mjs +849 -0
- package/dist/main.mjs.map +1 -0
- package/package.json +29 -18
- package/esm/_dnt.shims.d.ts +0 -2
- package/esm/_dnt.shims.d.ts.map +0 -1
- package/esm/_dnt.shims.js +0 -57
- package/esm/helpers/combinePlotDocs.d.ts +0 -2
- package/esm/helpers/combinePlotDocs.d.ts.map +0 -1
- package/esm/helpers/combinePlotDocs.js +0 -111
- package/esm/helpers/createFolderStructure.d.ts +0 -2
- package/esm/helpers/createFolderStructure.d.ts.map +0 -1
- package/esm/helpers/createFolderStructure.js +0 -40
- package/esm/helpers/ensureAgents.d.ts +0 -3
- package/esm/helpers/ensureAgents.d.ts.map +0 -1
- package/esm/helpers/ensureAgents.js +0 -186
- package/esm/helpers/ensureEnvFile.d.ts +0 -2
- package/esm/helpers/ensureEnvFile.d.ts.map +0 -1
- package/esm/helpers/ensureEnvFile.js +0 -8
- package/esm/helpers/ensureGitignore.d.ts +0 -3
- package/esm/helpers/ensureGitignore.d.ts.map +0 -1
- package/esm/helpers/ensureGitignore.js +0 -24
- package/esm/helpers/ensureManagedSection.d.ts +0 -9
- package/esm/helpers/ensureManagedSection.d.ts.map +0 -1
- package/esm/helpers/ensureManagedSection.js +0 -33
- package/esm/helpers/ensureReadme.d.ts +0 -2
- package/esm/helpers/ensureReadme.d.ts.map +0 -1
- package/esm/helpers/ensureReadme.js +0 -61
- package/esm/helpers/fetchPackageDocs.d.ts +0 -12
- package/esm/helpers/fetchPackageDocs.d.ts.map +0 -1
- package/esm/helpers/fetchPackageDocs.js +0 -75
- package/esm/helpers/fetchPlotDocs.d.ts +0 -5
- package/esm/helpers/fetchPlotDocs.d.ts.map +0 -1
- package/esm/helpers/fetchPlotDocs.js +0 -103
- package/esm/helpers/getInstalledPackageVersions.d.ts +0 -2
- package/esm/helpers/getInstalledPackageVersions.d.ts.map +0 -1
- package/esm/helpers/getInstalledPackageVersions.js +0 -94
- package/esm/helpers/getProjectTasks.d.ts +0 -6
- package/esm/helpers/getProjectTasks.d.ts.map +0 -1
- package/esm/helpers/getProjectTasks.js +0 -17
- package/esm/helpers/getRuntime.d.ts +0 -5
- package/esm/helpers/getRuntime.d.ts.map +0 -1
- package/esm/helpers/getRuntime.js +0 -19
- package/esm/helpers/gitignoreEntries.d.ts +0 -2
- package/esm/helpers/gitignoreEntries.d.ts.map +0 -1
- package/esm/helpers/gitignoreEntries.js +0 -10
- package/esm/helpers/installPackages.d.ts +0 -7
- package/esm/helpers/installPackages.d.ts.map +0 -1
- package/esm/helpers/installPackages.js +0 -49
- package/esm/helpers/packageOptions.d.ts +0 -6
- package/esm/helpers/packageOptions.d.ts.map +0 -1
- package/esm/helpers/packageOptions.js +0 -6
- package/esm/helpers/packageRegistry.d.ts +0 -10
- package/esm/helpers/packageRegistry.d.ts.map +0 -1
- package/esm/helpers/packageRegistry.js +0 -89
- package/esm/helpers/parseArguments.d.ts +0 -7
- package/esm/helpers/parseArguments.d.ts.map +0 -1
- package/esm/helpers/parseArguments.js +0 -30
- package/esm/helpers/plotDocPages.d.ts +0 -2
- package/esm/helpers/plotDocPages.d.ts.map +0 -1
- package/esm/helpers/plotDocPages.js +0 -46
- package/esm/helpers/projectManifest.d.ts +0 -12
- package/esm/helpers/projectManifest.d.ts.map +0 -1
- package/esm/helpers/projectManifest.js +0 -80
- package/esm/helpers/syncPackageDocs.d.ts +0 -3
- package/esm/helpers/syncPackageDocs.d.ts.map +0 -1
- package/esm/helpers/syncPackageDocs.js +0 -50
- package/esm/main.d.ts +0 -3
- package/esm/main.d.ts.map +0 -1
- package/esm/main.js +0 -104
- package/esm/package.json +0 -3
- package/script/_dnt.shims.d.ts +0 -2
- package/script/_dnt.shims.d.ts.map +0 -1
- package/script/_dnt.shims.js +0 -60
- package/script/helpers/combinePlotDocs.d.ts +0 -2
- package/script/helpers/combinePlotDocs.d.ts.map +0 -1
- package/script/helpers/combinePlotDocs.js +0 -114
- package/script/helpers/createFolderStructure.d.ts +0 -2
- package/script/helpers/createFolderStructure.d.ts.map +0 -1
- package/script/helpers/createFolderStructure.js +0 -43
- package/script/helpers/ensureAgents.d.ts +0 -3
- package/script/helpers/ensureAgents.d.ts.map +0 -1
- package/script/helpers/ensureAgents.js +0 -189
- package/script/helpers/ensureEnvFile.d.ts +0 -2
- package/script/helpers/ensureEnvFile.d.ts.map +0 -1
- package/script/helpers/ensureEnvFile.js +0 -11
- package/script/helpers/ensureGitignore.d.ts +0 -3
- package/script/helpers/ensureGitignore.d.ts.map +0 -1
- package/script/helpers/ensureGitignore.js +0 -28
- package/script/helpers/ensureManagedSection.d.ts +0 -9
- package/script/helpers/ensureManagedSection.d.ts.map +0 -1
- package/script/helpers/ensureManagedSection.js +0 -36
- package/script/helpers/ensureReadme.d.ts +0 -2
- package/script/helpers/ensureReadme.d.ts.map +0 -1
- package/script/helpers/ensureReadme.js +0 -64
- package/script/helpers/fetchPackageDocs.d.ts +0 -12
- package/script/helpers/fetchPackageDocs.d.ts.map +0 -1
- package/script/helpers/fetchPackageDocs.js +0 -78
- package/script/helpers/fetchPlotDocs.d.ts +0 -5
- package/script/helpers/fetchPlotDocs.d.ts.map +0 -1
- package/script/helpers/fetchPlotDocs.js +0 -106
- package/script/helpers/getInstalledPackageVersions.d.ts +0 -2
- package/script/helpers/getInstalledPackageVersions.d.ts.map +0 -1
- package/script/helpers/getInstalledPackageVersions.js +0 -97
- package/script/helpers/getProjectTasks.d.ts +0 -6
- package/script/helpers/getProjectTasks.d.ts.map +0 -1
- package/script/helpers/getProjectTasks.js +0 -20
- package/script/helpers/getRuntime.d.ts +0 -5
- package/script/helpers/getRuntime.d.ts.map +0 -1
- package/script/helpers/getRuntime.js +0 -59
- package/script/helpers/gitignoreEntries.d.ts +0 -2
- package/script/helpers/gitignoreEntries.d.ts.map +0 -1
- package/script/helpers/gitignoreEntries.js +0 -13
- package/script/helpers/installPackages.d.ts +0 -7
- package/script/helpers/installPackages.d.ts.map +0 -1
- package/script/helpers/installPackages.js +0 -86
- package/script/helpers/packageOptions.d.ts +0 -6
- package/script/helpers/packageOptions.d.ts.map +0 -1
- package/script/helpers/packageOptions.js +0 -9
- package/script/helpers/packageRegistry.d.ts +0 -10
- package/script/helpers/packageRegistry.d.ts.map +0 -1
- package/script/helpers/packageRegistry.js +0 -93
- package/script/helpers/parseArguments.d.ts +0 -7
- package/script/helpers/parseArguments.d.ts.map +0 -1
- package/script/helpers/parseArguments.js +0 -34
- package/script/helpers/plotDocPages.d.ts +0 -2
- package/script/helpers/plotDocPages.d.ts.map +0 -1
- package/script/helpers/plotDocPages.js +0 -49
- package/script/helpers/projectManifest.d.ts +0 -12
- package/script/helpers/projectManifest.d.ts.map +0 -1
- package/script/helpers/projectManifest.js +0 -84
- package/script/helpers/syncPackageDocs.d.ts +0 -3
- package/script/helpers/syncPackageDocs.d.ts.map +0 -1
- package/script/helpers/syncPackageDocs.js +0 -53
- package/script/main.d.ts +0 -3
- package/script/main.d.ts.map +0 -1
- package/script/main.js +0 -109
- package/script/package.json +0 -3
package/dist/main.mjs
ADDED
|
@@ -0,0 +1,849 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import { cancel, intro, isCancel, log, multiselect, outro, select, spinner } from "@clack/prompts";
|
|
3
|
+
import process$1 from "node:process";
|
|
4
|
+
import { execFile, execFileSync } from "node:child_process";
|
|
5
|
+
import { existsSync, lstatSync, mkdirSync, mkdtempSync, readFileSync, renameSync, rmSync, writeFileSync } from "node:fs";
|
|
6
|
+
import { join, posix } from "node:path";
|
|
7
|
+
import { x } from "tar";
|
|
8
|
+
//#region src/helpers/getRuntime.ts
|
|
9
|
+
function getRuntime(versions = process$1.versions) {
|
|
10
|
+
return versions.bun ? "bun" : "node";
|
|
11
|
+
}
|
|
12
|
+
//#endregion
|
|
13
|
+
//#region src/helpers/packageRegistry.ts
|
|
14
|
+
const SUPPORTED_PACKAGES = [
|
|
15
|
+
{
|
|
16
|
+
value: "@nshiab/simple-data-analysis",
|
|
17
|
+
label: "simple-data-analysis",
|
|
18
|
+
type: "sda",
|
|
19
|
+
hint: "All the core functionality, plus methods for dataviz, AI, Google sheets, etc."
|
|
20
|
+
},
|
|
21
|
+
{
|
|
22
|
+
value: "@nshiab/simple-data-analysis-core",
|
|
23
|
+
label: "simple-data-analysis-core",
|
|
24
|
+
type: "sda",
|
|
25
|
+
hint: "No fluff. Great for constrained environments, like a cheap server."
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
value: "@nshiab/journalism-ai",
|
|
29
|
+
label: "journalism-ai",
|
|
30
|
+
type: "journalism",
|
|
31
|
+
hint: "Easily use AI local models with Ollama or remote models with Gemini/Vertex."
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
value: "@nshiab/journalism-google",
|
|
35
|
+
label: "journalism-google",
|
|
36
|
+
type: "journalism",
|
|
37
|
+
hint: "Push and retrieve data from Google Sheets, Google Bucket, and more."
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
value: "@nshiab/journalism-web-scraping",
|
|
41
|
+
label: "journalism-web-scraping",
|
|
42
|
+
type: "journalism",
|
|
43
|
+
hint: "Retrieve data from Statistics Canada tables, HTML table, download files..."
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
value: "@nshiab/journalism-finance",
|
|
47
|
+
label: "journalism-finance",
|
|
48
|
+
type: "journalism",
|
|
49
|
+
hint: "Retrieve financial data, calculate Canadian mortgage payments and taxes..."
|
|
50
|
+
},
|
|
51
|
+
{
|
|
52
|
+
value: "@nshiab/journalism-format",
|
|
53
|
+
label: "journalism-format",
|
|
54
|
+
type: "journalism",
|
|
55
|
+
hint: "Easily format dates, numbers, currencies..."
|
|
56
|
+
},
|
|
57
|
+
{
|
|
58
|
+
value: "@nshiab/journalism-climate",
|
|
59
|
+
label: "journalism-climate",
|
|
60
|
+
type: "journalism",
|
|
61
|
+
hint: "Retrieve data from Environment Canada APIs and more."
|
|
62
|
+
},
|
|
63
|
+
{
|
|
64
|
+
value: "@nshiab/journalism-dataviz",
|
|
65
|
+
label: "journalism-dataviz",
|
|
66
|
+
type: "journalism",
|
|
67
|
+
hint: "Render charts/maps with Observable Plot or directly in the terminal."
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
value: "@nshiab/journalism-geo",
|
|
71
|
+
label: "journalism-geo",
|
|
72
|
+
type: "journalism",
|
|
73
|
+
hint: "Calculate distances, transform 2D coordinates to 3D, wrangle GeoTIFF files..."
|
|
74
|
+
},
|
|
75
|
+
{
|
|
76
|
+
value: "@nshiab/journalism-statistics",
|
|
77
|
+
label: "journalism-statistics",
|
|
78
|
+
type: "journalism",
|
|
79
|
+
hint: "Functions for statistical tests, clustering, random path generation..."
|
|
80
|
+
},
|
|
81
|
+
{
|
|
82
|
+
value: "@nshiab/journalism-web",
|
|
83
|
+
label: "journalism-web",
|
|
84
|
+
type: "journalism",
|
|
85
|
+
hint: "Web related functions, including downloading data as CSV, extracting ZIP files to URLs..."
|
|
86
|
+
},
|
|
87
|
+
{
|
|
88
|
+
value: "@nshiab/journalism-extras",
|
|
89
|
+
label: "journalism-extras",
|
|
90
|
+
type: "journalism",
|
|
91
|
+
hint: "Functions to zip/unzip, sleep, reencode files, create nested directories..."
|
|
92
|
+
}
|
|
93
|
+
];
|
|
94
|
+
const DOCUMENTED_PACKAGES = [
|
|
95
|
+
...SUPPORTED_PACKAGES,
|
|
96
|
+
{
|
|
97
|
+
value: "@nshiab/journalism",
|
|
98
|
+
label: "journalism",
|
|
99
|
+
type: "journalism"
|
|
100
|
+
},
|
|
101
|
+
{
|
|
102
|
+
value: "@observablehq/plot",
|
|
103
|
+
label: "Observable Plot",
|
|
104
|
+
type: "other"
|
|
105
|
+
}
|
|
106
|
+
];
|
|
107
|
+
function getInstalledPackageConfigs(installedPackages) {
|
|
108
|
+
const installedSet = new Set(installedPackages);
|
|
109
|
+
return DOCUMENTED_PACKAGES.filter((pkg) => installedSet.has(pkg.value));
|
|
110
|
+
}
|
|
111
|
+
//#endregion
|
|
112
|
+
//#region src/helpers/packageOptions.ts
|
|
113
|
+
const PACKAGE_OPTIONS = SUPPORTED_PACKAGES.map((pkg) => ({
|
|
114
|
+
value: pkg.value,
|
|
115
|
+
label: pkg.label,
|
|
116
|
+
hint: pkg.hint
|
|
117
|
+
}));
|
|
118
|
+
//#endregion
|
|
119
|
+
//#region src/helpers/gitignoreEntries.ts
|
|
120
|
+
const GITIGNORE_ENTRIES = [
|
|
121
|
+
"node_modules",
|
|
122
|
+
"docs/",
|
|
123
|
+
".tmp",
|
|
124
|
+
".sda-cache",
|
|
125
|
+
".journalism-cache",
|
|
126
|
+
"sda/data",
|
|
127
|
+
"sda/output",
|
|
128
|
+
".env",
|
|
129
|
+
".DS_Store"
|
|
130
|
+
];
|
|
131
|
+
//#endregion
|
|
132
|
+
//#region src/helpers/ensureGitignore.ts
|
|
133
|
+
const GITIGNORE_SENTINEL = "# Added by setup-data-project. Do not remove this line.";
|
|
134
|
+
function ensureGitignore() {
|
|
135
|
+
const path = ".gitignore";
|
|
136
|
+
const stats = lstatSync(path, { throwIfNoEntry: false });
|
|
137
|
+
if (stats?.isSymbolicLink()) return;
|
|
138
|
+
const content = stats === void 0 ? "" : readFileSync(path, "utf-8");
|
|
139
|
+
if (content.split("\n").some((line) => line.trim() === "# Added by setup-data-project. Do not remove this line.")) {
|
|
140
|
+
const entries = new Set(content.split("\n").map((line) => line.trim()));
|
|
141
|
+
const missing = GITIGNORE_ENTRIES.filter((entry) => !entries.has(entry));
|
|
142
|
+
if (missing.length) writeFileSync(path, content + (content.endsWith("\n") ? "" : "\n") + missing.join("\n") + "\n");
|
|
143
|
+
return;
|
|
144
|
+
}
|
|
145
|
+
const separator = content === "" ? "" : content.endsWith("\n") ? "\n" : "\n\n";
|
|
146
|
+
const block = `${GITIGNORE_SENTINEL}\n${GITIGNORE_ENTRIES.join("\n")}\n`;
|
|
147
|
+
writeFileSync(path, content + separator + block);
|
|
148
|
+
log.info(`${stats === void 0 ? "Created" : "Updated"} ${path}`);
|
|
149
|
+
}
|
|
150
|
+
//#endregion
|
|
151
|
+
//#region src/helpers/ensureManagedSection.ts
|
|
152
|
+
function ensureManagedSection(options) {
|
|
153
|
+
const startMarker = `<!-- Do not remove / setup-data-project:${options.name}:start -->`;
|
|
154
|
+
const endMarker = `<!-- Do not remove / setup-data-project:${options.name}:end -->`;
|
|
155
|
+
const trimmedContent = options.content.trim();
|
|
156
|
+
const section = trimmedContent === "" ? `${startMarker}\n${endMarker}` : `${startMarker}\n\n${trimmedContent}\n\n${endMarker}`;
|
|
157
|
+
if (!existsSync(options.path)) {
|
|
158
|
+
writeFileSync(options.path, ensureFinalNewline(options.createContent(section)));
|
|
159
|
+
return "created";
|
|
160
|
+
}
|
|
161
|
+
const currentContent = readFileSync(options.path, "utf-8");
|
|
162
|
+
const start = currentContent.indexOf(startMarker);
|
|
163
|
+
const end = currentContent.indexOf(endMarker);
|
|
164
|
+
if (start === -1 || end === -1 || end < start) {
|
|
165
|
+
log.warn(`${options.path} was not updated because its setup-data-project markers were not found. Add ${startMarker} and ${endMarker}, then rerun the script.`);
|
|
166
|
+
return "missing-markers";
|
|
167
|
+
}
|
|
168
|
+
const nextContent = currentContent.slice(0, start) + section + currentContent.slice(end + endMarker.length);
|
|
169
|
+
if (nextContent === currentContent) return "unchanged";
|
|
170
|
+
writeFileSync(options.path, ensureFinalNewline(nextContent));
|
|
171
|
+
return "updated";
|
|
172
|
+
}
|
|
173
|
+
function ensureFinalNewline(content) {
|
|
174
|
+
return content.endsWith("\n") ? content : content + "\n";
|
|
175
|
+
}
|
|
176
|
+
//#endregion
|
|
177
|
+
//#region src/helpers/ensureReadme.ts
|
|
178
|
+
function ensureReadme(runtime, installedPackages = []) {
|
|
179
|
+
const run = runtime === "bun" ? "bun run" : "npm run";
|
|
180
|
+
const libraries = getInstalledPackageConfigs(installedPackages).map((pkg) => `\`${pkg.value}\``).join(", ");
|
|
181
|
+
ensureManagedSection({
|
|
182
|
+
path: "README.md",
|
|
183
|
+
name: "libraries",
|
|
184
|
+
createContent: (section) => `# Data project\n\nCreated with [setup-data-project](https://github.com/nshiab/setup-data-project).\n\n${section}`,
|
|
185
|
+
content: `${libraries ? `Installed libraries: ${libraries}.\n\n` : ""}Use sda/main.ts to process source data from sda/data/ and write results to sda/output/. Both data folders are ignored by Git. Put reusable helpers in sda/helpers/ and tests in sda/tests/. Import test utilities from \`vite-plus/test\`.
|
|
186
|
+
|
|
187
|
+
- \`${run} sda\`: run the analysis and watch for changes.
|
|
188
|
+
- \`${run} test\`: run tests; the default command also succeeds when no tests exist.
|
|
189
|
+
- \`${run} all-tests\`: check types, lint, formatting, and tests.
|
|
190
|
+
- \`${run} fix\`: apply formatting and automatic fixes.
|
|
191
|
+
- \`${run} docs\`: refresh documentation for the installed library versions.
|
|
192
|
+
- \`${run} clean\`: delete cached results and temporary files in .sda-cache/, .journalism-cache/, and .tmp/.
|
|
193
|
+
|
|
194
|
+
In VS Code, install the recommended Vite+ extension pack for Oxc formatting and linting and the Vitest test runner. Generated .vscode/settings.json enables formatting and lint fixes on save, plus visual line wrapping. Existing VS Code configuration files are preserved.
|
|
195
|
+
|
|
196
|
+
The generated docs/ folder is ignored by Git. Refresh it after cloning or updating dependencies. See AGENTS.md for documentation pointers.`
|
|
197
|
+
});
|
|
198
|
+
}
|
|
199
|
+
//#endregion
|
|
200
|
+
//#region src/helpers/installPackages.ts
|
|
201
|
+
function runPackageManager(args) {
|
|
202
|
+
const command = getRuntime() === "bun" ? "bun" : process.platform === "win32" ? "npm.cmd" : "npm";
|
|
203
|
+
return new Promise((resolve, reject) => {
|
|
204
|
+
execFile(command, args, {
|
|
205
|
+
maxBuffer: 10485760,
|
|
206
|
+
shell: process.platform === "win32"
|
|
207
|
+
}, (error, stdout, stderr) => {
|
|
208
|
+
if (error) reject(new Error(`${command} ${args.join(" ")} failed.\n${stderr || stdout}`, { cause: error }));
|
|
209
|
+
else resolve();
|
|
210
|
+
});
|
|
211
|
+
});
|
|
212
|
+
}
|
|
213
|
+
async function installPackages(packages, options = {}) {
|
|
214
|
+
if (packages.length === 0) return;
|
|
215
|
+
const bun = getRuntime() === "bun";
|
|
216
|
+
await runPackageManager([
|
|
217
|
+
bun ? "add" : "install",
|
|
218
|
+
...options.development ? bun ? ["--dev"] : ["--save-dev"] : [],
|
|
219
|
+
...packages
|
|
220
|
+
]);
|
|
221
|
+
}
|
|
222
|
+
//#endregion
|
|
223
|
+
//#region src/helpers/ensureTooling.ts
|
|
224
|
+
const tools = [
|
|
225
|
+
"vite-plus",
|
|
226
|
+
"typescript",
|
|
227
|
+
"@types/node"
|
|
228
|
+
];
|
|
229
|
+
async function ensureTooling(manifest) {
|
|
230
|
+
const runtime = getRuntime();
|
|
231
|
+
const runtimeTools = runtime === "bun" ? [...tools, "@types/bun"] : tools;
|
|
232
|
+
const installed = manifest.getInstalledPackages();
|
|
233
|
+
await installPackages(runtimeTools.filter((pkg) => !installed.includes(pkg)).map((pkg) => `${pkg}@latest`), { development: true });
|
|
234
|
+
if (![
|
|
235
|
+
"vite.config.ts",
|
|
236
|
+
"vite.config.js",
|
|
237
|
+
"vite.config.mts",
|
|
238
|
+
"vite.config.mjs",
|
|
239
|
+
"vite.config.cts",
|
|
240
|
+
"vite.config.cjs"
|
|
241
|
+
].some((file) => existsSync(file))) writeFileSync("vite.config.ts", `import { defineConfig, loadEnv } from "vite-plus";
|
|
242
|
+
|
|
243
|
+
export default defineConfig({
|
|
244
|
+
test: { env: loadEnv("test", process.cwd(), "") },
|
|
245
|
+
lint: { options: { typeAware: true, typeCheck: true } },
|
|
246
|
+
fmt: { ignorePatterns: ["docs/**", "sda/data/**", "sda/output/**"] },
|
|
247
|
+
});
|
|
248
|
+
`);
|
|
249
|
+
if (!existsSync("tsconfig.json")) writeFileSync("tsconfig.json", `{
|
|
250
|
+
"compilerOptions": {
|
|
251
|
+
"target": "ES2023",
|
|
252
|
+
"module": "NodeNext",
|
|
253
|
+
"strict": true,
|
|
254
|
+
"noEmit": true,
|
|
255
|
+
"allowImportingTsExtensions": true,
|
|
256
|
+
"erasableSyntaxOnly": ${runtime === "node"},
|
|
257
|
+
"types": ${runtime === "bun" ? "[\"node\", \"bun\"]" : "[\"node\"]"},
|
|
258
|
+
"skipLibCheck": true
|
|
259
|
+
},
|
|
260
|
+
"include": ["sda/**/*.ts", "vite.config.*"]
|
|
261
|
+
}
|
|
262
|
+
`);
|
|
263
|
+
}
|
|
264
|
+
//#endregion
|
|
265
|
+
//#region src/helpers/ensureVscode.ts
|
|
266
|
+
function ensureVscode() {
|
|
267
|
+
mkdirSync(".vscode", { recursive: true });
|
|
268
|
+
const formatter = "oxc.oxc-vscode";
|
|
269
|
+
const files = {
|
|
270
|
+
"extensions.json": { recommendations: ["VoidZero.vite-plus-extension-pack"] },
|
|
271
|
+
"settings.json": {
|
|
272
|
+
"editor.defaultFormatter": formatter,
|
|
273
|
+
"[javascript]": { "editor.defaultFormatter": formatter },
|
|
274
|
+
"[javascriptreact]": { "editor.defaultFormatter": formatter },
|
|
275
|
+
"[typescript]": { "editor.defaultFormatter": formatter },
|
|
276
|
+
"[typescriptreact]": { "editor.defaultFormatter": formatter },
|
|
277
|
+
"oxc.disableNestedConfig": true,
|
|
278
|
+
"oxc.fmt.disableNestedConfig": true,
|
|
279
|
+
"editor.formatOnSave": true,
|
|
280
|
+
"editor.formatOnSaveMode": "file",
|
|
281
|
+
"editor.codeActionsOnSave": { "source.fixAll.oxc": "explicit" },
|
|
282
|
+
"editor.wordWrap": "on"
|
|
283
|
+
}
|
|
284
|
+
};
|
|
285
|
+
for (const [name, config] of Object.entries(files)) {
|
|
286
|
+
const path = `.vscode/${name}`;
|
|
287
|
+
if (!existsSync(path)) writeFileSync(path, `${JSON.stringify(config, null, 2)}\n`);
|
|
288
|
+
}
|
|
289
|
+
}
|
|
290
|
+
//#endregion
|
|
291
|
+
//#region package.json
|
|
292
|
+
var version = "3.0.0";
|
|
293
|
+
//#endregion
|
|
294
|
+
//#region src/helpers/getProjectTasks.ts
|
|
295
|
+
function getProjectTasks(runtime = getRuntime()) {
|
|
296
|
+
const vp = runtime === "bun" ? "bun run --bun vp" : "vp";
|
|
297
|
+
return {
|
|
298
|
+
sda: runtime === "bun" ? "bun run --watch sda/main.ts" : "node --env-file-if-exists=.env --watch sda/main.ts",
|
|
299
|
+
test: `${vp} test --passWithNoTests`,
|
|
300
|
+
"all-tests": `${vp} check && ${runtime === "bun" ? "bun" : "npm"} run test`,
|
|
301
|
+
clean: "rm -rf .sda-cache .journalism-cache .tmp",
|
|
302
|
+
fix: `${vp} check --fix`,
|
|
303
|
+
docs: `${runtime === "bun" ? "bunx --bun" : "npx"} @nshiab/setup-data-project@${version} --docs`
|
|
304
|
+
};
|
|
305
|
+
}
|
|
306
|
+
//#endregion
|
|
307
|
+
//#region src/helpers/createFolderStructure.ts
|
|
308
|
+
function createFolderStructure(selectedPackages) {
|
|
309
|
+
const sdaFolder = "sda";
|
|
310
|
+
const folders = [
|
|
311
|
+
"data",
|
|
312
|
+
"helpers",
|
|
313
|
+
"output",
|
|
314
|
+
"tests"
|
|
315
|
+
];
|
|
316
|
+
if (!existsSync(sdaFolder)) mkdirSync(sdaFolder, { recursive: true });
|
|
317
|
+
for (const folder of folders) {
|
|
318
|
+
const path = join(sdaFolder, folder);
|
|
319
|
+
if (!existsSync(path)) mkdirSync(path, { recursive: true });
|
|
320
|
+
}
|
|
321
|
+
const mainTsPath = join(sdaFolder, "main.ts");
|
|
322
|
+
let mainTsContent = "console.log(\"Hello simple-data-analysis!\");\n";
|
|
323
|
+
if (selectedPackages.includes("@nshiab/simple-data-analysis") || selectedPackages.includes("@nshiab/simple-data-analysis-core")) mainTsContent = `import { SimpleDB } from "${selectedPackages.includes("@nshiab/simple-data-analysis") ? "@nshiab/simple-data-analysis" : "@nshiab/simple-data-analysis-core"}";
|
|
324
|
+
|
|
325
|
+
const sdb = new SimpleDB();
|
|
326
|
+
const table = sdb.newTable();
|
|
327
|
+
|
|
328
|
+
await table.loadArray([{ message: "Hello simple-data-analysis!" }]).log();
|
|
329
|
+
|
|
330
|
+
await sdb.close();
|
|
331
|
+
`;
|
|
332
|
+
if (lstatSync(mainTsPath, { throwIfNoEntry: false }) === void 0) {
|
|
333
|
+
writeFileSync(mainTsPath, mainTsContent);
|
|
334
|
+
log.info(`Created ${mainTsPath}`);
|
|
335
|
+
}
|
|
336
|
+
return sdaFolder;
|
|
337
|
+
}
|
|
338
|
+
//#endregion
|
|
339
|
+
//#region src/helpers/ensureEnvFile.ts
|
|
340
|
+
function ensureEnvFile() {
|
|
341
|
+
if (lstatSync(".env", { throwIfNoEntry: false }) === void 0) {
|
|
342
|
+
writeFileSync(".env", "");
|
|
343
|
+
log.info("Created .env");
|
|
344
|
+
}
|
|
345
|
+
}
|
|
346
|
+
//#endregion
|
|
347
|
+
//#region src/helpers/ensureAgents.ts
|
|
348
|
+
function ensureAgents(docsMapping, runtime, installedPackages = Object.keys(docsMapping)) {
|
|
349
|
+
const run = runtime === "bun" ? "bun run" : "npm run";
|
|
350
|
+
ensureManagedSection({
|
|
351
|
+
path: "AGENTS.md",
|
|
352
|
+
name: "agents",
|
|
353
|
+
createContent: (section) => section,
|
|
354
|
+
content: `Read package.json for the installed libraries and scripts. Prefer the installed data libraries when they cover the task.
|
|
355
|
+
|
|
356
|
+
Use sda/main.ts as the entry point and sda/helpers/ for reusable helpers. Put tests in sda/tests/, source data in sda/data/, and results in sda/output/. Import test utilities from \`vite-plus/test\`.
|
|
357
|
+
|
|
358
|
+
For a single execution, run \`${runtime === "bun" ? "bun run sda/main.ts" : "node --env-file-if-exists=.env sda/main.ts"}\`. The sda script watches for changes. Before handing off code changes, run \`${run} all-tests\` and resolve failures.
|
|
359
|
+
|
|
360
|
+
The clean script removes cached results and temporary files. Run it only when those cached results can be discarded.
|
|
361
|
+
|
|
362
|
+
Library documentation in docs/ is generated and ignored by Git. Run \`${run} docs\` when documentation is missing or after dependency changes; resolve refresh failures before using possibly stale references. Edit project source files rather than downloaded documentation.
|
|
363
|
+
|
|
364
|
+
${getInstalledPackageConfigs(installedPackages).map((pkg) => {
|
|
365
|
+
if (pkg.value === "@observablehq/plot") return `- Observable Plot charts and maps: read \`docs/observable-plot/llm.md\` for use with writeChart and writeMap.`;
|
|
366
|
+
return `- \`${pkg.value}\`: start at \`docs/${pkg.value.slice(8)}/llms.txt\`, then read the relevant API pages and examples.`;
|
|
367
|
+
}).join("\n")}`
|
|
368
|
+
});
|
|
369
|
+
}
|
|
370
|
+
//#endregion
|
|
371
|
+
//#region src/helpers/jsonObject.ts
|
|
372
|
+
function isObject(value) {
|
|
373
|
+
return value !== null && typeof value === "object" && !Array.isArray(value);
|
|
374
|
+
}
|
|
375
|
+
//#endregion
|
|
376
|
+
//#region src/helpers/projectManifest.ts
|
|
377
|
+
var ProjectManifest = class ProjectManifest {
|
|
378
|
+
#config;
|
|
379
|
+
constructor(config) {
|
|
380
|
+
this.#config = config;
|
|
381
|
+
}
|
|
382
|
+
static open() {
|
|
383
|
+
if (!existsSync("package.json")) return new ProjectManifest({
|
|
384
|
+
name: "data-project",
|
|
385
|
+
private: true,
|
|
386
|
+
type: "module"
|
|
387
|
+
});
|
|
388
|
+
const config = JSON.parse(readFileSync("package.json", "utf8"));
|
|
389
|
+
if (!isObject(config)) throw new Error("package.json must contain a JSON object.");
|
|
390
|
+
return new ProjectManifest(config);
|
|
391
|
+
}
|
|
392
|
+
reload() {
|
|
393
|
+
this.#config = ProjectManifest.open().#config;
|
|
394
|
+
}
|
|
395
|
+
getInstalledPackages() {
|
|
396
|
+
return Object.keys(this.getInstalledPackageSpecifiers());
|
|
397
|
+
}
|
|
398
|
+
getInstalledPackageSpecifiers() {
|
|
399
|
+
const packages = {};
|
|
400
|
+
for (const key of ["dependencies", "devDependencies"]) {
|
|
401
|
+
const dependencies = this.#config[key];
|
|
402
|
+
if (isObject(dependencies)) {
|
|
403
|
+
for (const [name, version] of Object.entries(dependencies)) if (typeof version === "string") packages[name] = version;
|
|
404
|
+
}
|
|
405
|
+
}
|
|
406
|
+
return packages;
|
|
407
|
+
}
|
|
408
|
+
updateTasks(tasks) {
|
|
409
|
+
if (this.#config.type === "commonjs") throw new Error("Setup requires an ESM project. Set \"type\": \"module\" in package.json, or use --docs to refresh documentation only.");
|
|
410
|
+
if (this.#config.type === void 0) this.#config.type = "module";
|
|
411
|
+
const existing = this.#config.scripts;
|
|
412
|
+
this.#config.scripts = {
|
|
413
|
+
...tasks,
|
|
414
|
+
...isObject(existing) ? existing : {}
|
|
415
|
+
};
|
|
416
|
+
writeFileSync("package.json", JSON.stringify(this.#config, null, 2) + "\n");
|
|
417
|
+
}
|
|
418
|
+
};
|
|
419
|
+
//#endregion
|
|
420
|
+
//#region src/helpers/fetchPackageDocs.ts
|
|
421
|
+
async function fetchPackageDocs(pkg, version) {
|
|
422
|
+
if (!DOCUMENTED_PACKAGES.find((item) => item.value === pkg && item.value.startsWith("@nshiab/")) || !/^\d+\.\d+\.\d+(?:-[0-9A-Za-z.-]+)?(?:\+[0-9A-Za-z.-]+)?$/.test(version)) throw new Error(`Unsupported package or version: ${pkg}@${version}`);
|
|
423
|
+
const repo = pkg.slice(8);
|
|
424
|
+
mkdirSync("docs", { recursive: true });
|
|
425
|
+
const staging = mkdtempSync(join("docs", ".download-"));
|
|
426
|
+
const contents = join(staging, "contents");
|
|
427
|
+
const target = join("docs", repo);
|
|
428
|
+
const backup = join(staging, "previous");
|
|
429
|
+
try {
|
|
430
|
+
const url = `https://github.com/nshiab/${repo}/releases/download/v${version}/documentation.tar.gz`;
|
|
431
|
+
const response = await fetch(url);
|
|
432
|
+
if (!response.ok) throw new Error(`HTTP ${response.status} from ${url}`);
|
|
433
|
+
const archive = join(staging, "documentation.tar.gz");
|
|
434
|
+
writeFileSync(archive, Buffer.from(await response.arrayBuffer()));
|
|
435
|
+
mkdirSync(contents);
|
|
436
|
+
let unsafeEntry;
|
|
437
|
+
await x({
|
|
438
|
+
file: archive,
|
|
439
|
+
cwd: contents,
|
|
440
|
+
strict: true,
|
|
441
|
+
preservePaths: false,
|
|
442
|
+
filter(path, entry) {
|
|
443
|
+
const normalized = posix.normalize(path);
|
|
444
|
+
if (path.includes("\\") || path.startsWith("/") || normalized === ".." || normalized.startsWith("../") || !("type" in entry) || !["File", "Directory"].includes(entry.type)) {
|
|
445
|
+
unsafeEntry = path;
|
|
446
|
+
return false;
|
|
447
|
+
}
|
|
448
|
+
return true;
|
|
449
|
+
}
|
|
450
|
+
});
|
|
451
|
+
if (unsafeEntry !== void 0) throw new Error(`Unsafe archive entry: ${unsafeEntry}`);
|
|
452
|
+
for (const path of [
|
|
453
|
+
"README.md",
|
|
454
|
+
"LICENSE",
|
|
455
|
+
"llms.txt",
|
|
456
|
+
"docs"
|
|
457
|
+
]) if (!existsSync(join(contents, path))) throw new Error(`Documentation archive is missing ${path}.`);
|
|
458
|
+
const readme = readFileSync(join(contents, "README.md"), "utf8");
|
|
459
|
+
const index = readFileSync(join(contents, "llms.txt"), "utf8");
|
|
460
|
+
if (existsSync(target)) renameSync(target, backup);
|
|
461
|
+
try {
|
|
462
|
+
renameSync(contents, target);
|
|
463
|
+
} catch (error) {
|
|
464
|
+
if (existsSync(backup)) renameSync(backup, target);
|
|
465
|
+
throw error;
|
|
466
|
+
}
|
|
467
|
+
return {
|
|
468
|
+
readme,
|
|
469
|
+
index
|
|
470
|
+
};
|
|
471
|
+
} catch (error) {
|
|
472
|
+
log.warn(`Could not refresh ${pkg}@${version}: ${String(error)} Existing documentation was preserved and may be stale. Run the docs script again after resolving the error.`);
|
|
473
|
+
return {};
|
|
474
|
+
} finally {
|
|
475
|
+
rmSync(staging, {
|
|
476
|
+
recursive: true,
|
|
477
|
+
force: true
|
|
478
|
+
});
|
|
479
|
+
}
|
|
480
|
+
}
|
|
481
|
+
//#endregion
|
|
482
|
+
//#region src/helpers/combinePlotDocs.ts
|
|
483
|
+
function combinePlotDocs(version, documents) {
|
|
484
|
+
const pages = [...documents.keys()].sort();
|
|
485
|
+
const source = `https://github.com/observablehq/plot/tree/v${version}/docs`;
|
|
486
|
+
const anchors = /* @__PURE__ */ new Map();
|
|
487
|
+
const sections = /* @__PURE__ */ new Map();
|
|
488
|
+
const pageId = (page) => `plot-${page.replace(/\.md$/, "").replaceAll("/", "--")}`;
|
|
489
|
+
for (const page of pages) {
|
|
490
|
+
const ids = /* @__PURE__ */ new Map();
|
|
491
|
+
const headings = [];
|
|
492
|
+
const counts = /* @__PURE__ */ new Map();
|
|
493
|
+
proseLines(documents.get(page) ?? "", (line, number) => {
|
|
494
|
+
for (const match of line.matchAll(/\bid=["']([^"']+)["']/g)) ids.set(match[1], `${pageId(page)}--${match[1]}`);
|
|
495
|
+
const heading = line.match(/^ {0,3}#{1,6}\s+(.+?)\s*#*\s*$/);
|
|
496
|
+
if (!heading) return line;
|
|
497
|
+
const explicit = heading[1].match(/\{#([^}]+)\}/)?.[1];
|
|
498
|
+
const title = heading[1].replace(/\s*\{#[^}]+\}/g, "");
|
|
499
|
+
const slug = explicit ?? title.replace(/<[^>]*>/g, "").toLowerCase().replace(/[^\p{L}\p{N}_\s-]/gu, "").trim().replace(/\s+/g, "-");
|
|
500
|
+
const count = counts.get(slug) ?? 0;
|
|
501
|
+
counts.set(slug, count + 1);
|
|
502
|
+
const localId = `${slug}${count ? `-${count}` : ""}`;
|
|
503
|
+
const id = `${pageId(page)}--${localId}`;
|
|
504
|
+
ids.set(localId, id);
|
|
505
|
+
headings.push({
|
|
506
|
+
line: number,
|
|
507
|
+
title,
|
|
508
|
+
id
|
|
509
|
+
});
|
|
510
|
+
return line;
|
|
511
|
+
});
|
|
512
|
+
anchors.set(page, ids);
|
|
513
|
+
sections.set(page, headings);
|
|
514
|
+
}
|
|
515
|
+
function link(target, page) {
|
|
516
|
+
if (/^(?:[a-z][a-z\d+.-]*:|\/\/)/i.test(target)) return target;
|
|
517
|
+
const [pathAndQuery, fragment] = target.split("#", 2);
|
|
518
|
+
const path = pathAndQuery.split("?", 1)[0];
|
|
519
|
+
const resolved = path === "" ? page : posix.normalize(path.startsWith("/") ? path.slice(1) : posix.join(posix.dirname(page), path));
|
|
520
|
+
const markdown = [
|
|
521
|
+
resolved,
|
|
522
|
+
`${resolved}.md`,
|
|
523
|
+
`${resolved}/index.md`
|
|
524
|
+
].find((candidate) => documents.has(candidate));
|
|
525
|
+
if (markdown) {
|
|
526
|
+
const id = fragment ? anchors.get(markdown)?.get(decodeURIComponent(fragment)) : pageId(markdown);
|
|
527
|
+
if (id) return `#${id}`;
|
|
528
|
+
return `${source}/${markdown}${fragment ? `#${fragment}` : ""}`;
|
|
529
|
+
}
|
|
530
|
+
if (resolved.endsWith(".md")) return `${source}/${resolved}${fragment ? `#${fragment}` : ""}`;
|
|
531
|
+
const base = `https://raw.githubusercontent.com/observablehq/plot/refs/tags/v${version}/docs/`;
|
|
532
|
+
return path.startsWith("/") ? new URL(`public${target}`, base).href : new URL(target, `${base}${page}`).href;
|
|
533
|
+
}
|
|
534
|
+
return `# Observable Plot ${version}\n\nPackage: \`@observablehq/plot@${version}\`. Source: [v${version}](${source}).\n\nThis reference combines selected upstream documentation for static charts and maps. Introductory and site pages, interaction helpers, and the Auto and Tip marks are omitted. Vue components and plot fences are retained as source examples. Use the table of contents to find API signatures and examples; links to omitted pages lead to the tagged upstream documentation.\n\n## Table of contents\n\n${pages.flatMap((page) => [`- [${page}](#${pageId(page)})`, ...(sections.get(page) ?? []).map(({ title, id }) => ` - [${title.replace(/[[\]]/g, "")}](#${id})`)]).join("\n")}\n\n---\n\n${pages.map((page) => {
|
|
535
|
+
const headings = new Map((sections.get(page) ?? []).map((heading) => [heading.line, heading]));
|
|
536
|
+
const body = proseLines(documents.get(page) ?? "", (line, number) => {
|
|
537
|
+
const heading = headings.get(number);
|
|
538
|
+
line = line.split(/(`+[^`]*`+)/g).map((part, index) => {
|
|
539
|
+
if (index % 2) return part;
|
|
540
|
+
return part.replace(/(\]\()([^\s)]+)([^)]*\))/g, (_match, before, target, after) => `${before}${link(target, page)}${after}`).replace(/^( {0,3}\[[^\]]+\]:\s*)(\S+)/, (_match, before, target) => `${before}${link(target, page)}`).replace(/(?<!:)\b(href|src)=(["'])([^"']+)\2/g, (_match, attr, quote, target) => `${attr}=${quote}${link(target, page)}${quote}`).replace(/\bid=(["'])([^"']+)\1/g, (_match, quote, id) => `id=${quote}${anchors.get(page)?.get(id) ?? id}${quote}`);
|
|
541
|
+
}).join("");
|
|
542
|
+
return heading ? `<a id="${heading.id}"></a>\n\n${line.replace(/\s*\{#[^}]+\}/g, "")}` : line;
|
|
543
|
+
});
|
|
544
|
+
return `<a id="${pageId(page)}"></a>\n\n# ${page}\n\nSource: ${source}/${page}\n\n${body}`;
|
|
545
|
+
}).join("\n\n---\n\n")}\n\n<!-- setup-data-project:observable-plot:${version}:complete -->\n`;
|
|
546
|
+
}
|
|
547
|
+
function proseLines(content, transform) {
|
|
548
|
+
let fence;
|
|
549
|
+
let script = false;
|
|
550
|
+
return content.split("\n").map((line, number) => {
|
|
551
|
+
const marker = line.match(/^ {0,3}(`{3,}|~{3,})/);
|
|
552
|
+
if (fence) {
|
|
553
|
+
if (marker?.[1][0] === fence.character && marker[1].length >= fence.length && /^ {0,3}(?:`+|~+)\s*$/.test(line)) fence = void 0;
|
|
554
|
+
return line;
|
|
555
|
+
}
|
|
556
|
+
if (marker) {
|
|
557
|
+
fence = {
|
|
558
|
+
character: marker[1][0],
|
|
559
|
+
length: marker[1].length
|
|
560
|
+
};
|
|
561
|
+
return line;
|
|
562
|
+
}
|
|
563
|
+
if (/^\s*<script\b/.test(line)) script = true;
|
|
564
|
+
if (script) {
|
|
565
|
+
if (/<\/script>/.test(line)) script = false;
|
|
566
|
+
return line;
|
|
567
|
+
}
|
|
568
|
+
return transform(line, number);
|
|
569
|
+
}).join("\n");
|
|
570
|
+
}
|
|
571
|
+
//#endregion
|
|
572
|
+
//#region src/helpers/plotDocPages.ts
|
|
573
|
+
const PLOT_DOC_PAGES = [
|
|
574
|
+
"features/plots.md",
|
|
575
|
+
"features/marks.md",
|
|
576
|
+
"features/scales.md",
|
|
577
|
+
"features/projections.md",
|
|
578
|
+
"features/legends.md",
|
|
579
|
+
"features/facets.md",
|
|
580
|
+
"features/formats.md",
|
|
581
|
+
"features/curves.md",
|
|
582
|
+
"transforms/bin.md",
|
|
583
|
+
"transforms/group.md",
|
|
584
|
+
"transforms/stack.md",
|
|
585
|
+
"transforms/normalize.md",
|
|
586
|
+
"transforms/centroid.md",
|
|
587
|
+
"transforms/sort.md",
|
|
588
|
+
"marks/area.md",
|
|
589
|
+
"marks/arrow.md",
|
|
590
|
+
"marks/axis.md",
|
|
591
|
+
"marks/bar.md",
|
|
592
|
+
"marks/bollinger.md",
|
|
593
|
+
"marks/box.md",
|
|
594
|
+
"marks/cell.md",
|
|
595
|
+
"marks/contour.md",
|
|
596
|
+
"marks/delaunay.md",
|
|
597
|
+
"marks/density.md",
|
|
598
|
+
"marks/difference.md",
|
|
599
|
+
"marks/dot.md",
|
|
600
|
+
"marks/frame.md",
|
|
601
|
+
"marks/geo.md",
|
|
602
|
+
"marks/grid.md",
|
|
603
|
+
"marks/hexgrid.md",
|
|
604
|
+
"marks/image.md",
|
|
605
|
+
"marks/line.md",
|
|
606
|
+
"marks/linear-regression.md",
|
|
607
|
+
"marks/link.md",
|
|
608
|
+
"marks/raster.md",
|
|
609
|
+
"marks/rect.md",
|
|
610
|
+
"marks/rule.md",
|
|
611
|
+
"marks/text.md",
|
|
612
|
+
"marks/tick.md",
|
|
613
|
+
"marks/tree.md",
|
|
614
|
+
"marks/vector.md",
|
|
615
|
+
"marks/waffle.md"
|
|
616
|
+
].sort();
|
|
617
|
+
//#endregion
|
|
618
|
+
//#region src/helpers/fetchPlotDocs.ts
|
|
619
|
+
async function fetchPlotDocs(version, options = {}) {
|
|
620
|
+
const tag = `v${version}`;
|
|
621
|
+
const directory = join("docs", "observable-plot");
|
|
622
|
+
try {
|
|
623
|
+
let llm;
|
|
624
|
+
if (options.preferStored !== false) try {
|
|
625
|
+
const response = await fetch(`https://raw.githubusercontent.com/nshiab/setup-data-project/refs/heads/main/docs-cache/observable-plot/${version}/llm.md`);
|
|
626
|
+
if (response.ok) {
|
|
627
|
+
const cached = await response.text();
|
|
628
|
+
if (isStoredReference(cached, version)) llm = cached;
|
|
629
|
+
}
|
|
630
|
+
} catch {}
|
|
631
|
+
if (llm === void 0) llm = await generateReference(version);
|
|
632
|
+
mkdirSync(directory, { recursive: true });
|
|
633
|
+
const temporaryPath = join(directory, ".llm.md.tmp");
|
|
634
|
+
try {
|
|
635
|
+
writeFileSync(temporaryPath, llm);
|
|
636
|
+
renameSync(temporaryPath, join(directory, "llm.md"));
|
|
637
|
+
} finally {
|
|
638
|
+
rmSync(temporaryPath, { force: true });
|
|
639
|
+
}
|
|
640
|
+
return {
|
|
641
|
+
llm,
|
|
642
|
+
plot: {
|
|
643
|
+
version,
|
|
644
|
+
pages: [...PLOT_DOC_PAGES]
|
|
645
|
+
}
|
|
646
|
+
};
|
|
647
|
+
} catch (error) {
|
|
648
|
+
log.warn(`Could not fetch complete Observable Plot documentation for ${tag}. Existing files were preserved, but may not match the installed version. Resolve the refresh failure before using this reference. ` + String(error));
|
|
649
|
+
return {};
|
|
650
|
+
}
|
|
651
|
+
}
|
|
652
|
+
async function generateReference(version) {
|
|
653
|
+
const tag = `v${version}`;
|
|
654
|
+
const pages = PLOT_DOC_PAGES;
|
|
655
|
+
const documents = /* @__PURE__ */ new Map();
|
|
656
|
+
const failed = [];
|
|
657
|
+
for (let offset = 0; offset < pages.length; offset += 8) await Promise.all(pages.slice(offset, offset + 8).map(async (page) => {
|
|
658
|
+
try {
|
|
659
|
+
const url = `https://raw.githubusercontent.com/observablehq/plot/refs/tags/${tag}/docs/${page}`;
|
|
660
|
+
const response = await fetch(url);
|
|
661
|
+
if (!response.ok) throw new Error(`HTTP ${response.status}`);
|
|
662
|
+
const content = await response.text();
|
|
663
|
+
documents.set(page, content);
|
|
664
|
+
} catch {
|
|
665
|
+
failed.push(page);
|
|
666
|
+
}
|
|
667
|
+
}));
|
|
668
|
+
if (failed.length > 0) throw new Error(`Could not fetch ${failed.length} Markdown pages`);
|
|
669
|
+
return combinePlotDocs(version, documents);
|
|
670
|
+
}
|
|
671
|
+
function isStoredReference(content, version) {
|
|
672
|
+
const source = `https://github.com/observablehq/plot/tree/v${version}/docs`;
|
|
673
|
+
const metadata = content.split(/\n\s*\n/)[1]?.replace(/\s+/g, " ");
|
|
674
|
+
if (!content.startsWith(`# Observable Plot ${version}\n\n`) || metadata !== `Package: \`@observablehq/plot@${version}\`. Source: [v${version}](${source}).` || !content.trimEnd().endsWith(`<!-- setup-data-project:observable-plot:${version}:complete -->`)) return false;
|
|
675
|
+
const sections = [...content.matchAll(/<a id="(plot-[^"]+)"><\/a>\n\n# ([^\n]+\.md)\n\nSource:\s+([^\s]+)\n\n/g)];
|
|
676
|
+
if (sections.length !== PLOT_DOC_PAGES.length) return false;
|
|
677
|
+
const found = /* @__PURE__ */ new Set();
|
|
678
|
+
for (let index = 0; index < sections.length; index++) {
|
|
679
|
+
const section = sections[index];
|
|
680
|
+
const page = section[2];
|
|
681
|
+
const id = `plot-${page.replace(/\.md$/, "").replaceAll("/", "--")}`;
|
|
682
|
+
if (!PLOT_DOC_PAGES.includes(page) || found.has(page) || section[1] !== id || section[3] !== `${source}/${page}`) return false;
|
|
683
|
+
const body = content.slice(section.index + section[0].length, sections[index + 1]?.index);
|
|
684
|
+
if (!/^#{1,6}\s+\S/m.test(body)) return false;
|
|
685
|
+
found.add(page);
|
|
686
|
+
}
|
|
687
|
+
return true;
|
|
688
|
+
}
|
|
689
|
+
//#endregion
|
|
690
|
+
//#region src/helpers/syncPackageDocs.ts
|
|
691
|
+
async function syncPackageDocs(installedPackages, installedVersions) {
|
|
692
|
+
const mapping = {};
|
|
693
|
+
for (const pkg of getInstalledPackageConfigs(installedPackages)) {
|
|
694
|
+
const version = installedVersions[pkg.value];
|
|
695
|
+
if (!version) {
|
|
696
|
+
log.warn(`Could not determine the installed version of ${pkg.value}. Install the project dependencies, then run the docs script again. Existing documentation may be stale.`);
|
|
697
|
+
continue;
|
|
698
|
+
}
|
|
699
|
+
const docs = pkg.value === "@observablehq/plot" ? await fetchPlotDocs(version) : await fetchPackageDocs(pkg.value, version);
|
|
700
|
+
if (docs.index !== void 0 || docs.plot) mapping[pkg.value] = docs;
|
|
701
|
+
}
|
|
702
|
+
return mapping;
|
|
703
|
+
}
|
|
704
|
+
//#endregion
|
|
705
|
+
//#region src/helpers/getInstalledPackageVersions.ts
|
|
706
|
+
function getInstalledPackageVersions(packageSpecifiers) {
|
|
707
|
+
const versions = {};
|
|
708
|
+
for (const pkg of Object.keys(packageSpecifiers)) {
|
|
709
|
+
const path = join("node_modules", pkg, "package.json");
|
|
710
|
+
if (!existsSync(path)) continue;
|
|
711
|
+
const config = JSON.parse(readFileSync(path, "utf8"));
|
|
712
|
+
if (isObject(config) && typeof config.version === "string" && /^\d+\.\d+\.\d+(?:-[0-9A-Za-z.-]+)?(?:\+[0-9A-Za-z.-]+)?$/.test(config.version)) versions[pkg] = config.version;
|
|
713
|
+
}
|
|
714
|
+
return versions;
|
|
715
|
+
}
|
|
716
|
+
//#endregion
|
|
717
|
+
//#region src/helpers/parseArguments.ts
|
|
718
|
+
const packageFlags = new Map(SUPPORTED_PACKAGES.map((pkg) => [`--${pkg.label.replace(/^simple-data-analysis/, "sda").replace(/^journalism-/, "")}`, pkg.value]));
|
|
719
|
+
const CLI_HELP = `Usage: setup-data-project [library flags | --docs] [--help]
|
|
720
|
+
|
|
721
|
+
${Array.from(packageFlags, ([flag, pkg]) => ` ${flag.padEnd(16)} Select ${pkg}.`).join("\n")}
|
|
722
|
+
--docs Refresh documentation only for installed libraries.
|
|
723
|
+
-h, --help Show this help and exit.
|
|
724
|
+
|
|
725
|
+
Without a package flag, choose packages interactively.
|
|
726
|
+
Combine package flags to select libraries without prompting.
|
|
727
|
+
Package flags keep existing versions and still set up project files and docs.`;
|
|
728
|
+
function parseArguments(args) {
|
|
729
|
+
const options = {
|
|
730
|
+
help: false,
|
|
731
|
+
docs: false,
|
|
732
|
+
packages: []
|
|
733
|
+
};
|
|
734
|
+
for (const arg of args) {
|
|
735
|
+
const pkg = packageFlags.get(arg);
|
|
736
|
+
if (arg === "--help" || arg === "-h") options.help = true;
|
|
737
|
+
else if (arg === "--docs") options.docs = true;
|
|
738
|
+
else if (pkg) {
|
|
739
|
+
if (!options.packages.includes(pkg)) options.packages.push(pkg);
|
|
740
|
+
} else throw new Error(`Unknown argument: ${arg}. Use --help for usage.`);
|
|
741
|
+
}
|
|
742
|
+
if (options.docs && options.packages.length > 0) throw new Error("--docs cannot be combined with package flags.");
|
|
743
|
+
return options;
|
|
744
|
+
}
|
|
745
|
+
//#endregion
|
|
746
|
+
//#region src/main.ts
|
|
747
|
+
async function main() {
|
|
748
|
+
const cliOptions = parseArguments(process$1.argv.slice(2));
|
|
749
|
+
if (cliOptions.help) {
|
|
750
|
+
console.log(CLI_HELP);
|
|
751
|
+
return;
|
|
752
|
+
}
|
|
753
|
+
const runtime = getRuntime();
|
|
754
|
+
const projectManifest = ProjectManifest.open();
|
|
755
|
+
if (cliOptions.docs) {
|
|
756
|
+
await refreshDocs(projectManifest);
|
|
757
|
+
return;
|
|
758
|
+
}
|
|
759
|
+
console.log();
|
|
760
|
+
intro(`Hi! 👋 (Running on ${runtime})`);
|
|
761
|
+
const installedPackages = projectManifest.getInstalledPackages();
|
|
762
|
+
const options = PACKAGE_OPTIONS.map((opt) => ({
|
|
763
|
+
...opt,
|
|
764
|
+
label: installedPackages.includes(opt.value) ? `${opt.label} \x1b[2m(installed)\x1b[22m` : opt.label
|
|
765
|
+
}));
|
|
766
|
+
const selectedPackages = cliOptions.packages.length > 0 ? cliOptions.packages : await multiselect({
|
|
767
|
+
message: "Which libraries would you like to install?\n\x1B[2m(space to select, arrows to navigate, enter to confirm)\x1B[22m\n",
|
|
768
|
+
options,
|
|
769
|
+
required: false
|
|
770
|
+
});
|
|
771
|
+
if (isCancel(selectedPackages)) {
|
|
772
|
+
cancel("Installation cancelled.");
|
|
773
|
+
process$1.exit(0);
|
|
774
|
+
}
|
|
775
|
+
const alreadyInstalled = selectedPackages.filter((pkg) => installedPackages.includes(pkg));
|
|
776
|
+
const packagesToInstall = [];
|
|
777
|
+
for (const pkg of selectedPackages) if (alreadyInstalled.includes(pkg)) {
|
|
778
|
+
if (cliOptions.packages.length > 0) continue;
|
|
779
|
+
const action = await select({
|
|
780
|
+
message: `${pkg} is already installed. What would you like to do?`,
|
|
781
|
+
options: [{
|
|
782
|
+
value: "skip",
|
|
783
|
+
label: "Keep existing version"
|
|
784
|
+
}, {
|
|
785
|
+
value: "update",
|
|
786
|
+
label: "Update to latest"
|
|
787
|
+
}]
|
|
788
|
+
});
|
|
789
|
+
if (isCancel(action)) {
|
|
790
|
+
cancel("Installation cancelled.");
|
|
791
|
+
process$1.exit(0);
|
|
792
|
+
}
|
|
793
|
+
if (action === "update") packagesToInstall.push(pkg);
|
|
794
|
+
} else packagesToInstall.push(pkg);
|
|
795
|
+
projectManifest.updateTasks(getProjectTasks(runtime));
|
|
796
|
+
const sInstall = spinner();
|
|
797
|
+
sInstall.start("Installing packages...");
|
|
798
|
+
try {
|
|
799
|
+
await installPackages(packagesToInstall);
|
|
800
|
+
projectManifest.reload();
|
|
801
|
+
const declared = projectManifest.getInstalledPackageSpecifiers();
|
|
802
|
+
if (projectManifest.getInstalledPackages().some((pkg) => ["@nshiab/simple-data-analysis", "@nshiab/journalism-dataviz"].includes(pkg)) && !declared["@observablehq/plot"]) {
|
|
803
|
+
await installPackages(["@observablehq/plot"]);
|
|
804
|
+
projectManifest.reload();
|
|
805
|
+
}
|
|
806
|
+
await ensureTooling(projectManifest);
|
|
807
|
+
projectManifest.reload();
|
|
808
|
+
const versions = getInstalledPackageVersions(projectManifest.getInstalledPackageSpecifiers());
|
|
809
|
+
if (projectManifest.getInstalledPackages().some((pkg) => !versions[pkg])) await runPackageManager(["install"]);
|
|
810
|
+
} catch (error) {
|
|
811
|
+
sInstall.stop("Package installation failed.");
|
|
812
|
+
throw error;
|
|
813
|
+
}
|
|
814
|
+
sInstall.stop("✅ Package installation complete.");
|
|
815
|
+
projectManifest.reload();
|
|
816
|
+
projectManifest.updateTasks(getProjectTasks());
|
|
817
|
+
execFileSync(process$1.execPath, [
|
|
818
|
+
"node_modules/vite-plus/bin/vp",
|
|
819
|
+
"fmt",
|
|
820
|
+
"package.json"
|
|
821
|
+
], { stdio: "pipe" });
|
|
822
|
+
const finalInstalledPackages = getInstalledPackageConfigs(projectManifest.getInstalledPackages()).map((pkg) => pkg.value);
|
|
823
|
+
const docsMapping = await refreshDocs(projectManifest);
|
|
824
|
+
createFolderStructure(finalInstalledPackages);
|
|
825
|
+
ensureGitignore();
|
|
826
|
+
ensureEnvFile();
|
|
827
|
+
ensureVscode();
|
|
828
|
+
ensureReadme(runtime, finalInstalledPackages);
|
|
829
|
+
ensureAgents(docsMapping, runtime, finalInstalledPackages);
|
|
830
|
+
outro(process$1.exitCode ? "Project setup complete; documentation needs attention." : "You are all set! 🙌");
|
|
831
|
+
}
|
|
832
|
+
async function refreshDocs(manifest) {
|
|
833
|
+
const packages = getInstalledPackageConfigs(manifest.getInstalledPackages()).map((pkg) => pkg.value);
|
|
834
|
+
const mapping = await syncPackageDocs(packages, getInstalledPackageVersions(manifest.getInstalledPackageSpecifiers()));
|
|
835
|
+
if (Object.keys(mapping).length !== packages.length) {
|
|
836
|
+
console.error("Documentation refresh incomplete. See the warnings above.");
|
|
837
|
+
process$1.exitCode = 1;
|
|
838
|
+
}
|
|
839
|
+
return mapping;
|
|
840
|
+
}
|
|
841
|
+
main().catch((error) => {
|
|
842
|
+
const message = error instanceof Error ? error.message : String(error);
|
|
843
|
+
console.error(`❌ Error: ${message}`);
|
|
844
|
+
process$1.exitCode = 1;
|
|
845
|
+
});
|
|
846
|
+
//#endregion
|
|
847
|
+
export {};
|
|
848
|
+
|
|
849
|
+
//# sourceMappingURL=main.mjs.map
|