官方文档指南：https://docs.npmjs.com/files/package.json

version

  • semver - 见软件版本博文

    main 属性

  • 项目入口 （被import｜require，默认入口main指定）
  • 如果不填的话，默认是找文件夹根目录下的index
    The main field is a module ID that is the primary entry point to your program. That is, if your package is named foo, and a user installs it, and then does require("foo"), then your main module’s exports object will be returned.

This should be a module ID relative to the root of your package folder.

For most modules, it makes the most sense to have a main script and often not much else.

scripts

  • 带有命令行的node模块，不需要全局安装，scripts中定义的脚本根据node_modules找到对应模块并启动脚本指令

keywords | author | license

TIPS

中文字符

  • Package.json 里面不要出现中文，不然会出现解析错误
  • 项目标题不要大写字母，要全小写

json

  • https://www.json.org/json-zh.html
    1
    A value can be a string in double quotes, or a number, or true or false or null, or an object or an array. These structures can be nested.
  • 注意double quotes,双引号

-lock文件

如果没有强制配 –registry，registry会走lock文件里面的，即使强制配置了–registry还是会走lock
我这边会ignore -lock文件

1
2
3
4
5
6
npm WARN old lockfile 
npm WARN old lockfile The package-lock.json file was created with an old version of npm,
npm WARN old lockfile so supplemental metadata must be fetched from the registry.
npm WARN old lockfile 
npm WARN old lockfile This is a one-time fix-up, please be patient...
npm WARN old lockfile

切换了node版本后，lockfile也会被重写

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
npm ERR! code ERESOLVE
npm ERR! ERESOLVE unable to resolve dependency tree
npm ERR! 
npm ERR! While resolving: xxx
npm ERR! Found: react@17.0.2
npm ERR! node_modules/react
npm ERR!   react@"^17.0.1" from the root project
npm ERR! 
npm ERR! Could not resolve dependency:
npm ERR! peer react@"^0.14.0 || ^15.0.0 || ^16.0.0-0" from react-html-parser@2.0.2
npm ERR! node_modules/react-html-parser
npm ERR!   react-html-parser@"^2.0.2" from the root project
npm ERR! 
npm ERR! Fix the upstream dependency conflict, or retry
npm ERR! this command with --force, or --legacy-peer-deps
npm ERR! to accept an incorrect (and potentially broken) dependency resolution.

这个是因为node版本切换高了

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
> ttf2woff2@3.0.0 install /home/xxx/Documents/xxx/current/seal_pdf_server/node_modules/ttf2woff2
> ((node-gyp configure && node-gyp build) > builderror.log) || (exit 0)

make: g++: No such file or directory
make: *** [addon.target.mk:137: Release/obj.target/addon/csrc/addon.o] Error 127
gyp ERR! build error 
gyp ERR! stack Error: `make` failed with exit code: 2
gyp ERR! stack     at ChildProcess.onExit (/home/xxx/.nvm/versions/node/v14.20.0/lib/node_modules/npm/node_modules/node-gyp/lib/build.js:194:23)
gyp ERR! stack     at ChildProcess.emit (events.js:400:28)
gyp ERR! stack     at Process.ChildProcess._handle.onexit (internal/child_process.js:285:12)
gyp ERR! System Linux 5.18.11-200.fc36.x86_64
gyp ERR! command "/home/xxx/.nvm/versions/node/v14.20.0/bin/node" "/home/xxx/.nvm/versions/node/v14.20.0/lib/node_modules/npm/node_modules/node-gyp/bin/node-gyp.js" "build"
gyp ERR! cwd /home/xxx/Documents/xxx/current/seal_pdf_server/node_modules/ttf2woff2
gyp ERR! node -v v14.20.0
gyp ERR! node-gyp -v v5.1.0
gyp ERR! not ok

用的之前的lockfile,报了这个错误；删除之前lockfile之后依然还是有这个错误

  • This is a NodeJS wrapper for the Google WOFF2 project. If the C++ wrapper compilation fail, it fallbacks to an Emscripten build.
  • https://insertafter.com/en/blog/native-node-module.html
    1
    2
    3
    4
    Gracefully fail compilation
    So, now we have our Emscripten build, let's fallback to him when the native NodeJS add-on compilation goes wrong. First, we must ensure that any failure won't impeach the module to install. We're basically doing this by overriding the default installation script to exit with a 0 code whatever result the compiler gives.

    Then, as a main JavaScript file we will ensure failing to bind to the native add-on will result in requiring the Emscripten fallback. It is simply done by catching exceptions when requiring the bindings.
  • 这样就确保任何失败都不会影响模块的安装 - 通过覆盖默认的安装脚本来做到这一点，无论编译器给出什么结果，都以0代码退出
  • 然后，绑定时通过捕捉异常回退到Emscripten

files

  • 如果不写的话，所有文件都会被打包进去
  • 写的话，就是当我们的包作为依赖包被安装时候，被包括的条目