mcpField
W
worma-guidelines

worma-guidelines

github.com/alovajs開発568 回インストール17 週間前に更新
リポジトリ

worma-guidelines について

worma-guidelines は、OpenAPI コードジェネレーター worma の利用ガイドを案内するスキルです。設定、移行、コマンドライン、プラグインなどの手順を用途別に探せます。

主な機能

  1. 01用途別のドキュメント案内
  2. 02axios、ky、wormholeからの移行ガイド
  3. 03コマンドライン、テンプレート、プラグインの解説
  4. 04組み込みテンプレートとプラグインの紹介

活用シーン

  1. 01wormaプロジェクトの初期設定を調べる
  2. 02axiosまたはkyからの移行を計画する
  3. 03カスタムプラグインの追加方法を確認する
  4. 04APIコード生成の設定を調べる

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/alovajs/skills --skill worma-guidelines

インストール後、Claude Code で/worma-guidelinesを入力して読み込まれたか確認します。

同梱ファイルREADME.mdreferences/migration-wormhole.md

詳細

worma — ユニバーサル OpenAPI コードジェネレーター

ユーザーのニーズに合ったシナリオを選び、回答する前に、対応するドキュメントリンクから詳細情報を取得してください。

このドキュメントに該当するガイドがない場合は、worma のドキュメントインデックス https://worma.js.org/llms.txt を参照して、関連するガイドを探してください。

移行のきっかけとなるフレーズ

次のような質問には、このスキルを使用してください。

  • @alova/wormhole から worma に移行する
  • axios から worma に移行する
  • ky から worma に移行する
  • wormhole／axios／ky から worma に切り替える

シナリオ別ガイド

シナリオドキュメントリンク
初回セットアップ／インストールと設定インストールと設定
クイックスタートクイックスタート
axios からの移行Axios からの移行
ky からの移行Ky からの移行
CLI コマンド（init、gen など）CLI コマンド
カスタム Handlebars テンプレートの作成カスタムテンプレート
独自のプラグインの作成カスタムプラグイン / プラグイン API
プログラム APIコア関数 / 設定 API
AI スキルのドキュメントを生成AI スキル
VSCode 拡張機能エディターのドキュメント
モノレポのセットアップモノレポ
パフォーマンスの調整パフォーマンス

@alova/wormhole から worma への移行ワークフロー

→ references/migration-wormhole.md

定義済みテンプレート

worma には、alova、axios、fetch、ky などのリクエストライブラリ用テンプレートが付属しています。generator.plugins で使用すると、API コードの生成方法を制御できます。

→ 使い方、オプション、例については、定義済みテンプレートをご覧ください。

alova テンプレートを使用していますか？ クライアント／サーバー API の活用方法に関するガイダンスを強化するには、alova のスキルをインストールしてください。

npx skills add https://github.com/alovajs/skills --skill alova-client-usage
npx skills add alovajs/skills --skill alova-server-usage

定義済みプラグイン

生成パイプラインをカスタマイズするには、これらのプラグインをgenerator.pluginsに追加してください。

PluginDescriptionDocs
aiDoc()コーディングアシスタント向けの、AI が読み取れるインターフェースドキュメントを生成します。aiDoc
platform()Swagger、Knife4j、FastAPI、YApi 用の OpenAPI URL を自動で組み立てます。platform
apifox()Apifox から OpenAPI ドキュメントを直接インポートします。apifox
rename()API の URL とパラメーターの名前を変更／変換します。rename
tagModifier()OpenAPI 仕様の API のtagsを変更します。tagModifier
payloadModifier()リクエスト／レスポンスのパラメーターの型を追加、削除、変更します。payloadModifier
filterApi()一致ルールに基づいて、URL またはタグで API をフィルタリングします。filterApi
importType()外部の型を再利用し、自動生成された型を除外します。importType

→ 共通の使用パターンや詳細については、組み込みプラグインの概要をご覧ください。

コメント

Markdown 対応