Function packageJSONtoMd

src/docgen.ts:72–154

(path: string, outPath: string)

}

export function packageJSONtoMd(path: string, outPath: string) {
    let obj: any;
    try {
        const txt = fs.readFileSync(path);
        obj = JSON.parse(txt.toString());
    }
    catch (e) {
        console.error(`Error: Could not open/read file ${path}`, e);
        return 1;
    }
    const dbgSections = obj?.contributes?.debuggers;
    if (!dbgSections) {
        console.error(`No "debuggers" found in file ${path}`);
        return 1;
    }
    for (const dbgSection of dbgSections) {
        const attrs = dbgSection.configurationAttributes;
        const attach = attrs?.attach?.properties;
        const launch = attrs?.launch?.properties;
        if (!attach) {
            console.error('"attach" properties not found');
            return 1;
        }
        if (!launch) {
            console.error('"launch" properties not found');
            return 1;
        }
        let attachProps = Object.keys(attach);
        let launchProps = Object.keys(launch);
        const common = {};
        for (const prop of launchProps) {
            if (attach[prop]?.deprecated || launch[prop]?.deprecated) {
                delete launch[prop];
                delete attach[prop];
                continue;
            }
            if (attachProps.findIndex((str) => str === prop) !== -1) {
                common[prop] = launch[prop];
                if (launch[prop].description !== attach[prop].description) {
                    console.warn(`Warning: Description does not match for property ${prop} between attach and launch`);
                }
                delete launch[prop];
                delete attach[prop];
            }
        }
        attachProps = Object.keys(attach).sort();
        launchProps = Object.keys(launch).sort();
        const commonProps = Object.keys(common).sort();
        const allProps = attachProps.concat(launchProps).concat(commonProps).sort();
        // console.log('launch', launchProps);
        // console.log('attach', attachProps);
        // console.log('common', commonProps);
        try {
            const stream = fs.createWriteStream(outPath);
            writeHeader(stream);
            stream.write('| Attribute | Type | Launch/ Attach | Description |\n');
            stream.write('| --------- | ---- | ---------------- | ----------- |\n');
            for (const prop of allProps) {