package.json文件中Node相关字段解析_查看package.json需要用到的node

前言

在工程化项目开发中必不可少的会碰到package.json文件，因为学习package.json文件相关知识尤为重要，这里介绍一些日常工作中碰到的一些字段

name

name字段用于定义你的项目名称，当我们发布到npm上的时候，name就代表着你的项目名称，在其他项目中引入时也是使用name字段

import demo from 'demo'
1

type

定义了 Node.js 用于以 该文件作为其最近父级的所有.js文件的模块格式，
.js .cjs 文件默认以 CommonJS Modules 执行，.mjs 则默认以 ECMAScript Modules 执行，设置type用来决定.js文件的默认执行格式

"type": "commonjs"
"type": "module"
1
2

exports

学习snabbdom时发现引入的路径和文件实际所在的路径不同，查看源码发现

// snabbdom的 package.json
"exports": {
	"./init": "./build/package/init.js"
}

// 在项目中引入，而init方法实际的位置是在build/package文件夹下
import { init } from 'snabbdom/init'

1
2
3
4
5
6
7
8

显而易见，exports的作用是允许你通过引用自己的 package name（Self-referencing a package using its name）来定义 package 的入口文件

注意：该特性是在Node12版本以上才支持，使用webpack等打包工具时可以使用

main

定义了导入 package 目录时使用的入口文件

"main": "./demo.js"

const demo = require("demo")
//由于 node_modules 的查找机制，会被解析成以下路径
const demo = require("./node_modules/demo")
// 由于我们配置了main属性，文件路径最终会被解析成以下路径
const demo = require("./node_modules/demo/demo.js")

1
2
3
4
5
6
7
8

参考资料： Node.js package.json field definitions