[core] Replace commander with yargs (#872)

mui · Jan 18, 2021 · fb86cad · fb86cad
1 parent 682c544
commit fb86cad
Show file tree

Hide file tree

Showing 7 changed files with 105 additions and 54 deletions.
diff --git a/packages/x-grid-data-generator/bin/data-gen-script.js b/packages/x-grid-data-generator/bin/data-gen-script.js
@@ -4,4 +4,4 @@
 require = require('esm')(module);
 
 // eslint-disable-next-line import/no-unresolved
-require('../dist/index-cjs').datagenCli(process.argv);
+require('../dist/index-cjs').datagenCli();
diff --git a/packages/x-grid-data-generator/package.json b/packages/x-grid-data-generator/package.json
@@ -26,10 +26,12 @@
     "@types/chance": "^1.1.0",
     "chance": "^1.1.6",
     "clsx": "^1.0.4",
-    "commander": "^6.1.0",
-    "esm": "^3.2.25",
     "lru-cache": "^6.0.0"
   },
+  "devDependencies": {
+    "esm": "^3.2.25",
+    "yargs": "^15.0.0"
+  },
   "peerDependencies": {
     "@material-ui/core": "^4.9.12",
     "@material-ui/icons": "^4.9.1",

diff --git a/packages/x-grid-data-generator/src/datagen-cli.ts b/packages/x-grid-data-generator/src/datagen-cli.ts
@@ -1,6 +1,6 @@
 /* eslint-disable no-console */
 import * as fs from 'fs';
-import * as program from 'commander';
+import * as yargs from 'yargs';
 import { getCommodityColumns } from './commodities.columns';
 import { getEmployeeColumns } from './employees.columns';
 import { getRealData } from './services';
@@ -14,28 +14,54 @@ const loadData = async (size: number, dataset: string): Promise<any> => {
   return result.rows;
 };
 
-export function datagenCli(args) {
-  program
-    .option('-d, --dataset <dataset>', 'A dataset can be "commodity" | "employee"', 'employee')
-    .option('-s, --size <size>', 'The number of rows to generate', '100')
-    .option(
-      '-o, --output <output>',
-      'The output file, if not passed, it will generate "./<dataset>-<size>.json"',
-    )
-    .option('-p, --pretty', 'print a prettier output', false)
-    .action(() => {
-      console.log(
-        `Generating new ${program.dataset} dataset with ${Number(
-          program.size,
-        ).toLocaleString()} rows`,
-      );
-      loadData(Number(program.size), program.dataset).then((data) => {
-        const output = !program.output
-          ? `./${program.dataset}-${program.size}.json`
-          : program.output;
-        console.log(`Saving generated dataset in ${output}`);
-        fs.writeFileSync(output, JSON.stringify(data, null, program.pretty ? 2 : undefined));
-      });
+interface HandlerArgv {
+  dataset: string;
+  output: string;
+  pretty: boolean;
+  size: string;
+}
+
+export function datagenCli() {
+  yargs
+    .command({
+      command: '$0',
+      describe: 'Generates Component.propTypes from TypeScript declarations',
+      builder: (command) => {
+        return command
+          .option('dataset', {
+            default: '',
+            describe: 'A dataset can be "commodity" | "employee"',
+            type: 'string',
+          })
+          .option('output', {
+            default: '',
+            describe: 'The output file, if not passed, it will generate "./<dataset>-<size>.json"',
+            type: 'string',
+          })
+          .option('pretty', {
+            default: false,
+            describe: 'Print a prettier output',
+            type: 'boolean',
+          })
+          .option('size', {
+            default: '1000',
+            describe: 'The number of rows to generate',
+            type: 'string',
+          });
+      },
+      handler: (argv: HandlerArgv) => {
+        console.log(
+          `Generating new ${argv.dataset} dataset with ${Number(argv.size).toLocaleString()} rows`,
+        );
+        loadData(Number(argv.size), argv.dataset).then((data) => {
+          const output = !argv.output ? `./${argv.dataset}-${argv.size}.json` : argv.output;
+          console.log(`Saving generated dataset in ${output}`);
+          fs.writeFileSync(output, JSON.stringify(data, null, argv.pretty ? 2 : undefined));
+        });
+      },
     })
-    .parse(args);
+    .help()
+    .strict(true)
+    .version(false)
+    .parse();
 }
diff --git a/packages/x-license/bin/license-gen-script.js b/packages/x-license/bin/license-gen-script.js
@@ -2,4 +2,4 @@
 /* eslint-disable */
 require = require('esm')(module);
 
-require('../dist/cjs/license-cli').licenseGenCli(process.argv);
+require('../dist/cjs/license-cli').licenseGenCli();
diff --git a/packages/x-license/package.json b/packages/x-license/package.json
@@ -25,11 +25,11 @@
     "licensegen": "./bin/license-gen-script.js"
   },
   "dependencies": {
-    "commander": "^6.1.0",
+    "yargs": "^15.0.0",
     "esm": "^3.2.25"
   },
   "peerDependencies": {
-    "react": "^16.13.1 || ^17.0.0"
+    "react": "^16.8.0 || ^17.0.0"
   },
   "setupFiles": [
     "<rootDir>/src/setupTests.js"

diff --git a/packages/x-license/src/license-cli.ts b/packages/x-license/src/license-cli.ts
@@ -1,32 +1,55 @@
 /* eslint-disable no-console */
-import * as program from 'commander';
+import * as yargs from 'yargs';
 import { generateLicence } from './generateLicense';
 
 const oneDayInMs = 1000 * 60 * 60 * 24;
 
-export function licenseGenCli(args: any) {
-  program
-    .option('-o, --order <order>', 'Order number id')
-    .option('-e, --expiry <expiry>', 'Number of days from now until expiry date', '366')
-    .action(() => {
-      if (!program.order) {
-        throw new Error(
-          'Material-UI: You forgot to pass an order number. $ > licensegen -o order_123.',
-        );
-      }
+interface HandlerArgv {
+  order: string;
+  expiry: string;
+}
 
-      const licenseDetails = {
-        expiryDate: new Date(new Date().getTime() + parseInt(program.expiry, 10) * oneDayInMs),
-        orderNumber: program.order,
-      };
+export function licenseGenCli() {
+  yargs
+    .command({
+      command: '$0',
+      describe: 'Generates Component.propTypes from TypeScript declarations',
+      builder: (command) => {
+        return command
+          .option('order', {
+            default: '',
+            describe: 'Order number id.',
+            type: 'string',
+          })
+          .option('expiry', {
+            default: '366',
+            describe: 'Number of days from now until expiry date.',
+            type: 'string',
+          });
+      },
+      handler: (argv: HandlerArgv) => {
+        if (!argv.order) {
+          throw new Error(
+            'Material-UI: You forgot to pass an order number. $ > licensegen -o order_123.',
+          );
+        }
 
-      console.log(
-        `Generating new license number for order ${
-          licenseDetails.orderNumber
-        } with expiry date ${licenseDetails.expiryDate.toLocaleDateString()}`,
-      );
-      const license = generateLicence(licenseDetails);
-      console.log(`New license: \n${license}`);
+        const licenseDetails = {
+          expiryDate: new Date(new Date().getTime() + parseInt(argv.expiry, 10) * oneDayInMs),
+          orderNumber: argv.order,
+        };
+
+        console.log(
+          `Generating new license number for order ${
+            licenseDetails.orderNumber
+          } with expiry date ${licenseDetails.expiryDate.toLocaleDateString()}`,
+        );
+        const license = generateLicence(licenseDetails);
+        console.log(`New license: \n${license}`);
+      },
     })
-    .parse(args);
+    .help()
+    .strict(true)
+    .version(false)
+    .parse();
 }
diff --git a/yarn.lock b/yarn.lock
@@ -20606,7 +20606,7 @@ yargs@^14.2.2:
     y18n "^4.0.0"
     yargs-parser "^15.0.1"
 
-yargs@^15.0.2, yargs@^15.3.1, yargs@^15.4.1:
+yargs@^15.0.0, yargs@^15.0.2, yargs@^15.3.1, yargs@^15.4.1:
   version "15.4.1"
   resolved "https://registry.yarnpkg.com/yargs/-/yargs-15.4.1.tgz#0d87a16de01aee9d8bec2bfbf74f67851730f4f8"
   integrity sha512-aePbxDmcYW++PaqBsJ+HYUFwCdv4LVvdnhBy78E57PIor8/OVvhMrADFFEDh8DHDFRv/O9i3lPhsENjO7QX0+A==