fix: docs not being generated

Author: abose

build/jsDocGenerate.js

@@ -20,7 +20,7 @@
 
 /* eslint-env node */
 import * as documentation from 'documentation';
-import glob from "glob";
+import {glob} from "glob";
 import * as path from "path";
 import * as fs from "fs";
 import clc from 'cli-color';
@@ -45,26 +45,15 @@ function getIndexMarkdown(docRoot, filePaths) {
 
 async function generateDocIndex(docRoot) {
     const indexFileName = `${docRoot}GitHub-API-Index.md`;
-    let allDocFiles = await _getAllFiles(docRoot, '/**/*.md');
+    let allDocFiles = await _getAllFiles(docRoot, '**/*.md');
     let indexMarkdown = getIndexMarkdown(docRoot, allDocFiles);
     console.log("creating index file: ", clc.green(indexFileName));
     fs.mkdirSync(path.dirname(indexFileName), { recursive: true })
     fs.writeFileSync(indexFileName, indexMarkdown);
 }
 
 async function _getAllFiles(docRoot, globPattern) {
-    return new Promise((resolve, reject)=>{
-        let getDirectories = function (src, callback) {
-            glob(src + globPattern, callback);
-        };
-        getDirectories(docRoot, function (err, res) {
-            if (err) {
-                reject(err);
-            } else {
-                resolve(res);
-            }
-        });
-    });
+    return await glob(docRoot + globPattern, { ignore: 'node_modules/**' });
 }
 
 async function _processFile(filePath, srcRelativePath, generatedDocRoot) {
@@ -103,7 +92,7 @@ async function generateDocs() {
         generatedDocRoot = generatedDocRoot + "/";
     }
     console.log(`Generating docs for "${clc.green(srcRoot)}" to folder "${clc.green(generatedDocRoot)}"`);
-    let allSrcFiles = await _getAllFiles(srcRoot, '/**/*.js')
+    let allSrcFiles = await _getAllFiles(srcRoot, '**/*.js');
     console.log(`Found ${clc.blue(allSrcFiles.length)} js files. Scanning for files with comment // ${clc.blue(TAG_INCLUDE_IN_API_DOCS)} `);
     console.log(`Cleaning Generating docs folder "${clc.green(generatedDocRoot)}"`);
     fs.rmSync(generatedDocRoot, { recursive: true, force: true });

docs/generatedApiDocs/index-API.md

@@ -10,10 +10,8 @@ See [https://github.com/aicore/template-nodejs/wiki/How-To-Write-Docs][1] for mo
 
 and markdown code!
 
-    // usage within core:
-    const Metrics = require("utils/Metrics");
-
-    // usage within default extensions:
-    const Metrics = brackets.getModule("utils/Metrics");
+```js
+console.log("write sample code examples with code blocks");
+```
 
 [1]: https://github.com/aicore/template-nodejs/wiki/How-To-Write-Docs