javascript - 如何使 npm 与我的自定义 npm 包一起使用？

Question

我发布了一个新包，旨在通过 cli 为 Node 开源项目生成一个非常小的样板。目前，它只是几个 npx 命令的组合，并且需要其他 npm 包，如 gitignore、许可证才能工作。我想使用以下命令执行 package.json 中的构建脚本。

npx get-set-node-oss build youremailaddress@xyz.com

npm 包链接: get-set-node-oss .我知道这个名字有点太长了。

{
  "name": "get-set-node-oss",
  "version": "1.0.1",
  "description": "One command setup for your Node OSS project",
  "scripts": {
    "build": "npx license mit > LICENSE && npx gitignore node && npx covgen"
  },
  "author": "Harshit Juneja",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/harshitjuneja/get-set-node-oss.git"
  },
  "keywords": [
    "node",
    "boilerplate","gitignore","MIT","OSS"
  ],
  "bugs": {
    "url": "https://github.com/harshitjuneja/get-set-node-oss/issues"
  },
  "homepage": "https://github.com/harshitjuneja/get-set-node-oss#readme"
}

我希望用户创建一个新文件夹并 cd 进入该文件夹并执行

npx get-set-node-oss build emailstring

并获取生成的样板文件。

Answer 1

要使 npx 工作，您需要指定 get-set-node-oss 的内容。命令的意思。值得庆幸的是，这可以通过使用 bin 来完成。 package.json 文件中的字段。来自 NPM 文档的更多信息，适用于您的 reference :

To use this, supply a bin field in your package.json which is a map of command name to local file name. On install, npm will symlink that file into prefix/bin for global installs, or ./node_modules/.bin/ for local installs.

下面是一个例子。

"bin": {   
    "get-set-node-oss": //script you like to run
},

希望它对你有帮助。我已经将 bin 理解为 package.json 中的脚本。我们可以在哪里做 npm run foo或 npx foo两者都产生相同的结果。如果你想要一个例子，这里你去 https://github.com/vipulgupta2048/balenaclone