npm init命令
创建一个pageck.json文件,其中下一步会提示你这些事情;
一般都是直接下一步下一步,这些都不看的
pageck name: (默认项目名字) =>也可以写其他别名
version:(1.0.0)=>默认是1.0.0 也可以写其他版本
description: 默认空 =>描述
entry point:(index.js) =>入口文件默认是index.js
test command: =>测试代码
git repository: =>是否托管在git远程服务上
keyword; =>关键字是什么,上应用 商城上用的
author:=>作者名
–save和–save-dev的区别
在这里插入代码片
pageck.json文件介绍
{
"name": "demo", //项目名称,如果打算发布成 npm 包,它将作为包的名称
"version": "1.0.0", //项目版本号,如果打算发布成 npm 包,这个字段是必须的,遵循 语义化版本号 的要求
"description": "", //项目的描述
"homepage": "", //项目的官网 URL
"main": "index.js", //项目的入口文件
"scripts": { //指定运行脚本的命令缩写,常见的如 npm run build 等命令就在这里配置,
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [], //关键词,用于在 npm 网站上进行搜索
"author": "", //作者
"license": "ISC" //许可证信息,可以选择适当的许可证进行开源
"dependencies": { //项目的生产依赖 :代表项目运行的时候需要使用到的
//第三方包。安装命令:npm i 包名 --save
"jquery": "^3.4.1"
},
"devDependencies": { //项目的开发依赖:项目开发阶段需要用到的第三方
//包安装命令:npm i 包名 --save-dev
"less":"2.5"
}
}
name
name和version是package.json中最重要的两个字段,也是发布到NPM平台上的唯一标识,如果没有正确设置这两个字段,包就不能发布和被下载。
version
包的版本号。如"1.0.0"。
description
包的描述信息,将会在npm search的返回结果中显示,以帮助用户选择合适的包。
keywords
包的关键词信息,是一个字符串数组,同上也将显示在npm search的结果中。
homepage
包的主页地址。
bugs
包的bug跟踪主页地址。
license
包的开源协议名称。
author
包的作者。
contributors, maintainers
包的贡献者,是一个数组。
files(较少用)
包所包含的所有文件,可以取值为文件夹。通常我们还是用.npmignore来去除不想包含到包里的文件
main
包的入口文件。
bin(较少用)
如果你的包里包含可执行文件,通过设置这个字段可以将它们包含到系统的PATH中,这样直接就可以运行,很方便。
man(较少用)
为系统的man命令提供帮助文档。帮助文件的文件名必须以数字结尾,如果是压缩的,需要以.gz结尾。
"man": ["./man/foo.1", "./man/bar.1", "./man/foo.2" ]
directories(较少用)
CommonJS包所要求的目录结构信息,展示项目的目录结构信息。字段可以是:lib, bin, man, doc,example。值都是字符串。
repository
包的仓库地址。
"repository": {
"type": "git",
"url": "git+https://github.com/rainnaZR/es6-react.git"
}
以下内容是重点
scripts
通过设置这个可以使NPM调用一些命令脚本,封装一些功能。
"scripts": {
"build": "webpack --config config/webpack.config.js",
"watch": "webpack-dev-server --config config/webpack.config.js --hot --inline --progress"
//还可以给命令打开指定的浏览器,这是指定打开谷歌 --open是打开命令,后面
//跟浏览器名称
"start":"webpack-dev-server --open chrome"
}
//使用的时候是 start是scripts里面对应的key值,value是命令
//也可以自己去封装一些命令
npm run start
这个配置在配合webpack的使用时,很有用。
config
添加一些设置,可以供scripts读取用,同时这里的值也会被添加到系统的环境变量中。
"config": {
"port": "8080"
}
npm start的时候会读取到npm_package_config_port环境变量。
dependencies
指定依赖的其它包,这些依赖是指包发布后正常执行时所需要的,也就是线上需要的包。使用下面的命令来安装:
npm install --save 包名
如果是开发中依赖的包,可以在devDependencies设置。
devDependencies
这些依赖只有在开发时候才需要。使用下面的命令来安装:
npm install --save-dev 包名