ec0lint-plugin-react/markdown.config.js

React specific linting rules for ec0lint

'use strict';

/* eslint-disable no-restricted-syntax */

const { rules } = require('./index');

const ruleTableRows = Object.keys(rules)
  .sort()
  .map((id) => {
    const { meta } = rules[id];
    const { fixable, docs } = meta;
    return [
      docs.recommended ? '✔' : '',
      fixable ? '🔧' : '',
      `[react/${id}](docs/rules/${id}.md)`,
      docs.description,
    ].join(' | ');
  });

const buildRulesTable = (rows) => {
  const header = '✔ | 🔧 | Rule | Description';
  const separator = ':---: | :---: | :--- | :---';

  return [header, separator, ...rows]
    .map((row) => `| ${row} |`)
    .join('\n');
};

const BASIC_RULES = () => buildRulesTable(ruleTableRows.filter((rule) => !rule.includes('react/jsx-')));
const JSX_RULES = () => buildRulesTable(ruleTableRows.filter((rule) => rule.includes('react/jsx-')));

module.exports = {
  transforms: {
    BASIC_RULES,
    JSX_RULES,
  },
  callback: () => {
    console.log('The auto-generating of rules finished!');
  },
};