create devsite toc

Author: Feiyang1

package.json

@@ -54,7 +54,8 @@
     "docgen:exp": "ts-node-script scripts/exp/docgen.ts",
     "postinstall": "yarn --cwd repo-scripts/changelog-generator build",
     "sa": "ts-node-script repo-scripts/size-analysis/cli.ts",
-    "api-documenter-devsite": "ts-node-script repo-scripts/api-documenter/src/start.ts"
+    "api-documenter-devsite": "ts-node-script repo-scripts/api-documenter/src/start.ts",
+    "toc-devsite": "ts-node-script scripts/exp/generate-devsite-toc.ts -i temp"
   },
   "repository": {
     "type": "git",
@@ -87,6 +88,7 @@
     "@types/sinon-chai": "3.2.5",
     "@types/tmp": "0.2.0",
     "@types/yargs": "16.0.0",
+    "@types/js-yaml": "4.0.0",
     "@typescript-eslint/eslint-plugin": "4.11.1",
     "@typescript-eslint/eslint-plugin-tslint": "4.11.1",
     "@typescript-eslint/parser": "4.11.1",

generate-devsite-toc.js renamed to scripts/exp/generate-devsite-toc.ts

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2020 Google LLC
+ * Copyright 2021 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,13 +15,31 @@
  * limitations under the License.
  */
 
-const yaml = require('js-yaml');
-const fs = require('fs');
+import * as yargs from 'yargs';
+import * as fs from 'fs';
+import * as path from 'path';
+import * as yaml from 'js-yaml';
+
+interface TocItem {
+  title: string;
+  path: string;
+  section?: TocItem[];
+}
+
+const argv = yargs
+  .options({
+    input: {
+      alias: 'i',
+      type: 'string',
+      default: 'temp'
+    }
+  })
+  .help().argv;
 
 const REF_DOC_DIR = '/docs/reference/js';
-const REPORT_DIR = './temp';
+const REPORT_DIR = path.resolve(process.cwd(), argv.input);
 
-const js = {
+const js: TocItem = {
   title: 'firebase',
   path: `${REF_DOC_DIR}/index`,
   section: []
@@ -38,7 +56,7 @@ for (const fileName of fs.readdirSync(REPORT_DIR)) {
     const entryPointName = entryPoint.canonicalReference
       .replace('!', '')
       .replace('@firebase/', '');
-    const entryPointToc = {
+    const entryPointToc: Required<TocItem> = {
       title: entryPointName,
       path: `${REF_DOC_DIR}/${getFileName(
         entryPoint,
@@ -75,7 +93,11 @@ console.log(
   )
 );
 
-function getFileName(apiMember, entryPoint, multipleEntryPoints = false) {
+function getFileName(
+  apiMember: any,
+  entryPoint: any,
+  multipleEntryPoints = false
+) {
   const entryPointName = entryPoint.canonicalReference.replace('!', '');
   const unscopedName = getUnscopedName(entryPointName);
   let entryPointPrefix = unscopedName;
@@ -102,7 +124,7 @@ function getFileName(apiMember, entryPoint, multipleEntryPoints = false) {
   }
 }
 
-function getUnscopedName(packageName) {
+function getUnscopedName(packageName: string) {
   const parts = packageName.split('/');
   if (parts.length === 1) {
     return packageName;

yarn.lock

@@ -2714,6 +2714,11 @@
   dependencies:
     "@types/istanbul-lib-report" "*"
 
+"@types/[email protected]":
+  version "4.0.0"
+  resolved "https://registry.npmjs.org/@types/js-yaml/-/js-yaml-4.0.0.tgz#d1a11688112091f2c711674df3a65ea2f47b5dfb"
+  integrity sha512-4vlpCM5KPCL5CfGmTbpjwVKbISRYhduEJvvUWsH5EB7QInhEj94XPZ3ts/9FPiLZFqYO0xoW4ZL8z2AabTGgJA==
+
 "@types/json-schema@*", "@types/json-schema@^7.0.3", "@types/json-schema@^7.0.5", "@types/json-schema@^7.0.6":
   version "7.0.7"
   resolved "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.7.tgz#98a993516c859eb0d5c4c8f098317a9ea68db9ad"