使用NodeJS
开发项目的时,每个项目都可以看作是一个npm
包,commonJS
规范一个完整的包应该包含哪些文件?
bind
文件夹,存放二进制目录lib
文件夹,存放相关的 JavaScript 代码doc
文件夹,存放文档的目录test
文件夹,存放单元测试的代码package.json
,包描述文件
package.json
文件参数解释:
{
// 主页
"homepage": "",
// 包的名称
"name": "",
// 包的版本
"version": "1.2.11",
// 包的描述
"description": "",
// 包的作者
"author": "",
// 关键字
"keywords": [],
// 包的维护者
"maintainers": [],
// bug
"bugs": [],
// 许可
"licenses": [],
// 可以使用该包的操作系统
"os": ["linux", "windows", "macos"],
// 生产环境依赖包及版本。一般都是依赖包如 vue、babel
"dependencies": {},
// 脚本说明对象
/*
例如使用 babel 的时候执行文件:
./node_modules/.bin/babal src --out-dir lib
*/
/*
配置了 scripts 后就可以通过 npm run build 执行脚本
run 关键字会找 node_modules/.bin 文件夹
.bin 相当于本地的可运行的文件(存放系统命令)
*/
"scripts": {
"build": "babel src --out-dir lib"
},
// 开发环境依赖包及版本。一般都是构建工具如 webpack、eslint,存放本身和当前包没有太多的关系的工具
/*
1.xx.xx 大版本
1.1.xx 次要版本
1.1.1 小版本
>= 1.0.3 大于等于
<= 1.0.3 小于等于
^1.0.3 插入号,安装的版本不能低于该版本同时不能更改大版本号,否则可能存在兼容问题
~= 1.0.3 大版本和次要版本都不能改变
*/
"devDependencies": {},
// 包的入口文件,默认为 index.js
"main": {},
"bin": {}
}