npm (Node Package Manager) 参考文档

node -v
npm -v

npm install -g npm

# 安装nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash

# 使用特定版本的Node.js和npm
nvm install 18
nvm use 18

choco install nvs
nvs add lts
nvs use lts

brew install fnm
fnm install lts
fnm use lts

FROM node:18-alpine
WORKDIR /app
COPY package*.json ./
RUN npm ci
COPY . .
EXPOSE 3000
CMD ["npm", "start"]

# 设置官方源
npm config set registry https://registry.npmjs.org/

# 设置国内镜像（淘宝）
npm config set registry https://registry.npmmirror.com/

# 设置企业私有源
npm config set registry https://registry.company.com/

npm config set proxy http://proxy.company.com:8080
npm config set https-proxy http://proxy.company.com:8080
npm config set no-proxy "localhost,127.0.0.1"

# 查看缓存目录
npm config get cache

# 清理缓存
npm cache clean --force

# 验证缓存完整性
npm cache verify

# 保存精确版本（不使用^或~前缀）
npm config set save-exact true

# 或设置保存前缀
npm config set save-prefix "="  # 精确版本
npm config set save-prefix "^"  # 兼容更新（默认）
npm config set save-prefix "~"  # 补丁更新

# 启用资金提示
npm config set fund true

# 禁用资金提示
npm config set fund false

# 启用自动安全检查
npm config set audit true

# 禁用自动安全检查
npm config set audit false

{
  "name": "my-awesome-package"
}

{
  "version": "1.2.3"
}

{
  "description": "一个功能强大的npm包示例",
  "keywords": ["npm", "package", "example"],
  "license": "MIT"
}

{
  "main": "dist/index.js",        // CommonJS入口
  "module": "dist/index.esm.js",  // ES模块入口
  "exports": {
    ".": {
      "import": "./dist/index.esm.js",
      "require": "./dist/index.js"
    },
    "./utils": {
      "import": "./dist/utils.esm.js",
      "require": "./dist/utils.js"
    }
  }
}

{
  "files": [
    "dist",
    "README.md",
    "LICENSE"
  ]
}

{
  "dependencies": {
    "express": "^4.18.2",
    "lodash": "^4.17.21"
  }
}

{
  "devDependencies": {
    "jest": "^29.7.0",
    "typescript": "^5.3.3"
  }
}

{
  "peerDependencies": {
    "react": ">=18.0.0",
    "react-dom": ">=18.0.0"
  }
}

{
  "optionalDependencies": {
    "fsevents": "^2.3.3"
  }
}

{
  "bundledDependencies": [
    "my-internal-lib"
  ]
}

{
  "scripts": {
    "start": "node server.js",
    "dev": "nodemon server.js",
    "build": "tsc",
    "test": "jest",
    "lint": "eslint .",
    "format": "prettier --write .",
    "prepare": "husky install"
  }
}

{
  "scripts": {
    "prebuild": "rimraf dist",
    "build": "tsc",
    "postbuild": "echo Build completed successfully!"
  }
}

# 运行脚本并传递参数
npm run test -- --watch

# 运行多个脚本
npm run lint && npm run test

# 并行运行脚本（需要npm-run-all包）
npx npm-run-all --parallel dev watch

# 交互式初始化
npm init

# 使用默认值初始化
npm init -y

# 使用预设模板
npm init vite@latest my-app -- --template react

# 安装所有依赖
npm install
npm i  # 简写

# 安装生产依赖
npm install --production
npm i --production  # 简写

# 安装并保存到dependencies
npm install express
npm i express  # 简写

# 安装并保存到devDependencies
npm install --save-dev jest
npm i -D jest  # 简写

# 安装并保存到optionalDependencies
npm install --save-optional fsevents
npm i -O fsevents  # 简写

# 安装并保存到peerDependencies
npm install --save-peer react
npm i -P react  # 简写

# 安装精确版本
npm install --save-exact lodash
npm i -E lodash  # 简写

# 全局安装
npm install -g typescript
npm i -g typescript  # 简写

# 省略开发依赖
npm install --omit=dev

# 包含开发依赖
npm install --include=dev

# 更新所有依赖
npm update

# 更新特定依赖
npm update express

# 更新到最新版本（忽略版本约束）
npm update express@latest

# 检查所有过时依赖
npm outdated

# 检查特定依赖
npm outdated express

# 查看所有依赖
npm ls

# 查看顶层依赖
npm ls --depth=0

# 查看特定依赖
npm ls express

# 去重依赖
npm dedupe
npm ddp  # 简写

# 清理未使用依赖
npm prune

# 同时清理开发依赖
npm prune --production

# 发布包
npm publish

# 发布测试版本
npm version prerelease --preid=beta
npm publish --tag beta

# 发布私有包
npm publish --access restricted

# 发布前验证
npm publish --dry-run

# 撤销发布（72小时内）
npm unpublish my-package@1.0.0

# 废弃版本
npm deprecate my-package@1.0.0 "This version is deprecated. Please use 1.1.0 instead."

# 创建tarball包
npm pack

# 查看包信息
npm view express

# 查看特定版本信息
npm view express@4.18.2

# 查看包的依赖
npm view express dependencies

# 查看包的版本历史
npm view express versions

# 搜索包
npm search react

# 搜索并过滤
npm search react --filter="keywords:ui"

# 打开包的文档
npm docs express

# 打开包的代码仓库
npm repo express

# 清理缓存
npm cache clean --force

# 验证缓存
npm cache verify

# 查看缓存目录
npm cache ls

# 查看所有配置
npm config list

# 查看特定配置
npm config get registry

# 设置配置
npm config set registry https://registry.npmmirror.com/

# 查看项目依赖安装路径
npm root

# 查看全局依赖安装路径
npm root -g

# 查看当前项目根目录
npm prefix

# 在包目录中创建全局链接
cd my-package
npm link

# 在项目中使用链接的包
cd my-project
npm link my-package

# 取消链接
npm unlink my-package

node_modules/
├── express/
│   └── node_modules/
│       └── accepts/
└── another-package/
    └── node_modules/
        └── accepts/  # 重复安装

node_modules/
├── express/
├── accepts/  # 只安装一次
└── another-package/

# npm v7+会自动安装peerDependencies
npm install react-router-dom

{
  "overrides": {
    "lodash": "^4.17.21"
  }
}

{
  "name": "my-package",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "my-package",
      "version": "1.0.0",
      "dependencies": {
        "express": "^4.18.2"
      }
    },
    "node_modules/express": {
      "version": "4.18.2",
      "resolved": "https://registry.npmjs.org/express/-/express-4.18.2.tgz",
      "integrity": "sha512-5/PsL6iGPdfQ/lKM1UuielYgv3BUoJfz1aUwU9vHZ+J7gyvwdQXFEBIEIaxeGf0GIcreATNyBExtalisDbuMqQ==",
      "dependencies": {
        "accepts": "~1.3.8",
        "array-flatten": "1.1.1",
        "body-parser": "1.20.1",
        "content-disposition": "0.5.4",
        "content-type": "~1.0.4",
        "cookie": "0.5.0",
        "cookie-signature": "1.0.6",
        "debug": "2.6.9",
        "depd": "2.0.0",
        "encodeurl": "~1.0.2",
        "escape-html": "~1.0.3",
        "etag": "~1.8.1",
        "finalhandler": "1.2.0",
        "fresh": "0.5.2",
        "http-errors": "2.0.0",
        "merge-descriptors": "1.0.1",
        "methods": "~1.1.2",
        "on-finished": "2.4.1",
        "parseurl": "~1.3.3",
        "path-to-regexp": "0.1.7",
        "proxy-addr": "~2.0.7",
        "qs": "6.11.0",
        "range-parser": "~1.2.1",
        "safe-buffer": "5.2.1",
        "send": "0.18.0",
        "serve-static": "1.15.0",
        "setprototypeof": "1.2.0",
        "statuses": "2.0.1",
        "type-is": "~1.6.18",
        "utils-merge": "1.0.1",
        "vary": "~1.1.2"
      },
      "engines": {
        "node": ">= 0.10.0"
      }
    }
    // 更多依赖...
  }
}

# 执行安全检查
npm audit

# 查看详细报告
npm audit --json > audit-report.json

# 修复可自动修复的漏洞
npm audit fix

# 修复所有漏洞（包括破坏性变更）
npm audit fix --force

# 查看所有依赖的许可证
npm licenses ls

# 生成许可证报告
npm licenses generate-disclaimer

{
  "name": "my-monorepo",
  "version": "1.0.0",
  "workspaces": [
    "packages/*",
    "apps/*"
  ]
}

# 安装所有工作区依赖
npm install

# 安装依赖到根目录
npm install lodash -W

# 安装依赖到特定工作区
npm install react --workspace=my-app

# 安装依赖到所有工作区
npm install react --workspaces

my-monorepo/
├── node_modules/
│   └── react/  # 共享依赖
├── packages/
│   └── my-package/
└── apps/
    └── my-app/

{
  "scripts": {
    "bootstrap": "lerna bootstrap",
    "build": "lerna run build",
    "publish": "lerna publish"
  }
}

# 在特定工作区执行脚本
npm run build --workspace=my-app

# 在所有工作区执行脚本
npm run build --workspaces

# 并行执行脚本
npm run dev --workspaces --parallel

# 全局安装Verdaccio
npm install -g verdaccio

# 启动Verdaccio
verdaccio

# 配置npm使用Verdaccio
npm config set registry http://localhost:4873/

# GitHub Actions示例
name: Node.js CI
on: [push]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Use Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '18'
          cache: 'npm'
      - name: Install dependencies
        run: npm ci
      - name: Build
        run: npm run build
      - name: Test
        run: npm test
      - name: Publish to private registry
        run: npm publish
        env:
          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

# 使用国内镜像
npm config set registry https://registry.npmmirror.com/

# 使用--no-audit跳过安全检查
npm install --no-audit

# 使用--no-fund跳过资金提示
npm install --no-fund

# 设置更大的缓存大小
npm config set cache-max 1000000000

# 使用CI缓存
npm ci --cache ./npm-cache

# 增加超时时间
npm config set timeout 600000

# 重试失败的安装
npm install --retry 3

# 使用代理
npm config set proxy http://proxy.company.com:8080

# .npmrc
registry=https://registry.npmmirror.com/
save-exact=true
audit=false
fund=false

# .github/workflows/ci.yml
name: CI
on: [push, pull_request]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Setup Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '18'
          cache: 'npm'
      - name: Install dependencies
        run: npm ci
      - name: Lint
        run: npm run lint
      - name: Test
        run: npm run test
      - name: Build
        run: npm run build

# 测试网络连接
npm ping

# 检查仓库源
npm config get registry

# 查看网络代理设置
npm config get proxy
npm config get https-proxy

# 查看依赖树
npm ls --all

# 检查特定依赖的版本
npm ls <package>

# 强制安装特定版本
npm install <package>@<version> --force

# 清理缓存
npm cache clean --force

# 验证缓存
npm cache verify

# 手动删除缓存目录
rm -rf ~/.npm/_cacache

# 更新npm
npm install -g npm@latest

# 更新package-lock.json
rm -rf node_modules package-lock.json
npm install

# 检查peer依赖冲突
npm ls

# 仓库源设置
registry=https://registry.npmmirror.com/

# 代理设置
proxy=http://proxy.company.com:8080
https-proxy=http://proxy.company.com:8080
no-proxy=localhost,127.0.0.1,*.company.com

# 版本控制
save-exact=true
save-prefix=~

# 安全设置
audit=false

# 资金提示
fund=false

# 缓存设置
cache-max=1000000000

# 超时设置
timeout=600000

# 日志设置
loglevel=info

MAJOR.MINOR.PATCH

# Dependencies
node_modules/

# Build outputs
dist/
build/

# Testing
coverage/
*.log

# IDE
.vscode/
.idea/
*.swp
*.swo
*~

# OS
.DS_Store
Thumbs.db

# Environment
.env
.env.local
.env.*.local

# Temporary files
*.tmp
*.temp
.cache/