Files
xen-orchestra/scripts/usage-to-readme.js
Julien Fontanet 7864c05ee1 fix: race condition between normalize-packages and usage-to-readme
The first was writting `package.json` at the same time the second one was reading it.

The file is now read only once by `normalize-packages`.
2024-01-31 16:22:07 +01:00

49 lines
1.3 KiB
JavaScript
Executable File

#!/usr/bin/env node
'use strict'
const { compile } = require('handlebars')
const { dirname, join } = require('node:path')
const { readFile, writeFile } = require('node:fs/promises')
const { execFile } = require('node:child_process')
const generateReadme = readFile(join(__dirname, 'README.md.tpl'), 'utf8').then(compile)
async function usageToReadme(usagePath, pkgDir, pkg, gitAdd = false) {
const usage = await readFile(usagePath, 'utf8')
const readmePath = join(pkgDir, 'README.md')
await writeFile(readmePath, (await generateReadme)({ pkg, usage: usage.trim() }))
if (gitAdd) {
await new Promise((resolve, reject) => {
execFile('git', ['add', '--', readmePath])
.on('error', reject)
.on('exit', code => {
if (code !== 0) {
reject(new Error('command exited with non-zero status code: ' + code))
} else {
resolve()
}
})
})
}
}
module.exports = usageToReadme
if (module.parent === null) {
async function main(...args) {
const gitAdd = args[0] === '--git-add'
if (gitAdd) {
args.shift()
}
for (const usagePath of args) {
const dir = dirname(usagePath)
await usageToReadme(usagePath, dir, await readFile(join(dir, 'package.json')).then(JSON.parse), gitAdd)
}
}
main(...process.argv.slice(2))
}