githubmirror/node

tools/doc/alljson.mjs
54 строки2 KB
Antoine du Hamel
tools: enforce use of trailing commas in `tools/`
18 дек 2022, 19:39
18 дек 2022, 19:393ce4cef
// Build all.json by combining the miscs, modules, classes, globals, and methods
// from the generated json files.

import fs from 'fs';

const source = new URL('../../out/doc/api/', import.meta.url);

// Get a list of generated API documents.
const jsonFiles = fs.readdirSync(source, 'utf8')
  .filter((name) => name.includes('.json') && name !== 'all.json');

// Read the table of contents.
const toc = fs.readFileSync(new URL('./index.html', source), 'utf8');

// Initialize results. Only these four data values will be collected.
const results = {
  miscs: [],
  modules: [],
  classes: [],
  globals: [],
  methods: [],
};

// Identify files that should be skipped. As files are processed, they
// are added to this list to prevent dupes.
const seen = new Set(['all.json', 'index.json']);

// Extract (and concatenate) the selected data from each document.
// Expand hrefs found in json to include source HTML file.
for (const link of toc.match(/<a.*?>/g)) {
  const href = /href="(.*?)"/.exec(link)[1];
  const json = href.replace('.html', '.json');
  if (!jsonFiles.includes(json) || seen.has(json)) continue;
  const data = JSON.parse(
    fs.readFileSync(new URL(`./${json}`, source), 'utf8')
      .replace(/<a href=\\"#/g, `<a href=\\"${href}#`),
  );

  for (const property in data) {
    if (Object.hasOwn(results, property)) {
      data[property].forEach((mod) => {
        mod.source = data.source;
      });
      results[property].push(...data[property]);
    }
  }

  // Mark source as seen.
  seen.add(json);
}

// Write results.
fs.writeFileSync(new URL('./all.json', source),
                 `${JSON.stringify(results, null, 2)}\n`, 'utf8');