package.json 刚开始最该写清楚哪些内容

很多人第一次运行 npm init 之后，会把 package.json 看成一个顺手生成出来的文件。可到 2013 年，随着 Node.js 项目越来越多，大家已经慢慢发现：这个文件其实正在变成项目配置和协作信息的中心。

它至少要回答项目最基本的问题

一个刚起步的 package.json 不一定复杂，但以下几项通常值得先写清楚：

• 项目名称
• 版本号
• 入口文件
• 依赖列表
• 常用脚本

这些信息一旦存在，别人拿到项目后就不至于完全从目录结构猜起。

最朴素的结构已经很有用

{
  "name": "demo-app",
  "version": "0.1.0",
  "main": "app.js",
  "scripts": {
    "start": "node app.js"
  }
}

这个例子很短，但已经把项目如何启动、当前版本处在哪个阶段表达出来了。

依赖信息会越来越重要

当项目只在自己电脑上跑时，很多人可能还感觉不到 dependencies 的价值。但一旦换机器、换同事、换部署环境，依赖版本有没有被记录下来就会立刻变成实际问题。package.json 之所以关键，就是因为它把这些环境信息开始固定下来。

别把它当成只有 npm 才看的文件

我更愿意把 package.json 理解成项目的一张名片。它不只是给 npm 读取，也是在告诉后来的人：这个项目叫什么、怎么启动、依赖哪些东西、当前大概处在什么阶段。写清楚这些，协作成本会低很多。

小结

package.json 在 2013 年的重要性，已经不只是“装包要用到它”。它开始承担项目说明、依赖记录和命令入口这些职责。越早把它写清楚，项目后面就越不容易失控。