feat: add npm init <create-pkg-name> command #20303

jdalton · 2018-04-11T06:39:50Z

The npm init <create-pkg-name> command will

detect the argument after npm init
append the appropriate prefix to it
(e.g. npm init esm will translate the esm arg to create-esm)
invoke the equiv of npx create-esm via libnpx

Update:

Okay!

Basic functionality exists in the PR now (thanks to @zkat for getting me unstuck).

At the moment I defer to npx for parsing args and handling installs, which means it follows its rules on fresh installing packages and all that. npx does all the heavy lifting here so this tie-in is pretty minimal.

I based npx invocation on bin/npx-cli.js. The first arg beyond npm init __ is used as the initer to resolve. Additional arguments are forwarded to the initer.

I used args passed to init() as the initial feature gate because it was provided info. The args array lacks extra flags though. So, for say npm init esm -y the args array to init() is ['esm']. This is why process.argv is used to forward additional args.

Erroring is handled by npx. So for invalid packages the result looks like

npm init b -y
npm ERR! code E404
npm ERR! 404 Not Found: create-b@latest

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/jdalton/.npm/_logs/2018-04-11T23_57_32_908Z-debug.log
Install for create-b@latest failed with code 1

Update:

Added create as an alias of init and added innit as an affordance of init.

jdalton · 2018-04-11T23:27:00Z

lib/init.js

+      .then(cb)
+      .catch(cb)
+  }
+


The promise returned by npx is a vanilla promise (not a bluebird one) so lacks the nodeify helper.

The promise then(cb) of npx is executed before the npm init command finishes which causes the process to exit. There is a PR open on npx (zkat/npx#172) to return a promise so the cb will be executed after npx runs its command.

jdalton · 2018-04-11T23:28:26Z

lib/init.js

+    var NPM_PATH = path.resolve(__dirname, '../bin/npm-cli.js')
+    var initerName = args[0]
+    var packageName = initerName.replace(/^(@[^/]+\/)?/, '$1create-')
+


☝️ That regexp is the key yarn/npm interoperable bit.

jdalton · 2018-04-12T05:37:23Z

Any guidance on unit tests would be appreciated.

jdalton · 2018-04-12T16:07:39Z

lib/init.js

+    var packageName = /^@[^/]+$/.test(initerName)
+      ? initerName + '/create'
+      : initerName.replace(/^(@[^/]+\/)?/, '$1create-')
+


👆 In addition to following yarn's rules,
name expansion also supports transforming @scope into @scope/create.

zkat · 2018-04-12T16:38:37Z

@jdalton as far as unit tests go, I would mock bin/npx-cli.js and just make sure it's being called with the right arguments.

jdalton · 2018-04-12T16:51:10Z

@zkat

as far as unit tests go, I would mock bin/npx-cli.js and just make sure it's being called with the right arguments.

Cool!

jdalton · 2018-04-12T16:51:21Z

~~Note: This PR depends on zkat/npx#172 (however it is resolved).~~

The npx issue is resolved 😋

jdalton · 2018-04-18T02:01:19Z

Added tests!

zkat · 2018-04-18T18:47:25Z

lib/init.js

 var log = require('npmlog')
 var npm = require('./npm.js')
+var npx = require('libnpx')
 var initJson = require('init-package-json')
 var output = require('./utils/output.js')
 var noProgressTillDone = require('./utils/no-progress-while-running').tillDone

 init.usage = 'npm init [--force|-f|--yes|-y]'


This should be updated. You should document this feature in doc/cli/npm-init.md as well.

zkat · 2018-04-18T18:47:37Z

package.json

@@ -74,7 +74,7 @@
    "lazy-property": "~1.0.0",
    "libcipm": "^1.6.2",
    "libnpmhook": "^4.0.1",
-    "libnpx": "^10.1.1",
+    "libnpx": "^10.2.0",


This can be removed -- I've updated libnpx

jdalton · 2018-04-18T20:27:44Z

Added docs and removed the libnpx bump in the package.json.

jdalton · 2018-04-18T21:08:05Z

Thank you 🎉

statianzo · 2018-04-19T19:27:14Z

lib/config/cmd-list.js

@@ -4,6 +4,7 @@ var shorthands = {
  'rb': 'rebuild',
  'list': 'ls',
  'ln': 'link',
+  'create': 'init',


Thanks for this alias 👍

Thanks goes to @zkat 👏

@jdalton

PR-URL: #20303 Credit: @jdalton Reviewed-By: @zkat

jdalton requested a review from a team as a code owner April 11, 2018 06:39

jdalton changed the title ~~Add support for npm init <create-pkg-name>.~~ feat: add npm init <create-pkg-name> Apr 11, 2018

jdalton changed the title ~~feat: add npm init <create-pkg-name>~~ feat: add npm init <create-pkg-name> command Apr 11, 2018

jdalton commented Apr 11, 2018

View reviewed changes

jdalton changed the base branch from latest to release-next April 11, 2018 23:51

iarna force-pushed the release-next branch from 7305227 to b5babf0 Compare April 12, 2018 01:44

jdalton mentioned this pull request Apr 12, 2018

Add return promise to the Module.runMain() branch. zkat/npx#172

Merged

jdalton commented Apr 12, 2018

View reviewed changes

iarna force-pushed the release-next branch 3 times, most recently from 2e76172 to fe31e66 Compare April 13, 2018 20:20

zkat suggested changes Apr 18, 2018

View reviewed changes

feat: add npm init <create-pkg-name>

2a174b8

zkat approved these changes Apr 18, 2018

View reviewed changes

zkat merged commit 008a836 into npm:release-next Apr 18, 2018

jdalton deleted the init branch April 18, 2018 21:05

jdalton mentioned this pull request Apr 19, 2018

test: ensure npm init forwards arguments #20372

Merged

statianzo reviewed Apr 19, 2018

View reviewed changes

iarna pushed a commit that referenced this pull request May 5, 2018

init: use npx for extended initializers (#20303)

adc009e

PR-URL: #20303 Credit: @jdalton Reviewed-By: @zkat

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add npm init <create-pkg-name> command #20303

feat: add npm init <create-pkg-name> command #20303

jdalton commented Apr 11, 2018 •

edited

jdalton Apr 11, 2018 •

edited

jdalton Apr 11, 2018

jdalton commented Apr 12, 2018

jdalton Apr 12, 2018 •

edited

zkat commented Apr 12, 2018

jdalton commented Apr 12, 2018 •

edited

jdalton commented Apr 12, 2018 •

edited

jdalton commented Apr 18, 2018

zkat Apr 18, 2018

zkat Apr 18, 2018

jdalton commented Apr 18, 2018

jdalton commented Apr 18, 2018

statianzo Apr 19, 2018

jdalton Apr 19, 2018

feat: add npm init <create-pkg-name> command #20303

feat: add npm init <create-pkg-name> command #20303

Conversation

jdalton commented Apr 11, 2018 • edited

jdalton Apr 11, 2018 • edited

Choose a reason for hiding this comment

jdalton Apr 11, 2018

Choose a reason for hiding this comment

jdalton commented Apr 12, 2018

jdalton Apr 12, 2018 • edited

Choose a reason for hiding this comment

zkat commented Apr 12, 2018

jdalton commented Apr 12, 2018 • edited

jdalton commented Apr 12, 2018 • edited

jdalton commented Apr 18, 2018

zkat Apr 18, 2018

Choose a reason for hiding this comment

zkat Apr 18, 2018

Choose a reason for hiding this comment

jdalton commented Apr 18, 2018

jdalton commented Apr 18, 2018

statianzo Apr 19, 2018

Choose a reason for hiding this comment

jdalton Apr 19, 2018

Choose a reason for hiding this comment

jdalton commented Apr 11, 2018 •

edited

jdalton Apr 11, 2018 •

edited

jdalton Apr 12, 2018 •

edited

jdalton commented Apr 12, 2018 •

edited

jdalton commented Apr 12, 2018 •

edited