什么是 package.json

348 阅读1分钟
  • 小知识,大挑战!本文正在参与“程序员必备小知识”创作活动。 通常我们可以在项目的根目录中找到package.json,它包含着与项目相关的信息。例如描述,版本,开源协议等等。package.json 必须是严格的json格式。

name和version

name是项目的名称。 version表示当前项目的版本,如果当你发布npm包或者项目的时候,请务必填写。因为用户希望选择不同版本的包。

{
"name": "juejin",
"version" : "1.0.0",
}

1.0.0,第一个数字是主版本号,第二个数字是次版本号,第三个数字是补丁版本号

description

简要描述项目。

{
"description": "一个vue实战项目",
}

keyword

关键字可以方便的让用户在npmjs 查找您的项目。是一个数组。

{
"keywords": ["blog", "vue-blog", "npm"]
}

dependencies

依赖项可帮助您扩展项目添加外部包。当有人安装您的软件包时,所有依赖项也将被安装。

"dependencies": {
    "parseurl": "^1.3.2",
    "statuses": "^1.5.0",
    "type-is": "^1.6.16",
    "vary": "^1.1.2"
}

协议

协议是让用户如何使用你的项目,基本的 协议是 MIT 和 BSD。

{
"license": "MIT"
}

如果您不希望人们使用您的私有或已发布的软件包:

{
  "license": "UNLICENSED"
}

author

作者是一个人,可以有mail和url。

复制

"author": {
"name": "YuriCodesBot",
"url" : "https://twitter.com/yuricodesbot"
}

contributors

贡献者是一群人。

"contributors" : [],

mamin

Main定义用于启动项目的文件。通常是项目根目录中的 index.js 文件,但它可以是您选择作为包入口点的任何文件。

 "main": "index.js",

scripts

脚本包含要在包的生命周期中运行的命令。

"scripts": {
        "start": "node server.js"
    }

Repository

定义了源代码所在的 url,以及它使用的版本类型。

"repository": {
        "type": "git",
        "url": "https://github.com/YuriCodes"
    }