🐼

Denops v8以降のプラグイン開発の注意点

に公開

Denopsはv8以降、依存管理が大きく改善された。
これにより、プラグインを作る際の構成が少し変わった。

本記事の内容はほぼ公式ドキュメントにある内容どおりだが、
「Denops v8以降に向けてプラグインを改修するなら、どう構成し、どう依存を管理すべきか」をシンプルにまとめたものである。

対象読者

  • 既存プラグインをv8以降の構成に整えたい人
  • import mapやWorkspaceの正しい使い方を知りたい人

Denops プラグインの基本構造(v8 以降の前提)

Denopsは (runtimepath)/denops/<plugin name>/main.ts をロードする。
そのため、プラグインは次の構造を取る必要がある。

my-denops-plugin/
├── deno.jsonc              # 開発用
└── denops/
    └── <plugin name>/
        ├── deno.jsonc      # プラグイン本体用
        └── main.ts
  • ルートのdeno.jsonc
    → Workspace(開発用設定)の指定やDenoのその他の設定
  • プラグイン本体用のdeno.jsonc (denops/<plugin name>/deno.jsonc)
    → import map(依存管理)の指定
  • denops/<plugin name>/main.ts
    → Denopsがロードするエントリポイント(プラグイン本体)

依存管理の標準:import map(v8 以降)

Denops v8以降はimport mapが公式にサポートされている。
依存はURL importではなく、import mapで管理するのが推奨されている。

プラグイン本体用の deno.jsonc

{
  "imports": {
    "@denops/std": "jsr:@denops/std@^8.0.0",
    "@core/unknownutil": "jsr:@core/unknownutil@^4.3.0"
  }
}

開発用の deno.jsonc(Workspace)の役割

ルートに置くdeno.jsoncはプラグイン開発者のための設定。通常のdeno projectと同様の内容を書くことになるが、
プラグイン本体のWorkspaceがどこにあるかを示すため、以下の通りWorkspaceを記載しておく。

例:ルートの deno.jsonc

{
    ...,
  "workspace": ["./denops/<plugin name>"],
    ...
}

既存プラグインを v8 以降に対応させる手順

迷ったのでメモ代わりに

1. ルートに Workspace を追加

{
    ...,
  "workspace": ["./denops/<plugin name>"],
    ...
}

2. プラグイン内部に import map 用の deno.jsonc を作成

依存をimport mapに移行する。

$ cd denops/<plugin name>
$ deno add jsr:@denops/std
...

deno addすると以下の通りdenops/<plugin name>配下にimport mapができる

{
  "imports": {
    "@denops/std": "jsr:@denops/std@^8.0.0",
    ...
  }
}

3. URL import を import map に書き換える

-import { Denops } from "jsr:@denops/std@3.12.0"
+import { Denops } from "@denops/std"

まとめ:v8 以降の Denops プラグイン開発の標準形

  • 依存管理はimport map(プラグイン本体用deno.jsoncに記載)を使う
  • ルートのdeno.jsoncにはWorkspaceとしてプラグイン本体のパスを指定する

Discussion