yumemi/gen/gear

gear の条文(0.16.0、第 53〜57 条、yumemi-016-g1。第 85・86 条と殻への配りは yumemi-016-g3)。設計の正典は tech _drafts/yumemi-lambda/design.v0.md の 「新しい条文」「gear ── 印と出どころは kit に揃え…」「gear の JS の走査」。

gear は gleam.toml の [yumemi] gear = true を書いた Gleam package で、app の lock(無ければ gleam.toml の path を辿った閉包)に載る物を gear と読む。lock の読みは gen_ffi.mjs の locked_packages の返りに乗せ、読めない package は gear か見分けられないので止める(Hex の package と yumemi の gleam.toml が gleam deps download の前で 無いのは止めない ── Hex の gear は取ってきた後に第 53 条が止める)。gear を使わない app は 1 行も出さない。

条止めるものexit
第 53 条gear の source が hex、app の lock の読めない package4
第 54 条gear の module の pub const service・collection・allow4
第 55 条gear の指し先(targets・指し先ごとの module)が app の宣言した指し先を覆わない、targets を書かない gear の Workers の部品、指し先の書き方4(module の file が無いのは 3)
第 56 条gear の JS(と Gleam の @external)の import が gear の中・yumemi/server/target.mjs・許しの表の外、指し先の外の部品、env の読み(Workers の部品を許す file では env を丸ごと変数に入れる形と process.env、契約だけの file では <式>.env.<名>・素の env.<名>・分割代入・別名・process.env)。gear が Gleam で import する gear でない local・git の package にも同じ走査を当てる4
第 57 条x.secret("…")・x.vars("…") の引数が字の literal4
第 85 条app の "<gear>:<道>" の道が読めない・file が無い(exit 3)、両方の殻が引く Hook・Fetch・Pure が app の指し先の 1 つだけの module を指す、DurableObject が Lambda の module を指す(<gear> が lock の gear でないのは第 53 条)4
第 86 条指し先ごとの module の範囲(module の file と、.gleam の module ならその @external の FFI)の file を、範囲の違う file が import する(Lambda の module → Workers の module、指し先に依らない file → 指し先ごとの module)4

殻への配り(G3):app の Hook・Fetch・Pure・DurableObject の module に "<gear>:<道>" を書くと、生成物は gear の build('../../<gear>/<道>.mjs')を import する(import_path)。gear の指し先ごとの module は、app の宣言した指し先の殻 だけが import する(shell_modules ── Workers の module は shell.mjs、Lambda の module は shell.lambda.mjs)。

走査(scan・workers_parts)は字を読む検査で、別名に入れて呼ぶ形(const b = env.X; b.get())は抜ける。app の ★ の 警告(C4b、条でない exit 0 の行)も同じ workers_parts を呼ぶ。

yumemi gear check(G2)は gleam run -m yumemi/gen/gear -- --gear <gear の dir> で、gear 1 つに app に依らない条 (第 54・56・57 条、第 55 条の指し先の書き方)を当てる(gear_check)。gear の lock の package には app の生成と同じ 第 53 条を当てる。exit は生成器と同じ(0・3・4・5)。

Types

走査で拾った 1 つ。kind は “import”(text は指し先、読めなければ “?”)・“workers”(Workers の部品)・ “env”(x.env.<名>・x.env[…]・process.env の読み)・“name”(secret("…")・vars("…") の字の literal)。

pub type Finding {
  Finding(line: Int, kind: String, text: String)
}

Constructors

  • Finding(line: Int, kind: String, text: String)

app の lock の 1 つの package と、gear の印。

pub type Package {
  Package(
    name: String,
    source: String,
    dir: String,
    gear: Bool,
    targets: option.Option(List(String)),
    modules: List(#(String, String)),
    unreadable: String,
    toml_missing: Bool,
    requirements: List(String),
    targets_unreadable: String,
  )
}

Constructors

  • Package(
      name: String,
      source: String,
      dir: String,
      gear: Bool,
      targets: option.Option(List(String)),
      modules: List(#(String, String)),
      unreadable: String,
      toml_missing: Bool,
      requirements: List(String),
      targets_unreadable: String,
    )

    Arguments

    gear

    [yumemi] gear = true

    targets

    [yumemi] targets = [..](書いていなければ None)

    modules

    指し先ごとの module([yumemi.targets.<指し先>] module = "…")

    requirements

    lock の requirements(gear 自身なら直接の依存の名)

    targets_unreadable

    [yumemi.targets.<指し先>] の表の読めない理由(第 55 条)

Values

pub fn app_targets(app: model.App) -> List(String)

app が宣言した指し先(“workers”・“lambda”)。宣言が無ければ [“workers”]。

pub fn check(
  app_dir: String,
  declared: List(String),
) -> List(stop.Note)

第 53〜57 条を、app の宣言した指し先(“workers”・“lambda”)に対して当てる。

pub fn check_targets(
  app_dir: String,
  declared: option.Option(List(String)),
) -> List(stop.Note)

check の、app が指し先を書いていない形も持つ口(None は書いていない ── [“workers”] と読み、第 55 条の文言を分ける)。

pub fn gear_check(dir: String) -> List(stop.Note)

yumemi gear check の段:gear 1 つ(dir)に app に依らない条を当てる(第 54・56・57 条と第 55 条の指し先の書き方 ── Workers の部品があるのに targets を書いていない、を含む)。gear の lock の package には app の生成と同じ第 53 条を当て、 gear が Gleam で import する gear でない local・git の package に第 56 条の走査を当てる。

pub fn gear_dir(
  app_dir: String,
  name: String,
) -> Result(String, Nil)

gear と認めた package の dir(入口の前段の第 75 条が "<gear>:<道>" の file を読む)。

pub fn gears(app_dir: String) -> List(Package)

gear と認める package:印があり、source が local か git で、読めたもの。

pub fn import_path(module: String) -> String

生成物が import する道(app の src/ からの、拡張子の無い道)。"<gear>:<道>" は gear の build の ../<gear>/<道>(src/gen/ の file から '../../<gear>/<道>.mjs')、それ以外は module のまま(生成物は今と 1 字も 変わらない)。

pub fn main() -> Nil
pub fn notes(app: model.App, app_dir: String) -> List(stop.Note)

第 53〜57・85・86 条。app_dir の lock の package を読み、gear に条文を当てる。app が "<gear>:<道>" で指す module にも 当てる(第 53・85 条)。gear を使わない app は []。

pub fn packages(app_dir: String) -> #(Bool, List(Package))

app の依存の package(lock があれば lock、無ければ gleam.toml の path を辿った閉包)。

pub fn reference(
  module: String,
) -> Result(#(String, String), Nil)

"<gear>:<道>" を #(gear, 道) に。: の無い module(app の src/ からの道)は Error(: は Gleam の module の道に 出ない字なので取り違えない)。

pub fn scan(text: String) -> List(Finding)

JS の字の走査(注釈と文字列の中身を外した字で読む)。

pub fn shell_modules(
  app: model.App,
  app_dir: String,
) -> List(#(String, String))

殻が import する gear の指し先ごとの module:#(指し先, "<gear>/<道>")(gear の名の順)。app の宣言した指し先の殻に だけ配る ── Workers の module は shell.mjs、Lambda の module は shell.lambda.mjs。指し先ごとの module は module の 上の段で gear の中の共有の file へ実装を渡す(app はその module を指さない ── 第 85 条)。

pub fn workers_parts(text: String) -> List(#(Int, String))

Workers の部品だけ(cloudflare:* の import を含む)を #(行, 字) で。app の ★ の警告(条でない exit 0 の行)が呼ぶ。

✨ Search Document