add jssdk flag

Author: Feiyang1

repo-scripts/api-documenter/README.md

@@ -11,4 +11,6 @@ and then generates files in [Markdown](https://en.wikipedia.org/wiki/Markdown) f
 Use `-i` to specify the folder that contains api.json files.
 Use `-p` to specify the g3 path that contains the reference docs.
 
-By default, the command will create `toc.yaml` in folder `/toc`. To change the output folder, use the flag `-o`.
+By default, the command will create `toc.yaml` in folder `/toc`. To change the output folder, use the flag `-o`.
+
+To generate toc for the Firebase JS SDK, also set the flag `-j` to create the top level `firebase` toc item.

repo-scripts/api-documenter/src/cli/TocAction.ts

@@ -15,13 +15,17 @@
  * limitations under the License.
  */
 
-import { CommandLineStringParameter } from '@rushstack/ts-command-line';
+import {
+  CommandLineFlagParameter,
+  CommandLineStringParameter
+} from '@rushstack/ts-command-line';
 import { ApiDocumenterCommandLine } from './ApiDocumenterCommandLine';
 import { BaseAction } from './BaseAction';
 import { generateToc } from '../toc';
 
 export class TocAction extends BaseAction {
   private _g3PathParameter!: CommandLineStringParameter;
+  private _jsSDKParameter!: CommandLineFlagParameter;
   public constructor(parser: ApiDocumenterCommandLine) {
     super({
       actionName: 'toc',
@@ -42,12 +46,21 @@ export class TocAction extends BaseAction {
       description: `Specifies the path where the reference docs will be written to in g3.
                 Used to generate paths in the toc`
     });
+
+    this._jsSDKParameter = this.defineFlagParameter({
+      parameterLongName: '--js-sdk',
+      parameterShortName: '-j',
+      description:
+        `Generating toc for the Firebase JS SDK.` +
+        `It will create an artificial top level toc item "firebase".`
+    });
   }
 
   protected async onExecute(): Promise<void> {
     // override
     const { apiModel, outputFolder, addFileNameSuffix } = this.buildApiModel();
     const g3Path: string | undefined = this._g3PathParameter.value;
+    const jsSdk: boolean = this._jsSDKParameter.value;
 
     if (!g3Path) {
       throw new Error(
@@ -59,7 +72,8 @@ export class TocAction extends BaseAction {
       apiModel,
       outputFolder,
       addFileNameSuffix,
-      g3Path
+      g3Path,
+      jsSdk
     });
   }
 }

repo-scripts/api-documenter/src/toc.ts

@@ -27,6 +27,7 @@ export interface ITocGenerationOptions {
   g3Path: string;
   outputFolder: string;
   addFileNameSuffix: boolean;
+  jsSdk: boolean;
 }
 
 interface ITocItem {
@@ -39,14 +40,19 @@ export function generateToc({
   apiModel,
   g3Path,
   outputFolder,
-  addFileNameSuffix
+  addFileNameSuffix,
+  jsSdk
 }: ITocGenerationOptions) {
-  const js: ITocItem = {
-    title: 'firebase',
-    path: `${g3Path}/index`,
-    section: []
-  };
-  const toc = [js];
+  const toc = [];
+
+  if (jsSdk) {
+    const firebaseToc: ITocItem = {
+      title: 'firebase',
+      path: `${g3Path}/index`,
+      section: []
+    };
+    toc.push(firebaseToc);
+  }
 
   generateTocRecursively(apiModel, g3Path, addFileNameSuffix, toc);