relative-deps: 局部依赖管理利器

relative-deps: 局部依赖管理利器

relative-deps Installs local dependencies for optimal developer experience 项目地址: https://gitcode.com/gh_mirrors/re/relative-deps

1. 项目目录结构及介绍

在深入探讨relative-deps之前，让我们先了解典型的工作空间布局。一个基于此工具的项目通常具有以下结构：

/my-awesome-project
│
├── my-fancy-library         # 你的本地库项目
│
└── my-awesome-project       # 主工程
    ├── node_modules          # 依赖包存放处
    ├── src                   # 应用源代码
    ├── package.json          # 主工程的配置文件
    └── relative-dependencies # 可选，用于明确列出相对依赖

my-fancy-library是与主项目my-awesome-project协同开发的局部库。通过relative-deps，这两个部分可以无缝对接，无需正式发布到npm。

2. 项目的启动文件介绍

在使用relative-deps的项目中，并没有特定命名的“启动文件”。然而，关键在于配置package.json中的脚本（scripts），尤其是prepare或自定义的脚本（如prestart, prebuild, pretest等）来触发依赖关系检查和同步。例如，一个典型的package.json会包含如下脚本部分：

{
  "scripts": {
    "prepare": "relative-deps",   // 或 prestart/prebuild 等，依据需求设置
    ...
  },
  ...
}

当你运行指定的脚本时，relative-deps将确保所有相对依赖都已正确安装并同步到最新状态。

3. 项目的配置文件介绍

package.json

主要的配置位于项目的package.json中。除了常规的元数据外，它还引入了两个特别重要的部分：

• relativeDependencies: 这个数组列举了所有作为相对路径依赖的库，形如：

  "relativeDependencies": [
    "my-fancy-library": "/path/to/my-fancy-library"
  ]
  

• scripts: 如前所述，这里定义了触发relative-deps操作的命令，最常见的就是利用prepare剧本。

如果你从零开始集成relative-deps，可以通过执行npx relative-deps init命令自动添加这些必要的配置项，初始会设置一个空的relativeDependencies列表和默认的prepare脚本。

自定义配置

虽然核心配置集中在package.json，但在实际应用中，开发者可以根据需要调整脚本名称(--script或 -S选项可定制)，以及是否将依赖添加至devDependencies而非dependencies(--dev或 -D标记)。这样的灵活性使得relative-deps能够适应多种项目需求。

---

以上就是关于relative-deps项目的核心配置和启动流程的概述。通过这种方式，开发者可以在不增加过多复杂性的前提下，高效地管理和发展局部依赖的生态系统。

relative-deps Installs local dependencies for optimal developer experience 项目地址: https://gitcode.com/gh_mirrors/re/relative-deps