npm package.js Guide

Posted 2020-06-17

使用package.js（Using a package.json）

最好的方式去管理本地npm的包的方式就是创建一个package.js文件。 package.json文件里面包含很多东西。

1. 他是一个说明你项目中包含了那些包的一个文档
2. 包含了你项目中所使用的包的版本
3. 能够更好的实现项目的移植（更好的和其他开发者分享你的项目）

必须包含的参数

作为一个最小的package.js文件，package.js应该包括：

• "name"

  • 全部小写
  • 单词之间不许有空格
  • 允许使用破折号与下划线

• "version"

例如：

{
 "name": "my-awesome-package",
 "version": "1.0.0"
}

创建一个package.js(Creating a package.json)

使用npm init 命令来创建一个package.json文件。

npm init

这个命令会启动一个命令行”问题“，这些问题将会在你的项目的目录下创建一个package.js文件。

在init之后添加 --yes标记

上面运行npm init出现的扩展性问题，并不是适合每一个人。要是你想要使用你的package.js更灵活，还是需要这些扩展性问题的。

你可以在npm init后面添加--yes或者是-y标记，来创建一个默认的package.js

npm init --yes

上面这个指令会创建一个默认的package.js文件，许多问题都是填的默认值。 如下：

• "name"：在项目中有git文件目录的情况下是用git仓库名，默认是你要创建的包的名字
• "version"：默认是1.0.0
• "version"：一直是index.js
• "scripts"：默认会创建一个空的test脚本
• "keywords"：空
• "author"：可以是任意的名字
• "license"：ISC
• "repository"：如果有，那就是github的这个包的代码仓库
• "bugs"：包含一些github上提交的一些issue等一些bug问题
• "homepage"：你的这个包在github的首页地址

你也可以在npm init这个命令里通过配置一些其他东西，如下：

> npm set init.author.email "[email protected]"
> npm set init.author.name "ag_dubs"
> npm set init.license "MIT"