Write into a sibling directory

Author: hsubox76

packages/rules-unit-testing/src/public_types/index.ts

@@ -266,10 +266,10 @@ export interface RulesTestContext {
   database(databaseURL?: string): firebase.database.Database;
 
   /**
-   * Get a {@link @firebase/storage#Storage} instance for this test context. The returned Firebase JS Client SDK instance
+   * Get a {@link @firebase/storage#FirebaseStorage} instance for this test context. The returned Firebase JS Client SDK instance
    * can be used with the client SDK APIs (v9 modular or v9 compat).
    *
-   * See: {@link @firebase/storage#Storage}
+   * See: {@link @firebase/storage#FirebaseStorage}
    * @param settings - the gs:// url to the Firebase Storage Bucket for testing. If specified,
    *                 returns a `Storage` instance for an emulated version of the bucket name
    * @returns a `Storage` instance configured to connect to the emulator

scripts/docgen/docgen.ts

@@ -100,4 +100,57 @@ async function generateDocs(forDevsite: boolean = false) {
     [command, 'markdown', '--input', 'temp', '--output', outputFolder],
     { stdio: 'inherit' }
   );
+
+  moveRulesUnitTestingDocs(outputFolder, command);
+}
+
+async function moveRulesUnitTestingDocs(
+  mainDocsFolder: string,
+  command: string
+) {
+  const rulesOutputFolder = `${projectRoot}/docs-rut`;
+
+  // Generate from rules-unit-testing.api.json only, to get an index.md.
+  // Hide output warnings about being unable to link to external packages.
+  await spawn(
+    'yarn',
+    [
+      command,
+      'markdown',
+      '--input',
+      'packages/rules-unit-testing/temp',
+      '--output',
+      rulesOutputFolder
+    ],
+    { stdio: ['inherit', 'ignore', 'inherit'] }
+  );
+
+  const rulesDocPaths = await new Promise<string[]>(resolve =>
+    glob(`${mainDocsFolder}/rules-unit-testing.*`, (err, paths) => {
+      if (err) throw err;
+      resolve(paths);
+    })
+  );
+
+  // Overwrite non-index files with files generated from global docgen script,
+  // which have links to external packages.
+  // These paths also need to be adjusted to point to a sibling directory.
+  for (const sourcePath of rulesDocPaths) {
+    const destinationPath = sourcePath.replace(
+      mainDocsFolder,
+      rulesOutputFolder
+    );
+    const originalText = fs.readFileSync(sourcePath, 'utf-8');
+    let alteredPathText = originalText.replace(
+      /\.\/database/g,
+      '../js/database'
+    );
+    alteredPathText = alteredPathText.replace(/\.\/storage/g, '../js/storage');
+    alteredPathText = alteredPathText.replace(
+      /\.\/firestore/g,
+      '../js/firestore'
+    );
+    fs.writeFileSync(destinationPath, alteredPathText);
+    fs.unlinkSync(sourcePath);
+  }
 }