aboutsummaryrefslogtreecommitdiff
path: root/website/scripts/prepare-docs.mjs
blob: a96e2c41af74654234ef54f524958574c4232361 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
import { cp, mkdir, readFile, readdir, rm, writeFile } from 'node:fs/promises';
import { dirname, extname, join, relative, resolve } from 'node:path';
import { fileURLToPath } from 'node:url';
import process from 'node:process';

const websiteDir = dirname(fileURLToPath(import.meta.url));
const repoRoot = process.env.HERDR_DOCS_REPO_ROOT
  ? resolve(process.env.HERDR_DOCS_REPO_ROOT)
  : resolve(websiteDir, '../..');
const publicDir = resolve(repoRoot, 'website/public');
const stableDocsDir = resolve(repoRoot, 'website/src/content/docs');
const previewDocsDir = resolve(stableDocsDir, 'preview');
const generatedVersionsDocsDir = resolve(stableDocsDir, '_versions');
const versionsDir = resolve(repoRoot, 'docs/versions');
const versionsManifestPath = resolve(versionsDir, 'manifest.json');
const previewManifestPath = resolve(repoRoot, 'website/preview.json');
const generatedVersionsDataPath = resolve(repoRoot, 'website/src/data/docs-versions.json');
const stableConfigReferenceDestination = resolve(
  repoRoot,
  'website/src/data/config-reference.json',
);
const previewConfigReferenceDestination = resolve(
  repoRoot,
  'website/src/data/config-reference-preview.json',
);
const generatedVersionReferencesPath = resolve(
  repoRoot,
  'website/src/data/config-reference-versions.json',
);

if (process.argv[2] === '--rewrite-preview-doc-fixture') {
  const chunks = [];
  for await (const chunk of process.stdin) chunks.push(chunk);
  process.stdout.write(
    rewritePreviewDocContent(Buffer.concat(chunks).toString('utf8'), '', {
      buildId: '2026-07-29-44b3adb12552',
      commit: '44b3adb125524ea9a55739eee3776f922f2115ad',
    }),
  );
} else if (process.argv[2] === '--rewrite-version-doc-fixture') {
  const chunks = [];
  for await (const chunk of process.stdin) chunks.push(chunk);
  process.stdout.write(
    rewriteVersionDocContent(Buffer.concat(chunks).toString('utf8'), {
      version: process.argv[3] ?? '0.7.5',
      tag: `v${process.argv[3] ?? '0.7.5'}`,
      sourceRoot: 'docs/next/website/src/content/docs',
      relativePath: 'index.mdx',
    }),
  );
} else {
  const supported = new Set(['--docs-only', '--draft']);
  const unsupported = process.argv.slice(2).filter((argument) => !supported.has(argument));
  if (unsupported.length > 0) {
    throw new Error('usage: node website/scripts/prepare-docs.mjs [--docs-only] [--draft]');
  }
  if (!process.argv.includes('--docs-only')) await preparePublicAssets();
  await prepareDocs({ draft: process.argv.includes('--draft') });
}

async function preparePublicAssets() {
  await rm(publicDir, { recursive: true, force: true });
  await mkdir(publicDir, { recursive: true });

  for (const file of [
    'install.sh',
    'install.ps1',
    'agent-guide.md',
    'latest.json',
    'preview.json',
    'robots.txt',
    '_headers',
    '_redirects',
  ]) {
    const source = resolve(repoRoot, 'website', file);
    try {
      await cp(source, resolve(publicDir, file));
    } catch (error) {
      if (file !== 'preview.json' || error.code !== 'ENOENT') throw error;
    }
  }

  for (const directory of ['assets', 'css', 'agent-detection']) {
    await cp(resolve(repoRoot, 'website', directory), resolve(publicDir, directory), {
      recursive: true,
    });
  }
}

async function prepareDocs({ draft }) {
  const manifest = JSON.parse(await readFile(versionsManifestPath, 'utf8'));
  if (
    manifest.schema_version !== 1 ||
    typeof manifest.current !== 'string' ||
    !['legacy', 'snapshot'].includes(manifest.stable_source ?? 'legacy')
  ) {
    throw new Error(`${versionsManifestPath} has an unsupported schema`);
  }
  const currentEntry = manifest.versions.find((entry) => entry.version === manifest.current);
  if (!currentEntry) throw new Error(`current docs version ${manifest.current} has no snapshot`);

  const previewManifest = JSON.parse(await readFile(previewManifestPath, 'utf8'));
  if (!/^[0-9a-f]{40}$/.test(previewManifest.commit ?? '')) {
    throw new Error(`${previewManifestPath} must contain a full preview commit SHA`);
  }
  const previewWebsiteRoot = resolve(repoRoot, draft ? 'docs/next/website' : 'docs/preview/website');
  const previewDocsSourceDir = resolve(previewWebsiteRoot, 'src/content/docs');
  const previewConfigReferenceSource = resolve(
    previewWebsiteRoot,
    'src/data/config-reference.json',
  );

  if ((manifest.stable_source ?? 'legacy') === 'snapshot') {
    await rm(stableDocsDir, { recursive: true, force: true });
    const currentSnapshotRoot = resolve(versionsDir, manifest.current, 'website');
    await copyPreparedDocs(
      resolve(currentSnapshotRoot, 'src/content/docs'),
      stableDocsDir,
      (content, relativePath) =>
        rewriteStableDocContent(content, {
          tag: currentEntry.tag,
          sourceRoot: currentEntry.source,
          relativePath,
        }),
    );
    const currentReference = resolve(currentSnapshotRoot, 'src/data/config-reference.json');
    try {
      await cp(currentReference, stableConfigReferenceDestination);
    } catch (error) {
      if (error.code !== 'ENOENT') throw error;
      await rm(stableConfigReferenceDestination, { force: true });
    }
  } else {
    await rm(previewDocsDir, { recursive: true, force: true });
    await rm(generatedVersionsDocsDir, { recursive: true, force: true });
  }

  await copyPreparedDocs(previewDocsSourceDir, previewDocsDir, (content, relativePath) =>
    rewritePreviewDocContent(content, relativePath, {
      buildId: draft ? 'draft' : previewManifest.build_id,
      commit: draft ? 'master' : previewManifest.commit,
    }),
  );
  await cp(previewConfigReferenceSource, previewConfigReferenceDestination);

  const scopes = {
    stable: await collectDocsScope(
      (manifest.stable_source ?? 'legacy') === 'snapshot'
        ? resolve(versionsDir, manifest.current, 'website/src/content/docs')
        : stableDocsDir,
      new Set(['preview', '_versions']),
    ),
    preview: await collectDocsScope(previewDocsSourceDir),
  };
  const configReferences = {};

  for (const entry of manifest.versions) {
    const version = entry.version;
    const snapshotDocsRoot = resolve(versionsDir, version, 'website/src/content/docs');
    const destinationRoot = resolve(generatedVersionsDocsDir, version);
    await copyPreparedDocs(snapshotDocsRoot, destinationRoot, (content, relativePath) =>
      rewriteVersionDocContent(content, {
        version,
        tag: entry.tag,
        sourceRoot: entry.source,
        relativePath,
      }),
    );
    scopes[version] = await collectDocsScope(snapshotDocsRoot);

    const referencePath = resolve(
      versionsDir,
      version,
      'website/src/data/config-reference.json',
    );
    try {
      configReferences[version] = JSON.parse(await readFile(referencePath, 'utf8'));
    } catch (error) {
      if (error.code !== 'ENOENT') throw error;
    }
  }

  await writeFile(
    generatedVersionsDataPath,
    `${JSON.stringify({
      ...manifest,
      preview: {
        build_id: draft ? 'draft' : previewManifest.build_id,
        commit: draft ? 'master' : previewManifest.commit,
      },
      scopes,
    }, null, 2)}\n`,
    'utf8',
  );
  await writeFile(
    generatedVersionReferencesPath,
    `${JSON.stringify(configReferences, null, 2)}\n`,
    'utf8',
  );
}

async function copyPreparedDocs(sourceDir, destinationDir, rewrite, pathPrefix = '') {
  await mkdir(destinationDir, { recursive: true });
  for (const entry of await readdir(sourceDir, { withFileTypes: true })) {
    const source = join(sourceDir, entry.name);
    const destination = join(destinationDir, entry.name);
    const relativePath = pathPrefix ? `${pathPrefix}/${entry.name}` : entry.name;
    if (entry.isDirectory()) {
      await copyPreparedDocs(source, destination, rewrite, relativePath);
      continue;
    }
    if (!entry.isFile()) continue;

    if (!['.md', '.mdx'].includes(extname(entry.name).toLowerCase())) {
      await cp(source, destination);
      continue;
    }
    const content = await readFile(source, 'utf8');
    await writeFile(destination, rewrite(content, relativePath), 'utf8');
  }
}

async function collectDocsScope(sourceDir, excludedDirectories = new Set()) {
  const locales = { root: [], ja: [], 'zh-cn': [] };

  async function walk(directory, prefix = '') {
    for (const entry of await readdir(directory, { withFileTypes: true })) {
      if (entry.isDirectory() && excludedDirectories.has(entry.name)) continue;
      const path = join(directory, entry.name);
      const relativePath = prefix ? `${prefix}/${entry.name}` : entry.name;
      if (entry.isDirectory()) {
        await walk(path, relativePath);
        continue;
      }
      if (!entry.isFile() || !['.md', '.mdx'].includes(extname(entry.name))) continue;

      const segments = relativePath.replace(/\.(md|mdx)$/i, '').split('/');
      const locale = segments[0] === 'ja' || segments[0] === 'zh-cn' ? segments.shift() : 'root';
      const page = segments.join('/').replace(/(^|\/)index$/, '').replace(/\/$/, '');
      locales[locale].push(page);
    }
  }

  await walk(sourceDir);
  for (const pages of Object.values(locales)) pages.sort();
  for (const locale of ['ja', 'zh-cn']) {
    if (locales[locale].length === 0) locales[locale] = [...locales.root];
  }
  return { locales };
}

export function rewritePreviewDocContent(
  content,
  relativePath = '',
  { buildId, commit } = {
    buildId: 'preview',
    commit: 'master',
  },
) {
  const taggedContent = rewriteRepositoryLinks(
    content.replaceAll('/docs/', '/docs/preview/'),
    commit,
  );
  const rewritten = rewriteRelativeDocPaths(taggedContent, 1);
  const withSourceLink = setGeneratedEditUrl(
    rewritten,
    `https://github.com/herdrdev/herdr/blob/${commit}/docs/next/website/src/content/docs/${relativePath}`,
  );
  return insertPreviewNotice(withSourceLink, relativePath, { buildId, commit });
}

export function rewriteStableDocContent(content, { tag, sourceRoot, relativePath }) {
  const taggedContent = rewriteRepositoryLinks(content, tag);
  return setGeneratedEditUrl(
    taggedContent,
    `https://github.com/herdrdev/herdr/blob/${tag}/${sourceRoot}/${relativePath}`,
  );
}

export function rewriteVersionDocContent(content, { version, tag, sourceRoot, relativePath }) {
  const taggedContent = rewriteRepositoryLinks(
    content.replaceAll('/docs/', `/docs/${version}/`),
    tag,
  );
  const rewritten = rewriteRelativeDocPaths(taggedContent, 2);
  return setGeneratedEditUrl(
    rewritten,
    `https://github.com/herdrdev/herdr/blob/${tag}/${sourceRoot}/${relativePath}`,
  );
}

function rewriteRepositoryLinks(content, ref) {
  return content
    .replaceAll(
      'https://github.com/herdrdev/herdr/blob/master/',
      `https://github.com/herdrdev/herdr/blob/${ref}/`,
    )
    .replaceAll(
      'https://raw.githubusercontent.com/herdrdev/herdr/master/',
      `https://raw.githubusercontent.com/herdrdev/herdr/${ref}/`,
    );
}

function rewriteRelativeDocPaths(content, extraDepth) {
  const parents = '../'.repeat(extraDepth);
  return content
    .replace(/((?:\.\.\/)+)(?=public\/)/g, `$1${parents}`)
    .replace(/^(import .*from\s+['"])(?=(?:\.\.\/)+components\/)/gm, `$1${parents}`);
}

function setGeneratedEditUrl(content, editUrl) {
  if (!content.startsWith('---\n') || /^editUrl:/m.test(content)) return content;
  return content.replace(/^---\n/, `---\neditUrl: ${editUrl}\n`);
}

function insertPreviewNotice(content, relativePath, { buildId, commit }) {
  const source = commit === 'master' ? '`master` draft' : `[${commit.slice(0, 12)}](https://github.com/herdrdev/herdr/commit/${commit})`;
  const notice = [
    `> Preview build \`${buildId}\`, published from ${source}. Stable docs remain at [/docs/](/docs/).`,
    '',
    '',
  ].join('\n');
  const indexPrefix =
    relativePath === 'index.mdx'
      ? content.replace('title: Herdr documentation', 'title: Herdr preview documentation')
      : content;
  const frontmatter = indexPrefix.match(/^---\n[\s\S]*?\n---\n/);
  if (!frontmatter) {
    return insertNoticeAfterImports(indexPrefix, notice);
  }
  const body = indexPrefix.slice(frontmatter[0].length);
  return `${frontmatter[0]}\n${insertNoticeAfterImports(body, notice)}`;
}

function insertNoticeAfterImports(content, notice) {
  const imports = content.match(/^(\s*import .+?;\n)+\s*/);
  if (!imports) {
    return `${notice}${content}`;
  }
  return `${imports[0]}${notice}${content.slice(imports[0].length)}`;
}