依赖管理

Wippy 使用基于锁定文件的依赖系统。模块发布到 hub,在源代码中声明为依赖项,然后解析到 wippy.lock 文件中以跟踪确切版本。

项目文件

wippy.lock

锁定文件跟踪项目的目录布局和固定的依赖项:

directories:
  modules: .wippy
  src: ./src
modules:
  - name: acme/http
    version: v1.2.0
    hash: 4ea816fe84ca58a1f0869e5ca6afa93d6ddd72fa09e1162d9e600a7fbf39f0a2
  - name: acme/sql
    version: v2.0.1
    hash: b3f9c8e12a456d7890abcdef1234567890abcdef1234567890abcdef12345678
字段 描述
directories.modules 下载模块的存储位置(默认:.wippy
directories.src 源代码所在位置(默认:./src
modules[].name 模块标识符,格式为 org/module
modules[].version 固定的语义版本
modules[].hash 用于完整性验证的内容哈希

wippy.yaml

用于发布的模块元数据。仅在发布自己的模块时需要:

organization: acme
module: http
version: 1.2.0
description: HTTP utilities for Wippy
license: MIT
repository: https://github.com/acme/wippy-http
keywords:
  - http
  - web
字段 必需 描述
organization 小写字母、数字和连字符
module 小写字母、数字和连字符
version 语义版本(发布时设置)
description 模块描述
license SPDX 许可证标识符
repository 源代码仓库 URL
homepage 项目主页
keywords 发现关键词
authors 作者列表

声明依赖

_index.yaml 中添加 ns.dependency 条目:

version: "1.0"
namespace: app
entries:
  - name: dependency.http
    kind: ns.dependency
    component: acme/http
    version: "^1.0.0"

  - name: dependency.sql
    kind: ns.dependency
    component: acme/sql
    version: ">=2.0.0"

版本约束

约束 示例 匹配范围
精确 1.2.3 仅 1.2.3
插入符 ^1.2.0 >=1.2.0, <2.0.0
波浪号 ~1.2.0 >=1.2.0, <1.3.0
范围 >=1.0.0 1.0.0 及以上
通配符 * 任意版本(选择最高版本)
组合 >=1.0.0 <2.0.0 1.0.0 到 2.0.0 之间

解析规则

  • 每个模块根据依赖图中所有已声明范围的交集解析。不兼容的范围(菱形冲突)会以明确的错误使解析失败,而不是悄悄选择某一边。
  • 依赖从其声明的范围求解,而不是从先前解析的固定版本求解。
  • 根声明优先于传递声明:当你的应用和某个依赖都引入同一个模块或需求时,你的声明优先。携带 meta.module 的依赖条目是传递性的,除非显式标记为根 — 已发布的应用会将其源码中声明的依赖保留为根。
  • 同一个组件只能作为根依赖声明一次 — 重复声明会以冲突错误被拒绝。请改为更新已有的依赖。

运行时将每次解析出的依赖图持久化到其注册表历史中,并在启动时重放而不是重新求解,因此已部署的应用启动时使用的正是应用依赖变更时解析出的版本。wippy.lock 仍然是源码项目的可移植快照。

工作流程

创建新项目

wippy init

创建包含默认目录的 wippy.lock

添加依赖

wippy add acme/http               # Latest version
wippy add acme/http@1.2.3         # Exact version
wippy add acme/http@latest         # Latest label

这会更新锁定文件。然后执行安装:

wippy install

从源代码解析

如果源代码中已声明 ns.dependency 条目:

wippy update

这会扫描源代码目录,解析所有依赖约束,更新锁定文件并安装模块。

更新依赖

wippy update                       # Re-resolve all dependencies
wippy update acme/http             # Update only acme/http
wippy update acme/http acme/sql    # Update specific modules

更新特定模块时,其他模块保持固定在当前版本。如果更新需要更改非目标模块,系统会提示确认。

从锁定文件安装

wippy install                      # Install all from lock
wippy install --refresh            # 重新获取每个模块(--force 和 --repair 是别名)

模块存储

下载的模块存储在 .wippy/vendor/ 目录下:

project/
  wippy.lock
  src/
    _index.yaml
  .wippy/
    vendor/
      acme/
        http-v1.2.0.wapp
        sql-v2.0.1.wapp

默认情况下,模块以 .wapp 文件保存。要将其解压为目录:

# wippy.lock
options:
  unpack_modules: true

启用解压后:

.wippy/
  vendor/
    acme/
      http/
        wippy.yaml
        src/
          _index.yaml
          ...

使用替换进行本地开发

使用本地目录覆盖 hub 模块以进行开发。替换在运行时配置文件的 workspace 区段中声明 — 通常放在一个私有的、被 git 忽略、组合在 .wippy.yaml 之上的文件中:

# .wippy.workspace.yaml
version: "1.0"
workspace:
  replacements:
    acme/http: ../local-http
    acme/sql: ../local-sql
wippy run --config .wippy.yaml --config .wippy.workspace.yaml

键为 org/module,值为目录(相对路径相对于第一个 --config 文件所在目录解析;路径必须存在且为目录)。将替换设为 null 会禁用从先前配置层或 profile 继承的替换。替换也可以放在 profile 中,从而只在 --profile workspace 时生效。

工作区替换在启动时影响加载图,且永远不会写入 wippy.lock。对本地源码的更改会被直接调和,无需联系 hub。模块 wippy.yaml 中的源码 exclude: glob 同样适用于替换目录 — 在加载条目和对内容做哈希时都生效。

wippy.lock 中的 replacements: 区段已弃用:它仍会加载,但会打印警告。请将这些条目移到配置文件中的 workspace.replacements

加载顺序

启动时,Wippy 按以下顺序从目录加载条目:

  1. 源代码目录(src
  2. 替换目录
  3. 供应商模块目录

具有活动替换的模块会跳过其供应商路径。

完整性验证

锁定文件中的每个模块都有内容哈希。在安装过程中,下载的模块会根据其预期哈希进行验证。不匹配的模块会被拒绝并从注册表重新下载。

另请参阅