Skip to content

設計配方定義文件的格式 #4

Description

@lotem
  1. 「配方」用於定義一組配置及其他數據文件,指定其如何使用。

  2. 配方定義文件的格式有以下選擇:

  • bash 腳本,可定義(實現)一組變量、函數
  • 特定格式的 YAML 文件

無論哪種格式,都允許在代碼庫缺失配方定義文件的情況下,自動推導出默認的配方定義。
在 Windows 平臺 bash 不可用的情況下,只能忽略配方定義文件,做默認安裝。

  1. 在配方裏定義安裝動作,有以下選擇:
  • 安裝腳本(bash)
  • 指定要複製的文件 + 打補靪

無論哪種形式,都支持在未定義安裝動作的情況下,執行默認的安裝動作。
目前已實現的默認安裝動作爲:複製代碼庫中的 *.yaml, *.txt, opencc/*.{json,ocd,txt} 文件。

  1. 一份代碼庫可以提供多份配方。
    安裝時指定配方 user/repo:recipe 或安裝代碼庫默認的配方 user/repo

  2. 參數化配方,允許在安裝時定義一組變量以改變(具體化)安裝動作。
    例如爲某項用補靪實現的定製動作設定目標輸入方案。

若選用 bash 安裝腳本,則實現參數化比較容易;
若選用 YAML 格式的補靪,則需要模板機制。

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions