eslint-config-chain-able/node_modules/eslint-plugin-jsdoc/bin/readme-assertions.js

an opinionated ESLint configuration

/**
 * This script is used to inline assertions into the README.md documents.
 */
import _ from 'lodash';
import glob from 'glob';
import path from 'path';
import fs from 'fs';

const formatCodeSnippet = (setup) => {
    const paragraphs = [];

    paragraphs.push(trimCode(setup.code));

    if (setup.options) {
        paragraphs.push('// Options: ' + JSON.stringify(setup.options));
    }

    if (setup.errors) {
        paragraphs.push('// Message: ' + setup.errors[0].message);
    }

    return paragraphs.join('\n');
};

const getAssertions = () => {
    const assertionFiles = glob.sync(path.resolve(__dirname, '../test/rules/assertions/*.js'));

    const assertionNames = _.map(assertionFiles, (filePath) => {
        return path.basename(filePath, '.js');
    });

    const assertionCodes = _.map(assertionFiles, (filePath) => {
        let codes;

        codes = require(filePath).default;

        return {
            valid: _.map(codes.valid, formatCodeSnippet),
            invalid: _.map(codes.invalid, formatCodeSnippet)
        };
    });

    return _.zipObject(assertionNames, assertionCodes);
};

const trimCode = (code) => {
    let lines = _.trim(code).split('\n');

    const indendation = lines[lines.length - 1].match(/^\s+/);

    const indentSize = indendation ? indendation[0].length : 0;

    lines = _.map(lines, (line, i) => {
        if (i === 0) {
            return line;
        }

        return line.slice(indentSize);
    });

    return lines.join('\n');
};

const updateDocuments = (assertions) => {
    const readmeDocumentPath = path.join(__dirname, '../README.md');

    let documentBody = fs.readFileSync(readmeDocumentPath, 'utf8');

    documentBody = documentBody.replace(/<!-- assertions ([a-z]+?) -->/ig, (assertionsBlock) => {
        let ruleName,
            ruleAssertions;

        ruleName = assertionsBlock.match(/assertions ([a-z]+)/i)[1];

        ruleAssertions = assertions[ruleName];

        if (!ruleAssertions) {
            throw new Error('No assertions available for rule "' + ruleName + '".');

            return assertionsBlock;
        }

        return 'The following patterns are considered problems:\n\n```js\n' + ruleAssertions.invalid.join('\n\n') + '\n```\n\nThe following patterns are not considered problems:\n\n```js\n' + ruleAssertions.valid.join('\n\n') + '\n```\n';
    });

    fs.writeFileSync(readmeDocumentPath, documentBody);
};

updateDocuments(getAssertions());