モジュールの公開

再利用可能なコードを Wippy Hub で共有します。

前提条件

  1. hub.wippy.ai でアカウントを作成する
  2. 組織を作成するか、既存の組織に参加する
  3. 組織内でモジュール名を登録する

モジュール構造

mymodule/
├── wippy.yaml      # モジュールマニフェスト
├── src/
│   ├── _index.yaml # エントリ定義
│   └── *.lua       # ソースファイル
└── README.md       # ドキュメント（任意）

wippy.yaml

モジュールマニフェスト：

organization: acme
module: http-utils
description: HTTP utilities and helpers
license: MIT
repository: https://github.com/acme/http-utils
homepage: https://acme.dev
keywords:
  - http
  - utilities
フィールド 必須 説明
organization はい Hub 上の組織名
module はい モジュール名
description いいえ 短い説明
license いいえ SPDX 識別子（MIT、Apache-2.0）
repository いいえ ソースリポジトリ URL
homepage いいえ プロジェクトホームページ
keywords いいえ 検索キーワード

エントリ定義

エントリは _index.yaml で定義します：

version: "1.0"
namespace: acme.http

entries:
  - name: definition
    kind: ns.definition
    meta:
      title: HTTP Utilities
      description: Helpers for HTTP operations

  - name: client
    kind: library.lua
    source: file://client.lua
    modules:
      - http_client
      - json

依存関係

他のモジュールへの依存関係を宣言します：

entries:
  - name: __dependency.wippy.test
    kind: ns.dependency
    meta:
      description: Testing framework
    component: wippy/test
    version: ">=0.3.0"

バージョン制約：

制約 意味
* 任意のバージョン
1.0.0 厳密なバージョン
>=1.0.0 最小バージョン
^1.0.0 互換性あり（同じメジャーバージョン）

要件

利用者が指定する必要のある設定を定義します：

entries:
  - name: api_endpoint
    kind: ns.requirement
    meta:
      description: API endpoint URL
    targets:
      - entry: acme.http:client
        path: ".meta.endpoint"
    default: "https://api.example.com"

ターゲットは値が注入される場所を指定します：

  • entry - 設定対象のエントリ ID
  • path - 値を注入する JSONPath

利用者はオーバーライドで設定します。-o フラグは namespace:entry:field=value のトリプルを受け取ります：

wippy run -o acme.http:client:meta.endpoint=https://custom.api.com

インポート

他のエントリを参照します：

- name: handler
  kind: function.lua
  source: file://handler.lua
  modules:
    - json
  imports:
    client: acme.http:client           # 同じ名前空間
    utils: acme.utils:helpers          # 異なる名前空間
    base_registry: :registry           # 組み込み

Lua 内：

local client = require("client")
local utils = require("utils")

コントラクト

公開インターフェースを定義します：

- name: http_contract
  kind: contract.definition
  meta:
    name: HTTP Client Contract
  methods:
    - name: get
      description: Perform GET request
    - name: post
      description: Perform POST request

- name: http_contract_binding
  kind: contract.binding
  contracts:
    - contract: acme.http:http_contract
      methods:
        get: acme.http:get_handler
        post: acme.http:post_handler

公開ワークフロー

1. 認証

wippy auth login

2. 準備

wippy init
wippy update
wippy lint

3. 検証

wippy publish --dry-run

4. 公開

wippy publish --version 1.0.0

リリースノート付き：

wippy publish --version 1.0.0 --release-notes "Initial release"

追加フラグ

フラグ 説明
--label <name> イミュータブルなバージョンの代わりに、可変ラベル（例：latest、beta）として公開する
--protected 公開バージョンを保護対象としてマークする（削除や上書きが不可になる）
--registry <url> この公開時のみレジストリ URL を上書きする
--config <dir> wippy.yaml を含むディレクトリ（デフォルト：カレントディレクトリ）

静的ファイルの埋め込み

fs.directory エントリ（静的アセット、テンプレート、公開ファイル）を含むモジュールは、それらを公開パッケージに含めるために --embed を使用する必要があります。これがない場合、fs.directory エントリは除外されます。

wippy publish --version 1.0.0 --embed app:public_files
wippy publish --version 1.0.0 --embed app:assets,app:templates

--embed フラグは、エントリ ID または fs.directory エントリに一致する名前を受け取ります。同じフラグは wippy pack でも利用できます。

公開モジュールの利用

依存関係の追加

wippy add acme/http-utils
wippy add acme/http-utils@1.0.0
wippy install

要件の設定

ランタイム時に値をオーバーライドします：

wippy run -o acme.http:client:meta.endpoint=https://my.api.com

または .wippy.yaml 内：

override:
  acme.http:client:meta.endpoint: "https://my.api.com"

コードでのインポート

# your src/_index.yaml
entries:
  - name: __dependency.acme.http
    kind: ns.dependency
    component: acme/http-utils
    version: ">=1.0.0"

  - name: my_handler
    kind: function.lua
    source: file://handler.lua
    imports:
      http: acme.http:client

完全な例

wippy.yaml:

organization: acme
module: cache
description: In-memory caching with TTL
license: MIT
keywords:
  - cache
  - memory

src/_index.yaml:

version: "1.0"
namespace: acme.cache

entries:
  - name: definition
    kind: ns.definition
    meta:
      title: Cache Module

  - name: max_size
    kind: ns.requirement
    meta:
      description: Maximum cache entries
    targets:
      - entry: acme.cache:cache
        path: ".meta.max_size"
    default: "1000"

  - name: cache
    kind: library.lua
    meta:
      max_size: 1000
    source: file://cache.lua
    modules:
      - time

src/cache.lua:

local time = require("time")

local cache = {}
local store = {}
local max_size = 1000

function cache.set(key, value, ttl)
    if #store >= max_size then
        cache.evict_oldest()
    end
    store[key] = {
        value = value,
        expires = ttl and (time.now():unix() + ttl) or nil
    }
end

function cache.get(key)
    local entry = store[key]
    if not entry then return nil end
    if entry.expires and time.now():unix() > entry.expires then
        store[key] = nil
        return nil
    end
    return entry.value
end

return cache

公開：

wippy init && wippy update && wippy lint
wippy publish --version 1.0.0

関連項目