toggle-corp/react-store

View on GitHub
docs/scripts/buildDocs.js

Summary

Maintainability
A
0 mins
Test Coverage
#!/usr/bin/env node

/**
 * This example script expects a JSON blob generated by react-docgen as input,
 * e.g. react-docgen components/* | buildDocs.sh
 */

const fs = require('fs');
const path = require('path');
const generateMarkdown = require('./generateMarkdown');

let json = '';
process.stdin.setEncoding('utf8');
process.stdin.on('readable', () => {
    const chunk = process.stdin.read();
    if (chunk !== null) {
        json += chunk;
    }
});

process.stdin.on('end', () => {
    buildDocs(JSON.parse(json));
});

export function buildDocs(api) {
    // api is an object keyed by filepath. We use the file name as component name.
    for (const filepath in api) {
        const name = getComponentName(filepath);
        const markdown = generateMarkdown(name, api[filepath]);
        fs.writeFileSync(`${name}.md`, markdown);
        process.stdout.write(`${filepath} -> ${name}.md\n`);
    }
}

function getComponentName(filepath) {
    let name = path.basename(filepath);
    // check for index.js
    if (name === 'index.js') {
        const dirs = path.dirname(filepath).split('/');
        name = dirs[dirs.length - 1];
    }
    let ext;
    while ((ext = path.extname(name))) {
        name = name.substring(0, name.length - ext.length);
    }
    return name;
}