From 740062db7c79f39f319d2a4b92d6537991778e60 Mon Sep 17 00:00:00 2001 From: Travis Fischer Date: Sat, 23 Jun 2018 19:50:16 -0400 Subject: [PATCH] better CLI usage --- .../create-freesewing-pattern/index.test.js | 10 +++ ...aults.js => get-default-library-params.js} | 9 +- .../create-freesewing-pattern/lib/index.js | 77 +++++++++++------ .../lib/prompt-library-info.js | 56 ------------ .../lib/prompt-library-params.js | 76 ++++++++++++++++ .../create-freesewing-pattern/package.json | 2 +- packages/create-freesewing-pattern/yarn.lock | 86 ++----------------- 7 files changed, 151 insertions(+), 165 deletions(-) create mode 100644 packages/create-freesewing-pattern/index.test.js rename packages/create-freesewing-pattern/lib/{get-library-defaults.js => get-default-library-params.js} (82%) delete mode 100644 packages/create-freesewing-pattern/lib/prompt-library-info.js create mode 100644 packages/create-freesewing-pattern/lib/prompt-library-params.js diff --git a/packages/create-freesewing-pattern/index.test.js b/packages/create-freesewing-pattern/index.test.js new file mode 100644 index 00000000000..b6db926d8cd --- /dev/null +++ b/packages/create-freesewing-pattern/index.test.js @@ -0,0 +1,10 @@ +'use strict' + +const { test } = require('ava') +const execa = require('execa') + +test('--help', async (t) => { + const { stdout } = await execa('./index.js', [ '--help' ]) + t.true(stdout.length > 0) + t.true(/create-react-library/.test(stdout)) +}) diff --git a/packages/create-freesewing-pattern/lib/get-library-defaults.js b/packages/create-freesewing-pattern/lib/get-default-library-params.js similarity index 82% rename from packages/create-freesewing-pattern/lib/get-library-defaults.js rename to packages/create-freesewing-pattern/lib/get-default-library-params.js index 8141cd313f4..669694e8f1c 100644 --- a/packages/create-freesewing-pattern/lib/get-library-defaults.js +++ b/packages/create-freesewing-pattern/lib/get-default-library-params.js @@ -9,9 +9,12 @@ const config = require('./config') module.exports = async () => { const defaults = { + name: '', + description: '', author: config.get('author'), - manager: config.get('manager', 'npm'), - license: config.get('license', 'MIT') + repo: (info) => `${info.author}/${info.name}`, + license: config.get('license', 'MIT'), + manager: config.get('manager', 'npm') } try { @@ -38,7 +41,7 @@ module.exports = async () => { defaults.manager = 'yarn' } - config.set('manager', defaults.manager) + config.set('manager', defaults.manager || 'npm') } } catch (err) { } diff --git a/packages/create-freesewing-pattern/lib/index.js b/packages/create-freesewing-pattern/lib/index.js index b847e422d40..e28a94cb00a 100644 --- a/packages/create-freesewing-pattern/lib/index.js +++ b/packages/create-freesewing-pattern/lib/index.js @@ -1,47 +1,76 @@ #!/usr/bin/env node 'use strict' -const meow = require('meow') +const program = require('commander') +const { version } = require('../package') -const getLibraryDefaults = require('./get-library-defaults') +const getDefaultLibraryParams = require('./get-default-library-params') const createLibrary = require('./create-library') -const promptLibraryInfo = require('./prompt-library-info') +const promptLibraryParams = require('./prompt-library-params') module.exports = async () => { - const defaults = await getLibraryDefaults() - const info = await promptLibraryInfo(defaults) - await createLibrary(info) + const defaults = await getDefaultLibraryParams() - return info -} + program + .name('create-react-library') + .version(version) + .usage('[options] [package-name]') + .option('-d, --desc ', 'package description') + .option('-a, --author ', 'author\'s github handle', defaults.author) + .option('-l, --license ', 'package license', defaults.license) + .option('-r, --repo ', 'package repo path') + .option('-m, --manager ', 'package manager to use', /^(npm|yarn)$/, defaults.manager) + .option('-s, --skip-prompts', 'skip all prompts (must provide package-name via cli)') + .parse(process.argv) -meow(` - Usage - $ create-react-library -`) + const opts = { + description: program.desc, + author: program.author, + license: program.license, + repo: program.repo, + manager: program.manager, + skipPrompts: program.skipPrompts + } -module.exports() - .then((info) => { - console.log(` + Object.keys(opts).forEach((key) => { + if (!opts[key] && defaults[key]) { + opts[key] = defaults[key] + } + }) -Your module has been created at ${info.dest}. + if (program.args.length === 1) { + opts.name = program.args[0] + } else if (program.args.length > 1) { + console.error('invalid arguments') + program.help() + process.exit(1) + } + + const params = await promptLibraryParams(opts) + const lib = await createLibrary(params) + + console.log(` + +Your module has been created at ${lib.dest}. To get started, in one tab, run: -$ cd ${info.name} && ${info.manager} start +$ cd ${lib.name} && ${lib.manager} start And in another tab, run the create-react-app devserver: -$ cd ${info.name}/example && ${info.manager} start +$ cd ${lib.name}/example && ${lib.manager} start `) - if (info.manager === 'npm') { - console.log(` + if (lib.manager === 'npm') { + console.log(` -Because you're using npm, you'll need to publish a dummy version of ${info.name} first before you can "npm link" your package into the example app. +Because you're using npm, you'll need to publish a dummy version of ${lib.name} first before you can "npm link" your package into the example app. `) - } + } - process.exit(0) - }) + return lib +} + +module.exports() .catch((err) => { console.error(err) process.exit(1) diff --git a/packages/create-freesewing-pattern/lib/prompt-library-info.js b/packages/create-freesewing-pattern/lib/prompt-library-info.js deleted file mode 100644 index da5d5dab54b..00000000000 --- a/packages/create-freesewing-pattern/lib/prompt-library-info.js +++ /dev/null @@ -1,56 +0,0 @@ -'use strict' - -const inquirer = require('inquirer') -const validateNpmName = require('validate-npm-package-name') - -const config = require('./config') - -module.exports = async (defaults) => { - const info = await inquirer.prompt([ - { - type: 'input', - name: 'name', - message: 'Package Name', - validate: (name) => { - return name && validateNpmName(name).validForNewPackages - } - }, - { - type: 'input', - name: 'description', - message: 'Package Description', - default: '' - }, - { - type: 'input', - name: 'author', - message: 'Author\'s GitHub Handle', - default: defaults.author - }, - { - type: 'input', - name: 'repo', - message: 'GitHub Repo Path', - default: (info) => `${info.author}/${info.name}` - }, - { - type: 'input', - name: 'license', - message: 'License', - default: defaults.license - }, - { - type: 'list', - name: 'manager', - message: 'Package Manager', - choices: [ 'npm', 'yarn' ], - default: defaults.manager - } - ]) - - config.set('author', info.author) - config.set('manager', info.manager) - config.set('license', info.license) - - return info -} diff --git a/packages/create-freesewing-pattern/lib/prompt-library-params.js b/packages/create-freesewing-pattern/lib/prompt-library-params.js new file mode 100644 index 00000000000..1a031a03957 --- /dev/null +++ b/packages/create-freesewing-pattern/lib/prompt-library-params.js @@ -0,0 +1,76 @@ +'use strict' + +const inquirer = require('inquirer') +const validateNpmName = require('validate-npm-package-name') + +const config = require('./config') + +module.exports = async (opts) => { + if (opts.name && !validateNpmName(opts.name).validForNewPackages) { + throw new Error(`invalid package name "${opts.name}"`) + } + + if (opts.skipPrompts) { + if (!opts.name) { + throw new Error('invalid input; you must pass a package name with --skip-prompts') + } + + Object.keys(opts).forEach((key) => { + const value = opts[key] + if (typeof value === 'function') { + opts[key] = value(opts) + } + }) + + return opts + } else { + const info = await inquirer.prompt([ + { + type: 'input', + name: 'name', + message: 'Package Name', + validate: (name) => { + return name && validateNpmName(name).validForNewPackages + }, + default: opts.name + }, + { + type: 'input', + name: 'description', + message: 'Package Description', + default: opts.description + }, + { + type: 'input', + name: 'author', + message: 'Author\'s GitHub Handle', + default: opts.author + }, + { + type: 'input', + name: 'repo', + message: 'GitHub Repo Path', + default: opts.repo + }, + { + type: 'input', + name: 'license', + message: 'License', + default: opts.license + }, + { + type: 'list', + name: 'manager', + message: 'Package Manager', + choices: [ 'npm', 'yarn' ], + default: opts.manager + } + ]) + + config.set('author', info.author) + config.set('license', info.license) + config.set('manager', info.manager) + + return info + } +} diff --git a/packages/create-freesewing-pattern/package.json b/packages/create-freesewing-pattern/package.json index c4e9b7ac8cb..fade817d946 100644 --- a/packages/create-freesewing-pattern/package.json +++ b/packages/create-freesewing-pattern/package.json @@ -28,6 +28,7 @@ "publish" ], "dependencies": { + "commander": "^2.15.1", "conf": "^1.4.0", "cp-file": "^5.0.0", "execa": "^0.10.0", @@ -37,7 +38,6 @@ "handlebars": "^4.0.11", "inquirer": "^5.2.0", "make-dir": "^1.2.0", - "meow": "^5.0.0", "node-compat-require": "^1.0.3", "ora": "^2.1.0", "p-each-series": "^1.0.0", diff --git a/packages/create-freesewing-pattern/yarn.lock b/packages/create-freesewing-pattern/yarn.lock index 1eafed799e9..d13d28905b6 100644 --- a/packages/create-freesewing-pattern/yarn.lock +++ b/packages/create-freesewing-pattern/yarn.lock @@ -969,14 +969,6 @@ camelcase-keys@^2.0.0: camelcase "^2.0.0" map-obj "^1.0.0" -camelcase-keys@^4.0.0: - version "4.2.0" - resolved "https://registry.yarnpkg.com/camelcase-keys/-/camelcase-keys-4.2.0.tgz#a2aa5fb1af688758259c32c141426d78923b9b77" - dependencies: - camelcase "^4.1.0" - map-obj "^2.0.0" - quick-lru "^1.0.0" - camelcase@^1.0.2: version "1.2.1" resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-1.2.1.tgz#9bb5304d2e0b56698b2c758b08a3eaa9daa58a39" @@ -1180,6 +1172,10 @@ combined-stream@1.0.6, combined-stream@^1.0.5, combined-stream@~1.0.5: dependencies: delayed-stream "~1.0.0" +commander@^2.15.1: + version "2.15.1" + resolved "https://registry.yarnpkg.com/commander/-/commander-2.15.1.tgz#df46e867d0fc2aec66a34662b406a9ccafff5b0f" + common-path-prefix@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/common-path-prefix/-/common-path-prefix-1.0.0.tgz#cd52f6f0712e0baab97d6f9732874f22f47752c0" @@ -1403,14 +1399,7 @@ debuglog@^1.0.1: version "1.0.1" resolved "https://registry.yarnpkg.com/debuglog/-/debuglog-1.0.1.tgz#aa24ffb9ac3df9a2351837cfb2d279360cd78492" -decamelize-keys@^1.0.0: - version "1.1.0" - resolved "https://registry.yarnpkg.com/decamelize-keys/-/decamelize-keys-1.1.0.tgz#d171a87933252807eb3cb61dc1c1445d078df2d9" - dependencies: - decamelize "^1.1.0" - map-obj "^1.0.0" - -decamelize@^1.0.0, decamelize@^1.1.0, decamelize@^1.1.1, decamelize@^1.1.2: +decamelize@^1.0.0, decamelize@^1.1.1, decamelize@^1.1.2: version "1.2.0" resolved "https://registry.yarnpkg.com/decamelize/-/decamelize-1.2.0.tgz#f6534d15148269b20352e7bee26f501f9a191290" @@ -3355,10 +3344,6 @@ map-obj@^1.0.0, map-obj@^1.0.1: version "1.0.1" resolved "https://registry.yarnpkg.com/map-obj/-/map-obj-1.0.1.tgz#d933ceb9205d82bdcf4886f6742bdc2b4dea146d" -map-obj@^2.0.0: - version "2.0.0" - resolved "https://registry.yarnpkg.com/map-obj/-/map-obj-2.0.0.tgz#a65cd29087a92598b8791257a523e021222ac1f9" - map-visit@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/map-visit/-/map-visit-1.0.0.tgz#ecdca8f13144e660f1b5bd41f12f3479d98dfb8f" @@ -3408,20 +3393,6 @@ meow@^3.7.0: redent "^1.0.0" trim-newlines "^1.0.0" -meow@^5.0.0: - version "5.0.0" - resolved "https://registry.yarnpkg.com/meow/-/meow-5.0.0.tgz#dfc73d63a9afc714a5e371760eb5c88b91078aa4" - dependencies: - camelcase-keys "^4.0.0" - decamelize-keys "^1.0.0" - loud-rejection "^1.0.0" - minimist-options "^3.0.1" - normalize-package-data "^2.3.4" - read-pkg-up "^3.0.0" - redent "^2.0.0" - trim-newlines "^2.0.0" - yargs-parser "^10.0.0" - merge2@^1.2.1: version "1.2.1" resolved "https://registry.yarnpkg.com/merge2/-/merge2-1.2.1.tgz#271d2516ff52d4af7f7b710b8bf3e16e183fef66" @@ -3486,13 +3457,6 @@ minimatch@^3.0.0, minimatch@^3.0.2, minimatch@^3.0.3, minimatch@^3.0.4: dependencies: brace-expansion "^1.1.7" -minimist-options@^3.0.1: - version "3.0.2" - resolved "https://registry.yarnpkg.com/minimist-options/-/minimist-options-3.0.2.tgz#fba4c8191339e13ecf4d61beb03f070103f3d954" - dependencies: - arrify "^1.0.1" - is-plain-obj "^1.1.0" - minimist@0.0.8: version "0.0.8" resolved "https://registry.yarnpkg.com/minimist/-/minimist-0.0.8.tgz#857fcabfc3397d2625b8228262e86aa7a011b05d" @@ -4389,10 +4353,6 @@ qs@~6.5.1: version "6.5.2" resolved "https://registry.yarnpkg.com/qs/-/qs-6.5.2.tgz#cb3ae806e8740444584ef154ce8ee98d403f3e36" -quick-lru@^1.0.0: - version "1.1.0" - resolved "https://registry.yarnpkg.com/quick-lru/-/quick-lru-1.1.0.tgz#4360b17c61136ad38078397ff11416e186dcfbb8" - randomatic@^1.1.3: version "1.1.7" resolved "https://registry.yarnpkg.com/randomatic/-/randomatic-1.1.7.tgz#c7abe9cc8b87c0baa876b19fde83fd464797e38c" @@ -4463,13 +4423,6 @@ read-pkg-up@^2.0.0: find-up "^2.0.0" read-pkg "^2.0.0" -read-pkg-up@^3.0.0: - version "3.0.0" - resolved "https://registry.yarnpkg.com/read-pkg-up/-/read-pkg-up-3.0.0.tgz#3ed496685dba0f8fe118d0691dc51f4a1ff96f07" - dependencies: - find-up "^2.0.0" - read-pkg "^3.0.0" - read-pkg@^1.0.0: version "1.1.0" resolved "https://registry.yarnpkg.com/read-pkg/-/read-pkg-1.1.0.tgz#f5ffaa5ecd29cb31c0474bca7d756b6bb29e3f28" @@ -4486,14 +4439,6 @@ read-pkg@^2.0.0: normalize-package-data "^2.3.2" path-type "^2.0.0" -read-pkg@^3.0.0: - version "3.0.0" - resolved "https://registry.yarnpkg.com/read-pkg/-/read-pkg-3.0.0.tgz#9cbc686978fee65d16c00e2b19c237fcf6e38389" - dependencies: - load-json-file "^4.0.0" - normalize-package-data "^2.3.2" - path-type "^3.0.0" - read@1, read@~1.0.1, read@~1.0.7: version "1.0.7" resolved "https://registry.yarnpkg.com/read/-/read-1.0.7.tgz#b3da19bd052431a97671d44a42634adf710b40c4" @@ -4558,13 +4503,6 @@ redent@^1.0.0: indent-string "^2.1.0" strip-indent "^1.0.1" -redent@^2.0.0: - version "2.0.0" - resolved "https://registry.yarnpkg.com/redent/-/redent-2.0.0.tgz#c1b2007b42d57eb1389079b3c8333639d5e1ccaa" - dependencies: - indent-string "^3.0.0" - strip-indent "^2.0.0" - regenerate@^1.2.1: version "1.3.3" resolved "https://registry.yarnpkg.com/regenerate/-/regenerate-1.3.3.tgz#0c336d3980553d755c39b586ae3b20aa49c82b7f" @@ -5213,10 +5151,6 @@ strip-indent@^1.0.1: dependencies: get-stdin "^4.0.1" -strip-indent@^2.0.0: - version "2.0.0" - resolved "https://registry.yarnpkg.com/strip-indent/-/strip-indent-2.0.0.tgz#5ef8db295d01e6ed6cbf7aab96998d7822527b68" - strip-json-comments@~2.0.1: version "2.0.1" resolved "https://registry.yarnpkg.com/strip-json-comments/-/strip-json-comments-2.0.1.tgz#3c531942e908c2697c0ec344858c286c7ca0a60a" @@ -5381,10 +5315,6 @@ trim-newlines@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/trim-newlines/-/trim-newlines-1.0.0.tgz#5887966bb582a4503a41eb524f7d35011815a613" -trim-newlines@^2.0.0: - version "2.0.0" - resolved "https://registry.yarnpkg.com/trim-newlines/-/trim-newlines-2.0.0.tgz#b403d0b91be50c331dfc4b82eeceb22c3de16d20" - trim-off-newlines@^1.0.1: version "1.0.1" resolved "https://registry.yarnpkg.com/trim-off-newlines/-/trim-off-newlines-1.0.1.tgz#9f9ba9d9efa8764c387698bcbfeb2c848f11adb3" @@ -5735,12 +5665,6 @@ yallist@^2.1.2: version "2.1.2" resolved "https://registry.yarnpkg.com/yallist/-/yallist-2.1.2.tgz#1c11f9218f076089a47dd512f93c6699a6a81d52" -yargs-parser@^10.0.0: - version "10.0.0" - resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-10.0.0.tgz#c737c93de2567657750cb1f2c00be639fd19c994" - dependencies: - camelcase "^4.1.0" - yargs-parser@^9.0.2: version "9.0.2" resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-9.0.2.tgz#9ccf6a43460fe4ed40a9bb68f48d43b8a68cc077"