mirror of
https://github.com/gamedig/node-gamedig.git
synced 2024-11-16 00:38:31 +01:00
ce4cddb87f
* feat: remove games.txt and replace it with an in-code solution * docs: update changelog * chore: add todo comment regarding weird game ids to rename * fix: generate games list md file * fix: gemerate games list file to alphabetical id order * fix: update changelog to note removal of some game ids and add geneshift alternative
48 lines
1.4 KiB
JavaScript
48 lines
1.4 KiB
JavaScript
#!/usr/bin/env node
|
|
|
|
import * as fs from 'node:fs'
|
|
import { games } from '../lib/games.js'
|
|
import { fileURLToPath } from 'node:url'
|
|
import { dirname } from 'node:path'
|
|
|
|
const __filename = fileURLToPath(import.meta.url)
|
|
const __dirname = dirname(__filename)
|
|
|
|
const readmeFilename = __dirname + '/../GAMES_LIST.md'
|
|
const readme = fs.readFileSync(readmeFilename, { encoding: 'utf8' })
|
|
|
|
const markerTop = '<!--- BEGIN GENERATED GAMES -->'
|
|
const markerBottom = '<!--- END GENERATED GAMES -->'
|
|
|
|
const sortedGamesIds = Object.keys(games).sort()
|
|
const sortedGames = {}
|
|
sortedGamesIds.forEach(key => {
|
|
sortedGames[key] = games[key]
|
|
})
|
|
|
|
let generated = ''
|
|
generated += '| GameDig Type ID | Name | See Also\n'
|
|
generated += '|---|---|---\n'
|
|
|
|
for (const id in sortedGames) {
|
|
const game = sortedGames[id]
|
|
generated += '| ' + id.padEnd(10, ' ') + ' | ' + game.name
|
|
const notes = []
|
|
if (game?.extra?.doc_notes) {
|
|
notes.push('[Notes](#' + game.extra.doc_notes + ')')
|
|
}
|
|
if (game.options.protocol === 'valve') {
|
|
notes.push('[Valve Protocol](#valve)')
|
|
}
|
|
if (notes.length) {
|
|
generated += ' | ' + notes.join(', ')
|
|
}
|
|
generated += '\n'
|
|
}
|
|
|
|
let start = readme.indexOf(markerTop)
|
|
start += markerTop.length
|
|
const end = readme.indexOf(markerBottom)
|
|
|
|
const updated = readme.substring(0, start) + '\n\n' + generated + '\n' + readme.substring(end)
|
|
fs.writeFileSync(readmeFilename, updated)
|