Merge pull request #127 from webdoc-labs/feature/out-source-files

Feature: Support for publishing source files

Author: ShukantPal

common/config/rush/pnpm-lock.yaml

@@ -28,6 +28,7 @@
     "build-pixi-api": "cd ../../pixi-api && webdoc --verbose && cd ../webdoc/example",
     "build-pixi-api-prod": "cd ../../pixi-api && webdoc --site-root pixi-api && cd ../webdoc/example",
     "build-pixi-api-gcp": "cd ../../pixi-api && webdoc --tutorials ./projects/guides --verbose && cd ../webdoc/example",
+    "build-pixi-api-gcp-inspect": "cd ../../pixi-api && node --inspect-brk --trace-warnings ../webdoc/example/node_modules/@webdoc/cli/cli.js --tutorials ./projects/guides --verbose && cd ../webdoc/example",
     "build-pixi-guides": "cd ../../guides && webdoc --tutorials docs && cd ../webdoc/example",
     "build-mongodb": "cd ../../node-mongodb-native && webdoc --verbose && cd ../webdoc/example"
   },

example/package.json

@@ -138,6 +138,8 @@ The `template` object is used by the site template.
     item defines a name and URI.
 * `template.routes`: This can be used to override specific routes generated by the template. For example, you can move the
   `tutorials` to be outputted at "/faq" instead of "/tutorials", if desired.
+* `template.sources`: (enabled by default) This will output the source code of the project as well and link symbols to their
+    locations in the code.
 * `template.title`: This is the title shown in the browser tabs (defaults to `template.applicationName`). You should use this
     if you have HTML in the application name.
 * `template.meta`: (optional) This can be used to define the `<meta>` key-value tags. The `{{url}}` variable can be used

packages/webdoc-cli/README.md

@@ -48,6 +48,7 @@ type ConfigSchema = {
     routes: {
       tutorials: string,
     },
+    sources: boolean,
     stylesheets: Array<string>,
     siteDomain?: string,
     siteRoot: string,
@@ -104,6 +105,7 @@ const defaultConfig: ConfigSchema = {
       tutorials: "tutorials",
     },
     siteRoot: "",
+    sources: true,
     stylesheets: [],
     mainPage: {
       title: "Main Page",

packages/webdoc-cli/src/config.js

@@ -141,7 +141,11 @@ async function main(argv: yargs.Argv) {
     docDatabase: db,
     opts: config.opts,
     tutorials,
+    source: sourceFiles,
     verbose: !!argv.verbose,
+    cmdLine: {
+      mainThread: argv.mainThread,
+    },
   };
 
   if (template.publish && typeof template.publish === "function") {

packages/webdoc-cli/src/index.js

@@ -0,0 +1,35 @@
+// @flow
+
+const fs = require("fs");
+const hljs = require("highlight.js");
+// $FlowFixMe
+const {isMainThread, parentPort} = require("worker_threads");
+
+function onMessage(data /*: { id: number, file: string } */) {
+  const {id, file} = data;
+
+  fs.readFile(file, "utf8", function onFileRead(err, raw) {
+    if (err) {
+      return parentPort.postMessage({
+        id,
+        file,
+        error: true,
+        result: null,
+      });
+    }
+
+    const languageSubset = file.endsWith(".js") ? ["javascript"] : undefined;
+    const result = hljs.highlightAuto(raw, languageSubset).value;
+
+    parentPort.postMessage({
+      id,
+      file,
+      error: false,
+      result,
+    });
+  });
+}
+
+if (!isMainThread) {
+  parentPort.on("message", onMessage);
+}

packages/webdoc-default-template/helper/workers/hl.js

@@ -47,7 +47,8 @@
     "code-prettify": "^0.1.0",
     "fs-extra": "^9.0.1",
     "markdown-it": "^11.0.0",
-    "markdown-it-highlightjs": "^3.1.0"
+    "markdown-it-highlightjs": "^3.1.0",
+    "highlight.js": "~10.7.2"
   },
   "devDependencies": {
     "@babel/cli": "^7.8.4",