Skip to content

docs: tweak DIRECTORY.md generation #999

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Apr 28, 2022
Merged

docs: tweak DIRECTORY.md generation #999

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3590019
tests: change extention of helper file
raklaptudirm Apr 28, 2022
848b1d1
chore: revert previous change
raklaptudirm Apr 28, 2022
676000e
chore: ignore dirs with name "test"
raklaptudirm Apr 28, 2022
85e81a8
docs: update directory styling
raklaptudirm Apr 28, 2022
e0a6a9c
refactor: make code more idiomatic
raklaptudirm Apr 28, 2022
c668a30
docs: format directories to be bold
raklaptudirm Apr 28, 2022
2537c52
chore: change char conting method
raklaptudirm Apr 28, 2022
457e637
fix: add 1 to ident count
raklaptudirm Apr 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 14 additions & 32 deletions .github/workflows/UpdateDirectory.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,24 @@ 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##'
}
const res = ' '.repeat(i)
return res + '*'
}

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('_', ' ')}`)
output.push(`${pathPrefix(i)} **${newPart.replace('_', ' ')}**`)
}
}
}

return newPath
}

Expand All @@ -36,38 +32,23 @@ function pathsToMarkdown (filePaths) {
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)
}
let filename = path.basename(filepath)
filepath = path.dirname(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
}

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 = filename.split('.')[0]

// create URL to the actual file on github
const url = encodeURI([URL_BASE, filepath, filename].join('/'))
const name = path.basename(filename, ".js")
const url = path.join(filepath, filename)

output.push(`${prefix} [${name}](${url})`)
}
Expand All @@ -79,6 +60,7 @@ function pathsToMarkdown (filePaths) {
globby([
'**/*.js',
'!(node_modules|.github)/**/*',
"!**/test/**/*",
'!**/*.test.js',
'!**/*.manual-test.js',
'!babel.config.js'
Expand Down