fix: add id to generate file name

BREAKING CHANGE: file are now named by its id (symbolType + symbolName)

Author: Romakita

packages/ts-doc/components/code-highlight/code-highlight.js

@@ -1,5 +1,5 @@
 const {stripsComments} = require("../../src/utils/strips");
-const {highlight} = require("../../src/highlight");
+const {highlight} = require("./highlight");
 
 module.exports = {
   name: "codeHighlight",

packages/ts-doc/src/highlight/index.js renamed to packages/ts-doc/components/code-highlight/highlight.js

@@ -1,6 +1,6 @@
 "use strict";
 
-const {context} = require("../context");
+const {context} = require("../../src/context");
 const KEYWORDS =
   /(\benum\b|\bstatic\b|\bclass\b|\binterface\b|\bprivate\b|\bpublic\b|\bconst\b|\blet\b|\bprotected\b|\bimplements\b|\bconstructor\b|\breadonly\b|\babstract\b|\bimport\b|\bexport\b|\bas\b|\bfrom\b|\bextends\b)/g;
 const TYPES = /(\bany\b|\bstring\b|\bboolean\b|\bnumber\b|\bDate\b|\bvoid\b)/g;

packages/ts-doc/src/highlight/index.spec.js renamed to packages/ts-doc/components/code-highlight/highlight.spec.js

@@ -1,5 +1,5 @@
 const {expect} = require("chai");
-const {highlight} = require("./index");
+const {highlight} = require("./highlight");
 
 describe("Highlight", () => {
   it("should highlight content", () => {

packages/ts-doc/components/symbol-params/symbol-params.js

@@ -1,4 +1,4 @@
-const {bindSymbols} = require("../../src/highlight");
+const {bindSymbols} = require("../code-highlight/highlight");
 module.exports = {
   name: "symbolParams",
   trim: false,

packages/ts-doc/src/models/DocSymbol.js

@@ -2,6 +2,7 @@ const path = require("path");
 const normalizePath = require("normalize-path");
 const {context} = require("../context");
 const {descriptionParser} = require("../parsers/description-parser.js");
+const {dashCase} = require("../utils/dashCase");
 
 const _filterParams = (labels) => {
   return labels
@@ -45,6 +46,10 @@ class DocSymbol {
     this.labels = [];
   }
 
+  get id() {
+    return dashCase(this.symbolType + "-" + this.symbolName);
+  }
+
   get path() {
     return this.docFile.path;
   }
@@ -126,7 +131,7 @@ class DocSymbol {
    * @returns {*}
    */
   get outputPath() {
-    const file = normalizePath(path.join(context.outputDir, path.dirname(this.docFile.relativePackagePath), `${this.symbolName}.md`));
+    const file = normalizePath(path.join(context.outputDir, path.dirname(this.docFile.relativePackagePath), `${this.id}.md`));
 
     return context.outputResolver(file);
   }

packages/ts-doc/src/parsers/DocParser.js

@@ -37,32 +37,29 @@ class DocParser {
   static async parse(docFile) {
     const {symbols} = new DocParser(docFile.contents).parse();
 
-    for (const [, symbol] of symbols) {
-      try {
-        await symbol.setDocFile(docFile);
-        const newSymbol = context.symbols.push(symbol);
-        docFile.symbols.set(newSymbol.symbolName, newSymbol);
-      } catch (er) {
-        logger.error("Fail to process symbol", {symbol, error: er});
+    const promises = await Promise.all(
+      symbols.values().map(async (symbol) => {
+        try {
+          await symbol.setDocFile(docFile);
+
+          return symbol;
+        } catch (er) {
+          logger.error("Fail to process symbol", {symbol, error: er});
+        }
+      })
+    );
+
+    const parsedSymbols = await Promise.all(promises);
+
+    for (const symbol of parsedSymbols) {
+      if (symbol) {
+        docFile.symbols.set(symbol.symbolName, symbol);
       }
     }
 
     return docFile.symbols;
   }
 
-  // /**
-  //  *
-  //  * @param str
-  //  * @returns {string}
-  //  */
-  // overview (str = '') {
-  //   return stripsTags(stripsComments(str))
-  //     .split('\n')
-  //     .filter(o => !!o.trim())
-  //     .join('\n')
-  //     .trim()
-  // }
-
   /**
    *
    */

packages/ts-doc/src/scan/scan.js

@@ -58,17 +58,24 @@ module.exports = {
     let symbolsSize = 0;
     const files = await globby(patterns);
 
-    for (const file of files) {
-      try {
-        const symbols = await DocParser.parse(new DocFile(file));
+    // paginate files by 5
+    for (let i = 0; i < files.length; i += 5) {
+      const filesChunk = files.slice(i, i + 5);
 
-        symbols.forEach((symbol) => {
-          context.logger(`Scanned symbol '${chalk.cyan(symbol.symbolName)}'`);
-          symbolsSize++;
-        });
-      } catch (er) {
-        context.logger.error(chalk.red(er), er.stack);
-      }
+      await Promise.all(
+        filesChunk.map(async (file) => {
+          try {
+            const symbols = await DocParser.parse(new DocFile(file));
+
+            symbols.forEach((symbol) => {
+              context.logger(`Scanned symbol '${chalk.cyan(symbol.symbolName)}'`);
+              symbolsSize++;
+            });
+          } catch (er) {
+            context.logger.error(chalk.red(er), er.stack);
+          }
+        })
+      );
     }
 
     context.logger(`${chalk.green(symbolsSize)} scanned symbols`);

packages/ts-doc/src/tasks/build-api.js

@@ -15,13 +15,17 @@ module.exports = {
       .then(() => context.readPkg())
       .then(() => scanComponents(context.templatesDir))
       .then(() => scanFiles(context.scanPatterns))
-      .then(() => {
+      .then(async () => {
         let symbols = 0;
-        context.symbols.forEach((symbol) => {
-          const content = context.components.page(symbol);
-          symbols++;
-          return writeSymbol(symbol, content);
-        });
+
+        await Promise.all(
+          context.symbols.toArray().map((symbol) => {
+            const content = context.components.page(symbol);
+            symbols++;
+            return writeSymbol(symbol, content);
+          })
+        );
+
         logger(chalk.green(symbols) + " symbols write");
       })
       .then(() => writeJson())

packages/ts-doc/src/utils/dashCase.js

@@ -0,0 +1,6 @@
+module.exports.dashCase = function dashCase(str) {
+  return str
+    .replace(/([a-z])([A-Z])/g, "$1-$2")
+    .replace(/[\s_]+/g, "-")
+    .toLowerCase();
+};

packages/ts-doc/src/utils/dashCase.spec.js

@@ -0,0 +1,9 @@
+const {expect} = require("chai");
+const {dashCase} = require("./dashCase");
+
+describe("dashCase", () => {
+  it("should convert camelCase to dash-case", () => {
+    expect(dashCase("camelCase")).to.equal("camel-case");
+    expect(dashCase("camelCase-test")).to.equal("camel-case-test");
+  });
+});