모듈 퍼블리싱

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 유틸리티 및 헬퍼
license: MIT
repository: https://github.com/acme/http-utils
homepage: https://acme.dev
keywords:
  - http
  - utilities

엔트리 정의

엔트리는 _index.yaml에 정의됩니다:

version: "1.0"
namespace: acme.http

entries:
  - name: definition
    kind: ns.definition
    meta:
      title: HTTP 유틸리티
      description: HTTP 작업을 위한 헬퍼

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

의존성

다른 모듈에 대한 의존성 선언:

entries:
  - name: __dependency.wippy.test
    kind: ns.dependency
    meta:
      description: 테스팅 프레임워크
    component: wippy/test
    version: ">=0.3.0"

버전 제약:

요구사항

소비자가 제공해야 하는 설정 정의:

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

타겟은 값이 주입되는 위치를 지정합니다:

• entry - 설정할 전체 엔트리 ID
• path - 값 주입을 위한 JSONPath

소비자는 오버라이드로 설정합니다:

wippy run -o acme.http:api_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 클라이언트 계약
  methods:
    - name: get
      description: GET 요청 수행
    - name: post
      description: POST 요청 수행

- 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 "최초 릴리스"

퍼블리시된 모듈 사용

의존성 추가

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

요구사항 설정

런타임에 값 오버라이드:

wippy run -o acme.http:api_endpoint=https://my.api.com

또는 .wippy.yaml에서:

override:
  acme.http:api_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: TTL이 있는 인메모리 캐싱
license: MIT
keywords:
  - cache
  - memory

src/_index.yaml:

version: "1.0"
namespace: acme.cache

entries:
  - name: definition
    kind: ns.definition
    meta:
      title: 캐시 모듈

  - name: max_size
    kind: ns.requirement
    meta:
      description: 최대 캐시 항목 수
    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

참고

• CLI 참조
• 엔트리 종류
• 설정