feat: support output report only

lib/sortApiTable.js

@@ -25,6 +25,10 @@ const remarkWithYaml = unified()
 
 const stream = majo();
 
+function get(obj, pathStr = '', defaultValue) {
+  return pathStr.split('.').reduce((acc, key) => acc && acc[key], obj) || defaultValue;
+}
+
 function getCellValue(node) {
   let cloneNode = { ...node };
 
@@ -150,7 +154,15 @@ function sortAPI(md, filename) {
 function sortMiddleware(ctx) {
   Object.keys(ctx.files).forEach(filename => {
     const content = ctx.fileContents(filename);
-    ctx.writeContents(filename, sortAPI(content, filename));
+
+    const sortedContent = sortAPI(content, filename);
+
+    if (get(ctx.meta, 'program.report', false)) {
+      console.log(chalk.cyan(`🔍 report ${filename}`));
+    } else {
+      // write the sorted content back to the file
+      ctx.writeContents(filename, sortedContent);
+    }
   });
 }
 
@@ -166,12 +178,21 @@ module.exports = () => {
       'components/**/index.+(zh-CN|en-US).md'
     )
     .option('-o, --output [output]', 'Specify component api output path', '~component-api.json')
+    .option('-r, --report', 'Only output the report, will not modify the file', false)
     .parse(process.argv);
   // Get the markdown file all need to be transformed
 
+  // inject context to the majo stream
+  function injectContext(ctx) {
+    if (typeof ctx.meta !== 'object') ctx.meta = {};
+
+    Object.assign(ctx.meta, { program });
+  }
+
   /* eslint-disable no-console */
   stream
     .source(program.file)
+    .use(injectContext)
     .use(sortMiddleware)
     .dest('.')
     .then(() => {