Merge branch 'main' into fix-theme-toggle

Author: AugustinMauroy

.github/workflows/auto-merge.yml

@@ -0,0 +1,25 @@
+name: Auto-merge PRs
+
+on:
+  schedule:
+    - cron: '*/15 * * * *'
+  workflow_dispatch:
+
+permissions:
+  pull-requests: write
+  contents: write
+
+jobs:
+  auto-merge:
+    if: github.repository == 'nodejs/doc-kit'
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@a90bcbc6539c36a85cdfeb73f7e2f433735f215b # v2.15.0
+        with:
+          egress-policy: audit
+
+      - uses: nodejs/web-team/actions/auto-merge-prs@b087df186d25f8792fb85cc7794f68718726b8ee
+        with:
+          merge-method: queue

docs/generators.md

@@ -137,7 +137,7 @@ export async function generate(input, worker) {
 
 /**
  * Transform metadata entries to MyFormat
- * @param {Array<ApiDocMetadataEntry>} entries
+ * @param {Array<MetadataEntry>} entries
  * @param {import('semver').SemVer} version
  * @returns {string}
  */
@@ -241,7 +241,7 @@ export async function* generate(input, worker) {
   };
 
   // Stream chunks as they complete
-  for await (const chunkResult of worker.stream(input, input, deps)) {
+  for await (const chunkResult of worker.stream(input, deps)) {
     // Process chunk result if needed
     yield chunkResult;
   }
@@ -316,7 +316,7 @@ export async function processChunk(fullInput, itemIndices, deps) {
  */
 export async function* generate(input, worker) {
   // Stream results as workers complete chunks
-  for await (const chunkResult of worker.stream(input, input, {})) {
+  for await (const chunkResult of worker.stream(input, {})) {
     // Yield immediately - downstream can start processing
     yield chunkResult;
   }

npm-shrinkwrap.json package-lock.jsonnpm-shrinkwrap.json renamed to package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@node-core/doc-kit",
   "type": "module",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/nodejs/doc-kit.git"

package.json

@@ -1,4 +1,6 @@
+import type { MetadataEntry } from '../metadata/types';
+
 export type Generator = GeneratorMetadata<
   {},
-  Generate<Array<ApiDocMetadataEntry>, Promise<Record<string, string>>>
+  Generate<Array<MetadataEntry>, Promise<Record<string, string>>>
 >;

src/__tests__/metadata.test.mjs

@@ -50,7 +50,7 @@ export async function* generate(_, worker) {
 
   // Parse the Javascript sources into ASTs in parallel using worker threads
   // source is both the items list and the fullInput since we use sliceInput
-  for await (const chunkResult of worker.stream(files, files)) {
+  for await (const chunkResult of worker.stream(files)) {
     yield chunkResult;
   }
 }

src/generators/addon-verify/types.d.ts

@@ -0,0 +1 @@
+export const STABILITY_INDEX_URL = 'documentation.html#stability-index';

src/generators/ast-js/generate.mjs

@@ -6,12 +6,11 @@ import { extname } from 'node:path';
 import { globSync } from 'tinyglobby';
 import { VFile } from 'vfile';
 
+import { STABILITY_INDEX_URL } from './constants.mjs';
 import getConfig from '../../utils/configuration/index.mjs';
-import createQueries from '../../utils/queries/index.mjs';
+import { QUERIES } from '../../utils/queries/index.mjs';
 import { getRemark } from '../../utils/remark.mjs';
 
-const { updateStabilityPrefixToLink } = createQueries();
-
 const remarkProcessor = getRemark();
 
 /**
@@ -26,9 +25,14 @@ export async function processChunk(inputSlice, itemIndices) {
   const results = [];
 
   for (const path of filePaths) {
-    const vfile = new VFile({ path, value: await readFile(path, 'utf-8') });
-
-    updateStabilityPrefixToLink(vfile);
+    const content = await readFile(path, 'utf-8');
+    const vfile = new VFile({
+      path,
+      value: content.replace(
+        QUERIES.stabilityIndexPrefix,
+        match => `[${match}](${STABILITY_INDEX_URL})`
+      ),
+    });
 
     results.push({
       tree: remarkProcessor.parse(vfile),
@@ -52,7 +56,7 @@ export async function* generate(_, worker) {
   );
 
   // Parse markdown files in parallel using worker threads
-  for await (const chunkResult of worker.stream(files, files)) {
+  for await (const chunkResult of worker.stream(files)) {
     yield chunkResult;
   }
 }

src/generators/ast/constants.mjs

@@ -6,7 +6,7 @@ import { join } from 'node:path';
 import { remove } from 'unist-util-remove';
 
 import getConfig from '../../utils/configuration/index.mjs';
-import createQueries from '../../utils/queries/index.mjs';
+import { UNIST } from '../../utils/queries/index.mjs';
 
 /**
  * Generates the simplified JSON version of the API docs
@@ -16,17 +16,14 @@ import createQueries from '../../utils/queries/index.mjs';
 export async function generate(input) {
   const config = getConfig('json-simple');
 
-  // Iterates the input (ApiDocMetadataEntry) and performs a few changes
+  // Iterates the input (MetadataEntry) and performs a few changes
   const mappedInput = input.map(node => {
     // Deep clones the content nodes to avoid affecting upstream nodes
     const content = JSON.parse(JSON.stringify(node.content));
 
     // Removes numerous nodes from the content that should not be on the "body"
     // of the JSON version of the API docs as they are already represented in the metadata
-    remove(content, [
-      createQueries.UNIST.isStabilityNode,
-      createQueries.UNIST.isHeading,
-    ]);
+    remove(content, [UNIST.isStabilityNode, UNIST.isHeading]);
 
     return { ...node, content };
   });