@architect/hydrate

@ architect/ 水合物 确保建筑师管理的所有功能都安装了它们的依赖性. 包含所有必需的依赖性的函数被认为是"水分"——因此名称!

@ architect/ 水合物 支持使用以下软件包管理器以下列语言管理的依赖性:

• 节点.js 通过 npm 使用 package.json (可选) package-lock.json),或者通过 yarn 使用 package.json 财务报告和审定财务报表 yarn.lock
• 蟒 通过 pip3 使用一个 requirements.txt 文件
• 鲁比 通过 bundle 使用 Gemfile 财务报告和审定财务报表 Gemfile.lock 文件

所需资源

• 节点.js 22或以后 必须使用 @architect/hydrate 6.0.0及以上版本
• 对于Node.js 20 支持, 使用 @architect/hydrate 5.x版本 翻译:

安装

npm install @architect/hydrate

API 密码

所有方法都接受 options 对象可以包括以下属性:

• autoinstall - 说吧 布尔 - 通过静态代码分析启用或禁用自动Lambda依赖树
  • 默认为 false
  • 用于 install
• basepath - 说吧 字符串 - 用于Hydrate搜索函数的文件系统路径
  • 默认当前工作目录
  • 如果您想要将一个函数或一个子集的函数水化,则有用
  • 用于 install + 键 update
• copyShared - 说吧 布尔 - 启用或禁止复制共享代码文件夹(例如:. src/shared进入Lambdas
  • 如果您想要将外部依赖性水化, 则需要禁用
  • 默认为 true
  • 用于 install + 键 update
• cwd - 说吧 字符串 - Hydrate 项目的根文件系统路径正在工作
  • 当前工作目录的默认值
  • 可能与 basepath; 如果与 basepath,指定项目的一个子集,其中 basepath,例如:
    • { cwd: '/your/project/', basepath: '/your/project/src/http/' } 运行水合物对 /your/project/ (无需使用) process.chdir),并且只有水合物在 /your/project/src/http/**
  • 用于 install + 键 update + 键 shared
• hydrateShared - 说吧 布尔 - 在共享代码文件夹中启用或禁用依赖水合(例如:. src/shared(中文(简体) )
  • 如果您想要将外部依赖性水化, 则需要禁用
  • 默认为 true
  • 用于 install + 键 update
• inventory - 说吧 对象 - 建筑设计清单对象;内部一般使用
• local - 说吧 布尔 - 在安装可作为特定平台二进制分发的依赖性时,偏好本地平台
• only - 说吧 字符串 - 指定可能共享文件的子集 shared 复制到 Lambdas 中
  • 默认 Falsy
  • 接受 : shared, (中文(简体) ), views,或 staticJson
  • 用于 shared
• quiet - 说吧 布尔 - 禁用(大多数)记录
• symlink - 说吧 布尔 - 启用或禁用链接,而不是完整目录复制,对本地发展有用
  • 默认为 false
  • 用于 install + 键 update + 键 shared
• timeout - 说吧 数目 - 给每个软件包管理程序执行的时间(以毫秒计)
  • 用于 install + 键 update
• verbose - 说吧 布尔 - 启用动词记录

说明 cwd 对 basepath数字 : cwd 用于 Hydrate 查找您的工程的表单和关键文件和文件夹, 而 basepath 瞄准特定路径。 当存在疑问时, 既不包含参数, Hydrate 将默认处理工作目录; 如果您知道需要在某个特定的地方瞄准 Hydrate , 但不确定要使用哪个参数, 使用 cwd。 。 。 .

hydrate.install(options[, callback]) → [Promise]

安装函数依赖性,然后引用 hydrate.shared()。 。 。 .

确保本地发展行为接近 staging 财务报告和审定财务报表 production 尽可能, hydrate.install() (和其他水合物功能)使用:

• 节点.js数字 : npm ci 若为 package-lock.json 已存在 npm i (一) 如果不是;或 yarn
• 蟒数字 : pip3 install
• 鲁比数字 : bundle install

注:默认 update 还在共享文件夹中安装依赖性, 如 src/shared 财务报告和审定财务报表 src/views。 。 。 .

hydrate.update(options[, callback]) → [Promise]

更新函数依赖性,然后引用 hydrate.shared()。 。 。 .

update 功能几乎与 install,但是它将更新对新版本的依赖性 如果它们存在通过以下方式做到这一点:

• 节点.js数字 : npm update 或者说 yarn upgrade
• 蟒数字 : pip3 install -U --upgrade-strategy eager
• 鲁比数字 : bundle update

注:默认 update 也更新共享文件夹中的依赖性, 如 src/shared 财务报告和审定财务报表 src/views。 。 。 .

hydrate.shared(options[, callback]) → [Promise]

复制共享代码( 从 src/shared 财务报告和审定财务报表 src/views,或者您的习惯 @shared + 键 @views 路径,如果有的话)进入所有函数.