[FEATURE]: Port build_directory_md from Python to TypeScript

[cclauss]

Motivation

The Python code run in our GitHub Action directory_formatter.yml should be replaced by TypeScript code so that contributors to this repo are better able to maintain it.

This process should be done in three separate pull requests.

• [ ] Run both the Python and TypeScript versions in the same GitHub Action and fail if the two files are not identical.
• [ ] Remove the running of the Python code in the GitHub Action and remove the Python file.
• [ ] [Optional] Modify the TypeScript version to add any new information and/or look and feel.

Examples

No response

Possible workarounds

No response

[appgurueu]

The Python code run in our GitHub Action directory_formatter.yml should be replaced by TypeScript code so that contributors to this repo are better able to maintain it.

I disagree. It is not necessary to duplicate this script in TypeScript as long as the Python script is working well. CI is "meta" for this repo and does not have to be in TS. We're not converting the embedded bash either.

[cclauss]

https://github.com/TheAlgorithms/JavaScript/issues/160

[Panquesito7]

The scripts should be rather taken from the scripts repository, IMO. There are still a few pending changes on that, so, you might want to wait a bit.

[appgurueu]

The action currently downloads the script from the script repository using wget.

[Panquesito7]

Oh, I meant using the newly actions we've created (still WIP, though).

[cclauss]

A bit more on why creating a TypeScript implementation is a good idea… https://github.com/TheAlgorithms/Rust/issues/473

[Panquesito7]

So, we're not going to use this or? 🤔

[cclauss]

I closed by mistake. I will let you all decide how you want to proceed.

[Panquesito7]

Feel free to choose, @raklaptudirm and @appgurueu. I'm fine with any of the options. 🙂

[appgurueu]

If someone submits a decent TS implementation, I'd be fine with switching, but this is definitely not a priority.

[cclauss]

ChatGPT ported the JavaScript repo’s implementation to TypeScript…

import path from 'path'
import fs from 'fs'
import { globby } from 'globby'

function pathPrefix(i: number): string {
  const res = '  '.repeat(i)
  return res + '*'
}

function printPath(oldPath: string, newPath: string, output: string[]): string {
  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: string[]): string {
  const output: string[] = []

  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) {
    let filename = path.basename(filepath)
    filepath = path.dirname(filepath)

    if (filepath !== oldPath) {
      oldPath = printPath(oldPath, filepath, output)
    }

    let indent = filepath.split(path.sep).length

    // prepare the markdown-esque prefix to the file's line
    const prefix = pathPrefix(indent)

    // remove extension from filename
    const name = path.basename(filename, ".js")
    const url = path.join(filepath, filename)

    output.push(`${prefix} [${name}](${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/**/*",
  '!**/*.test.js',
  '!**/*.manual-test.js',
  '!babel.config.js'
])
  // create markdown content
  .then(pathsToMarkdown)
  // write markdown to file
  .then(markdown => fs.writeFileSync('DIRECTORY.md', markdown + '\n', { encoding: 'utf8' }))