npm的package.json介绍

1 篇文章 0 订阅

NPM,Node Package Manager的缩写,是nodejs的包管理和分发工具,能解决NodeJS代码部署上的很多问题,常见的使用场景有以下几种:

1.允许用户从NPM服务器下载别人编写的第三方包到本地使用。
2.允许用户从NPM服务器下载并安装别人编写的命令行程序到本地使用。
3.允许用户将自己编写的包或命令行程序上传到NPM服务器供别人使用。

使用npm重要的一个文件便是 package.js,其作用如下,

    1、相当本地项目的一个文档说明;

    2、允许指定项目中所使用的node包的版本;

    3、使构建项目更加容易,便于给其他人共享

创建一个package.js的文件,

npm init

一般package.js文件结构与内容,如下

{

    "name": "my_package",     //你的项目名称,全部小写,不能有空格,一个单词,允许-和_. 如果是要发布自己的node插件,一般用github上面项目名称。 下次有机会说明 npm 上面的发布流程。

    "version": "1.0.0",  //你的项目版本号,最好遵守 GNU 版本号管理。 

    "main": "index.js", //目录中启动文件名称。或者称之为入口文件,一般都是 index.js

    "scripts": {

        "test": "echo \"Error: no test specified\" && exit 1"    //一般默认一个test的空文件夹、用作写测试代码。

    },

    "keywords": [],  //项目的关键词。 一般用不到,发布npm才用得到。

    "author": "ag_dubs", //作者名称

    "license": "ISC", //协议 

    "repository": {  // 用来存放到 版本管理远程服务。 发布npm才有用

        "type": "git",

        "url": "https://github.com/ashleygwilliams/my_package.git"

    },

    "dependencies": {   // 正式使用时,依赖的包

        "my_dep": "^1.0.0"

    },

    "devDependencies" : {//开发或者测试时,依赖的包。

        "my_test_framework": "^3.1.0"

    }

    "bugs": {  //同repository

        "url": "https://github.com/ashleygwilliams/my_package/issues"

    },

    "homepage": "https://github.com/ashleygwilliams/my_package"  //项目主页、 发布才有用

}

特别注意的是,package.js文件书写是遵循json严格模式的,key值必须用双引号包裹,文件内部不能有注释,否则会报错。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值