summaryrefslogtreecommitdiffhomepage
path: root/packages/opencode/src/plugin/loader.ts
blob: 0f6671ed5d0905cbad95cb509bed77cb0d29ef87 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
import { Config } from "@/config/config"
import { Installation } from "@/installation"
import {
  checkPluginCompatibility,
  createPluginEntry,
  isDeprecatedPlugin,
  resolvePluginTarget,
  type PluginKind,
  type PluginPackage,
  type PluginSource,
} from "./shared"

export namespace PluginLoader {
  export type Plan = {
    item: Config.PluginSpec
    spec: string
    options: Config.PluginOptions | undefined
    deprecated: boolean
  }

  export type Resolved = Plan & {
    source: PluginSource
    target: string
    entry: string
    pkg?: PluginPackage
  }

  export type Loaded = Resolved & {
    mod: Record<string, unknown>
  }

  export function plan(item: Config.PluginSpec): Plan {
    const spec = Config.pluginSpecifier(item)
    return {
      item,
      spec,
      options: Config.pluginOptions(item),
      deprecated: isDeprecatedPlugin(spec),
    }
  }

  export async function resolve(
    plan: Plan,
    kind: PluginKind,
  ): Promise<
    | { ok: true; value: Resolved }
    | { ok: false; stage: "missing"; message: string }
    | { ok: false; stage: "install" | "entry" | "compatibility"; error: unknown }
  > {
    let target = ""
    try {
      target = await resolvePluginTarget(plan.spec)
    } catch (error) {
      return {
        ok: false,
        stage: "install",
        error,
      }
    }
    if (!target) {
      return {
        ok: false,
        stage: "install",
        error: new Error(`Plugin ${plan.spec} target is empty`),
      }
    }

    let base
    try {
      base = await createPluginEntry(plan.spec, target, kind)
    } catch (error) {
      return {
        ok: false,
        stage: "entry",
        error,
      }
    }

    if (!base.entry) {
      return {
        ok: false,
        stage: "missing",
        message: `Plugin ${plan.spec} does not expose a ${kind} entrypoint`,
      }
    }

    if (base.source === "npm") {
      try {
        await checkPluginCompatibility(base.target, Installation.VERSION, base.pkg)
      } catch (error) {
        return {
          ok: false,
          stage: "compatibility",
          error,
        }
      }
    }

    return {
      ok: true,
      value: {
        ...plan,
        source: base.source,
        target: base.target,
        entry: base.entry,
        pkg: base.pkg,
      },
    }
  }

  export async function load(row: Resolved): Promise<{ ok: true; value: Loaded } | { ok: false; error: unknown }> {
    let mod
    try {
      mod = await import(row.entry)
    } catch (error) {
      return {
        ok: false,
        error,
      }
    }

    if (!mod) {
      return {
        ok: false,
        error: new Error(`Plugin ${row.spec} module is empty`),
      }
    }

    return {
      ok: true,
      value: {
        ...row,
        mod,
      },
    }
  }
}