如何调整npm package.json?

时间:2015-12-31 22:30:26

标签: node.js npm

如何设置npm package.json?

以下是什么? :“main”:“index.js”“devDependencies”“脚本”

我试试:

{
  "name": "progectapi2", //Name project
  "version": "1.0.0",    //Version project
  "description": "test", //description project
  "main": "index.js",    //What is it? 
  "dependencies": {      //dependencies package project
    "sass": "^0.5.0"
  },
  "devDependencies": {}, //What is it? 
  "scripts": {           //What is it? 
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "My_Name",   //Name autor
  "license": "UNLICENSED"//license project
}

2 个答案:

答案 0 :(得分:3)

可以找到package.json文件的完整文档here,但要回答您的具体问题

  • main是您图书馆的入口点,所以当有人做require('progectapi2')时,这应该是第一个加载的文件。
  • devDependencies是开发程序包所需的程序包的列表,而不是用于使用或运行它。
  • 脚本用于添加为响应某些用户操作而运行的命令,例如npm start

答案 1 :(得分:2)

package.json的通用definition可以是:

  

所有npm包都包含一个文件,通常在项目根目录中,名为package.json - 该文件包含与项目相关的各种元数据。此文件用于向npm提供信息,使其能够识别项目以及处理项目的依赖项。它还可以包含其他元数据,例如项目描述,特定分发中的项目版本,许可证信息,甚至配置数据 - 所有这些对于npm和包的最终用户都是至关重要的。 package.json文件通常位于Node.js项目的根目录下。

在要作为npm包分发的项目的工作目录上运行npm init,将通过命令行向导指导您创建package.json文件,通过一些问题(即对项目,贡献者等的描述)。

dependencies是以最终用户身份运行指定项目所需的其他项目,而devDependencies是开发项目所需的项目。根据各种依赖关系,这里有一个更详细的answer

  

主要
  主要字段是模块ID,它是程序的主要入口点。也就是说,如果您的包名为foo,并且用户安装它,然后执行require("foo"),那么将返回您的主模块的导出对象。

<强>脚本
您可以将scripts视为公开其他npm命令的对象。该对象假定键是npm命令,值是脚本路径。
例如,根据您的情况,当运行npm test时,控制台将显示Error: no test specified,然后退出。

有关详情,请参阅完整的documentation和/或查看this互动指南。