Clean up and speed up UpdateDirectory.js

Uses globby to find all algorithm files. This is way quicker and less error-prone than the previous implementation. Plus, it allows us to fine-tune excludes (e.g. test files and the babel config).

This also removes the need for setTimeouts which greatly speeds up the whole thing.

.github/workflows/UpdateDirectory.js

@@ -1,108 +0,0 @@
-// requiring path and fs modules
-const path = require('path');
-const fs = require('fs');
-
-let URL_BASE = "https://github.com/TheAlgorithms/Javascript/blob/master";
-let g_output = [];
-
-let filepaths = [];
-function good_filepaths(top_dir = ".") {
-  fs.readdir(top_dir, function(err, list) {
-    if (err) {
-      console.log(err);
-      return;
-    }
-    list.forEach(function(file) {
-      let path = top_dir + "/" + file;
-      if (!file.startsWith(".")) {
-        fs.stat(path, function(err, stat) {
-          if (stat && stat.isDirectory()) {
-            good_filepaths(path);
-          } else {
-            if (file.toLowerCase().endsWith(".js")) {
-              filepaths.push(path.slice(2));
-            }
-          }
-        });
-      }
-    });
-  })
-}
-
-function md_prefix(i) {
-  if (i) {
-    let res = '  '.repeat(i);
-    return res + "*";
-  } else {
-    return "\n##"
-  }
-}
-
-function print_path(old_path, new_path) {
-  let old_parts = old_path.split(path.sep);
-  let new_parts = new_path.split(path.sep);
-  for (let i = 0; i < new_parts.length; ++i) {
-    let new_part = new_parts[i];
-    if (i + 1 > old_parts.len || old_parts[i] != new_part) {
-      if (new_part) {
-        g_output.push(`${md_prefix(i)} ${new_part.replace('_', ' ')}`);
-      }
-    }
-  }
-  return new_path;
-}
-
-function build_directory_md(top_dir = ".") {
-  old_path = "";
-  filepaths.sort(function(a, b) {
-    if (a.toLowerCase() < b.toLowerCase()) return -1;
-    if (a.toLowerCase() > b.toLowerCase()) return 1;
-    return 0;
-  });
-  for (let filepath of filepaths) {
-    file = filepath.split(path.sep);
-    if (file.length == 1) {
-      filepath = "";
-      filename = file[0];
-    } else {
-      let total = file.length;
-      filename = file[total - 1];
-      filepath = file.splice(0, total - 1).join(path.sep);
-    }
-    if (filepath != old_path) {
-      old_path = print_path(old_path, filepath);
-    }
-    let indent = 0;
-    for (let i = 0; i < filepath.length; ++i) {
-      if (filepath[i] == path.sep) {
-        ++indent;
-      }
-    }
-    if (filepath) {
-      ++indent;
-    }
-    let urls = [URL_BASE, filepath, filename];
-    let url = urls.join("/").replace(" ", "%20");
-    // remove extension from filename
-    filename = filename.split(".")[0];
-    g_output.push(`${md_prefix(indent)} [${filename}](${url})`);
-  }
-  g_output = g_output.join('\n');
-  return g_output;
-}
-
-good_filepaths();
-setTimeout(() => {
-  // once the filepaths have been computed
-  build_directory_md();
-  // console.log(filepaths);
-}, 1000);
-setTimeout(() => {
-  // once the g_output has been constructed, write to the file
-  fs.writeFile('DIRECTORY.md', g_output + '\n', (err) => {
-    if (err) {
-      console.log(err);
-    }
-  })
-  // console.log(g_output);
-}, 1000);

.github/workflows/UpdateDirectory.mjs

@@ -0,0 +1,77 @@
+import path from 'path'
+import fs from 'fs'
+import { globby } from 'globby'
+
+const URL_BASE = 'https://github.com/TheAlgorithms/Javascript/blob/master'
+
+function pathPrefix (i) {
+  if (i) {
+    const res = '  '.repeat(i)
+    return res + '*'
+  } else {
+    return '\n##'
+  }
+}
+
+function printPath (oldPath, newPath, output) {
+  const oldParts = oldPath.split(path.sep)
+  const newParts = newPath.split(path.sep)
+  for (let i = 0; i < newParts.length; ++i) {
+    const newPart = newParts[i]
+    if (i + 1 > oldParts.length || oldParts[i] !== newPart) {
+      if (newPart) {
+        output.push(`${pathPrefix(i)} ${newPart.replace('_', ' ')}`)
+      }
+    }
+  }
+  return newPath
+}
+
+function pathsToMarkdown (filePaths) {
+  const output = []
+
+  let oldPath = ''
+  filePaths.sort(function (a, b) {
+    if (a.toLowerCase() < b.toLowerCase()) return -1
+    if (a.toLowerCase() > b.toLowerCase()) return 1
+    return 0
+  })
+  for (let filepath of filePaths) {
+    const file = filepath.split(path.sep)
+    let filename = ''
+    if (file.length === 1) {
+      filepath = ''
+      filename = file[0]
+    } else {
+      const total = file.length
+      filename = file[total - 1]
+      filepath = file.splice(0, total - 1).join(path.sep)
+    }
+    if (filepath !== oldPath) {
+      oldPath = printPath(oldPath, filepath, output)
+    }
+    let indent = 0
+    for (let i = 0; i < filepath.length; ++i) {
+      if (filepath[i] === path.sep) {
+        ++indent
+      }
+    }
+    if (filepath) {
+      ++indent
+    }
+    const urls = [URL_BASE, filepath, filename]
+    const url = urls.join('/').replace(' ', '%20')
+    // remove extension from filename
+    filename = filename.split('.')[0]
+    output.push(`${pathPrefix(indent)} [${filename}](${url})`)
+  }
+
+  return output.join('\n')
+}
+
+// get paths of all .js files - excluding node_modules, the .github folder, tests and config stuff
+globby(['**/*.js', '!(node_modules|.github)/**/*', '!**/*.test.js', '!babel.config.js'])
+  // create markdown content
+  .then(pathsToMarkdown)
+  // write markdown to file
+  .then(markdown => fs.writeFileSync('DIRECTORY.md', markdown + '\n', { encoding: 'utf8' }))

.github/workflows/update_directory_md.yml

@@ -13,7 +13,7 @@ jobs:
           node-version: '14'
 
       - name: 🗄️ Create Directory from JS files
-        run: node .github/workflows/UpdateDirectory.js
+        run: node .github/workflows/UpdateDirectory.mjs
 
       - name: 🤓 Commit & push new Directory (if needed)
         run: |