added more data to readme generation

This commit is contained in:
2022-08-24 11:57:11 -05:00
parent 7e24370186
commit c9183d3022
7 changed files with 21 additions and 13 deletions

View File

@@ -5,14 +5,14 @@ import readMeta from './readmeta'
import { format, resolveConfig } from 'prettier'
import { AllPaths, CLIArgs } from './main'
export default interface runBuild {
export interface runBuildResult {
meta: UserScriptMetaFull
error: string | null
}
export default function runBuild(
name: string,
watchCallback: (result: runBuild) => void
watchCallback: (result: runBuildResult) => void
) {
//read meta file
let { meta, metaString } = readMeta(name)

View File

@@ -1,7 +1,7 @@
import { existsSync, lstatSync, readdirSync, unlinkSync } from 'fs'
import commandLineArgs from 'command-line-args'
import { updateReadmeFile } from './readmefile'
import runBuild from './build'
import runBuild, { runBuildResult } from './build'
import * as Path from 'path'
import getAllPaths from './paths'
@@ -86,7 +86,7 @@ readdirSync(AllPaths.base.dist).forEach(file =>
//compile scripts
let scripts = readdirSync(AllPaths.base.script)
let scriptMeta: runBuild[] = []
let scriptMeta: runBuildResult[] = []
for (let name of scripts) {
let path = AllPaths.script(name)
@@ -100,7 +100,7 @@ for (let name of scripts) {
) {
let id = scriptMeta.length
function update(result: runBuild) {
function update(result: runBuildResult) {
console.log('WATCH', name, result.meta.version)
scriptMeta[id] = result
updateReadmeFile(scriptMeta)

View File

@@ -1,7 +1,7 @@
import { readdirSync, readFileSync, writeFileSync } from 'fs'
import runBuild from './build'
import { runBuildResult } from './build'
export function updateReadmeFile(fileList: runBuild[]) {
export function updateReadmeFile(fileList: runBuildResult[]) {
let readmeFile = getReadmeFileName()
if (readmeFile !== null) {
let [readmeStart, readmeEnd] = readReadmeFile(readmeFile)
@@ -28,11 +28,15 @@ function readmeDataErrorString(error: string | null): string {
return `\n\n${error}`
}
function readmeDataToString(results: runBuild): string {
function readmeDataToString(results: runBuildResult): string {
let { meta, error } = results
let errStr = error !== null ? '~~' : ''
let errMsg = readmeDataErrorString(error)
return `- ${errStr}[${meta.name}](${meta.downloadURL})${errStr}${errMsg}`
return `
- ${errStr}[${meta.name}](${meta.downloadURL})${errStr}${errMsg}
- ${meta.namespace} ${meta.version}
- ${meta.description}
`.trim()
}
function getReadmeFileName(): string | null {