ant-design/scripts/sort-api-table.js

const program = require('commander');
const majo = require('majo');
const style = require('ansi-styles');

const unified = require('unified');
const parse = require('remark-parse');
const stringify = require('remark-stringify');

const yamlConfig = require('remark-yaml-config');
const frontmatter = require('remark-frontmatter');

const remarkWithYaml = unified()
  .use(parse)
  .use(stringify, {
    paddedTable: false,
    listItemIndent: 1,
  })
  .use(frontmatter)
  .use(yamlConfig);

const stream = majo();

function getCellValue(node) {
  return node.children[0].children[0].value;
}

function innerSort(nodes) {
  return nodes.sort((prev, next) => {
    // use toLowerCase to keep `case insensitive`
    prev = getCellValue(prev).toLowerCase();
    next = getCellValue(next).toLowerCase();

    // follow the alphabet order
    if (prev > next) {
      return 1;
    }

    if (prev < next) {
      return -1;
    }

    return 0;
  });
}

function sort(ast) {
  ast.children.forEach((child) => {
    const staticProp = [];
    // prefix with `on`
    const dynamicProp = [];

    // find table markdown type
    if (child.type === 'table') {
      // slice will create new array, so sort can affect the original array.
      // slice(1) cut down the thead
      child.children.slice(1).forEach((node) => {
        const value = getCellValue(node);
        if (/^on[A-Z]/.test(value)) {
          dynamicProp.push(node);
        } else {
          staticProp.push(node);
        }
      });

      child.children = [
        child.children[0],
        ...innerSort(staticProp),
        ...innerSort(dynamicProp),
      ];
    }
  });

  return ast;
}

function sortAPI(md) {
  return remarkWithYaml.stringify(sort(remarkWithYaml.parse(md)));
}

program
  .version('0.1.0')
  .option(
    '-f, --file [file]',
    'Specify which file to be transformed',
    // default value
    'components/**/index.+(zh-CN|en-US).md'
  )
  .parse(process.argv);

function sortMiddleware(ctx) {
  Object.keys(ctx.files).forEach((filename) => {
    const content = ctx.fileContents(filename);
    ctx.writeContents(filename, sortAPI(content));
  });
}

// Get the markdown file all need to be transformed
stream
  .source(program.file)
  .use(sortMiddleware)
  .dest('.')
  .then(() => {
    /* eslint-disable no-console */
    console.log(
      `${style.green.open}sort ant-design api successfully!${style.green.close}`
    );
    /* eslint-enable no-console */
  });