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.

Author: defaude

.github/workflows/UpdateDirectory.js

@@ -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/UpdateDirectory.mjs

@@ -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: |

.github/workflows/update_directory_md.yml

@@ -27,6 +27,7 @@
   "devDependencies": {
     "babel-jest": "^26.3.0",
     "doctest": "^0.17.1",
+    "globby": "^12.0.2",
     "jest": "^26.4.2",
     "standard": "^14.3.4"
   }