yumemi/kit

yumemi kit と yumemi gear のコマンド(0.16.0 K1b・G2、_drafts/yumemi-kit/design.v0.md の「マシンの中の kit の 置き場と yumemi のコマンド」、_drafts/yumemi-lambda/design.v0.md の「gear ── 印と出どころは kit に揃え…」)。

置き場は ~/.yumemi/(YUMEMI_HOME で替えられる)で、yumemi に依存する Gleam package。kit は kits/<name>/、gear は gears/<name>/ に 1 つずつ置き、各 kit・gear は自分の git リポ。コマンドは置き場で gleam run -m yumemi/kit -- <面の dir> kit|gear <動詞> … を呼ぶ 1 行の shell の包み(wrapper)から走る。面(gear なら app)の dir は包みが cd の前の $PWD で渡す。

kit と gear は動詞の手続きを種(Kind)を引数にした 1 本で持つ。違うのは印([yumemi] kit = true・gear = true)・ 置き場の dir・check の中身(kit は生成器の kit の段、gear は yumemi/gen/gear の gear の条文)と、文言の語(足す先は kit なら面、gear ならアプリ)と雛形(kit だけ src/escapes/)だけ。

最初の 1 回(yumemi kit init に当たる手順、init_steps):置き場の dir に yumemi への依存だけの gleam.toml を 置いて gleam deps download、包みを shell の rc に足す。置き場の lock の yumemi がコマンドの版を決める。

exit:0 は済んだ、1 は止めた(理由と次の手を出す)、2 は使い方の誤り。check は生成器の段の exit (0・3・4・5)をそのまま返す。

Types

コマンドの種。

pub type Kind {
  Kit
  Gear
}

Constructors

  • Kit
  • Gear
pub type Source {
  Path
  Git
  Other
}

Constructors

  • Path
  • Git
  • Other

Values

pub fn dependency_add(
  toml: String,
  name: String,
  line: String,
) -> Result(String, String)

[dependencies] の表の最後の鍵の行の後に line を 1 行足す。表が無ければ末尾に表ごと足す。既にあれば止める。

pub fn dependency_line(
  toml: String,
  name: String,
) -> Result(String, Nil)

[dependencies] の表の中の name の行(元の字のまま)。

pub fn dependency_remove(
  toml: String,
  name: String,
) -> Result(String, String)

[dependencies] の name の行を消す。無ければ止める。

pub fn dependency_replace(
  toml: String,
  name: String,
  line: String,
) -> Result(String, String)

[dependencies] の name の行を line に替える。無ければ止める。

pub fn dependency_source(line: String) -> Source
pub fn gear_toml(name: String, requirement: String) -> String

gear の雛形の gleam.toml。targets は書かない(「宣言した全指し先」と読む。Workers の部品を使えば gear check が止める)。

pub fn home() -> String

置き場の dir の実体の path。包みが ${YUMEMI_HOME:-$HOME/.yumemi} へ cd してから走らせるので、process の cwd が 置き場(場所を決めるのは包みの 1 か所)。

pub fn init_steps(minor: String) -> String

yumemi kit init に当たる最初の 1 回の手順(README に載せる形)。minor は yumemi の要求(>= 0.16.0 and < 0.17.0)。

pub fn inline_string(
  line: String,
  key: String,
) -> Result(String, Nil)

行の中の key = "…" の字({ path = "/k" } の /k)。

pub fn is_kit(toml: String) -> Bool
pub fn is_marked(kind: Kind, toml: String) -> Bool

gleam.toml の [yumemi] に種の印(kit = true・gear = true)があるか。

pub fn is_url(target: String) -> Bool

名でなく取り込み元の URL か(://、git@…:、.git の終わり、path)。

pub fn kit_toml(name: String, requirement: String) -> String

kit の雛形の gleam.toml。yumemi の要求は置き場の lock の minor 1 つ(design.v0 の「版」)。

pub fn main() -> Nil
pub fn minor_requirement(version: String) -> Result(String, Nil)

lock の版(0.16.2)から、その minor 1 つの要求(>= 0.16.0 and < 0.17.0)。

pub fn package_name(toml: String) -> String

gleam.toml の頭(最初の表の前)の name。

pub fn run(
  kind: Kind,
  cwd: String,
  home: String,
  args: List(String),
) -> Int

args は kit・gear の後の語。cwd は面(gear ならアプリ)の dir(包みが渡した $PWD)の絶対 path。

pub fn strip_credentials(url: String) -> String

URL の認証情報(https://user:token@host/… の user:token@)を落とす。

pub fn table_set(
  toml: String,
  table: String,
  key: String,
  line: String,
) -> String

[table] の key の行を line にする。無ければ表の最後の鍵の行の後に、表も無ければ末尾に表ごと足す。

pub fn usage() -> String
pub fn valid_name(name: String) -> Bool

Gleam の package の名(英小文字で始まり、英小文字・数字・_)。

pub fn word(kind: Kind) -> String

種の語(コマンドの語・印の鍵・文言)。

pub fn wrapper() -> String

yumemi の 1 行の shell の包み。cd の前に $PWD を引数の頭に積み、置き場で yumemi/kit を呼ぶ。

✨ Search Document