Snippy

🚀 Snippy

このプロジェクトは、Microsoft Azure をベースに構築されたコードスニペット管理ツールです。ユーザーは以下の機能を通じてコードスニペットを管理および操作できます。

• 選択したコードスニペットをクラウドストレージに保存する。
• 名前で検索し、保存されたコードスニペットを表示する。
• 保存されたコードスニペットから自動的にプロジェクトのWikiとコードスタイルガイドを生成する。

🚀 クイックスタート

ローカルデプロイ

1. 環境準備：
   • Docker をインストールします（ローカル開発用）。
   • Azurite と Cosmos Emulator をインストールします（クラウドサービスをシミュレートするため）。
2. コードリポジトリのクローン：

   git clone https://github.com/Azure-Samples/snippy.git
   cd snippy
   

3. ローカル環境変数の設定：
   • local.settings.json ファイルを作成し、以下の内容を記述します（実際の状況に合わせてプレースホルダーを修正）。

     {
       "COSMOS_CONN": "<あなたのCosmos接続文字列>",
       "AZURE_OPENAI_ENDPOINT": "<あなたのOpenAIエンドポイント>",
       "AZURE_OPENAI_KEY": "<あなたのOpenAIキー>",
       "PROJECT_CONNECTION_STRING": "<あなたのプロジェクト接続文字列>"
     }
     

4. ローカルサービスの起動：

   func start
   

   サービスは http://localhost:7071 で実行されます。

クイックデプロイ

Codespacesを使用する

以下の手順で Codespaces 上でプロジェクトを実行できます。

1. プロジェクトリポジトリ Snippy を開きます。
2. 「Code」ボタンをクリックし、「Open in Codespace」を選択します。

✨ 主な機能

1. コードスニペットの保存：選択したコードスニペットをクラウドストレージに保存します。
2. コードスニペットの表示：名前で検索し、保存されたコードスニペットを表示します。
3. ドキュメントの生成：保存されたコードスニペットから自動的にプロジェクトのWikiとコードスタイルガイドを生成します。

📦 インストール

ローカルデプロイ

1. 環境準備：
   • Docker をインストールします（ローカル開発用）。
   • Azurite と Cosmos Emulator をインストールします（クラウドサービスをシミュレートするため）。
2. コードリポジトリのクローン：

   git clone https://github.com/Azure-Samples/snippy.git
   cd snippy
   

3. ローカル環境変数の設定：
   • local.settings.json ファイルを作成し、以下の内容を記述します（実際の状況に合わせてプレースホルダーを修正）。

     {
       "COSMOS_CONN": "<あなたのCosmos接続文字列>",
       "AZURE_OPENAI_ENDPOINT": "<あなたのOpenAIエンドポイント>",
       "AZURE_OPENAI_KEY": "<あなたのOpenAIキー>",
       "PROJECT_CONNECTION_STRING": "<あなたのプロジェクト接続文字列>"
     }
     

4. ローカルサービスの起動：

   func start
   

   サービスは http://localhost:7071 で実行されます。

💻 使用例

コードスニペットの保存

以下のコマンドでコードスニペットをクラウドストレージに保存します。

curl -X POST "http://localhost:7071/api/snippets" \
-H "Content-Type: text/plain" \
-d "<あなたのコードスニペット>"

コードスニペットの表示

以下のコマンドで指定した名前のコードスニペットを取得します。

curl "http://localhost:7071/api/snippets/<スニペット名>" 

ドキュメントの生成

Wikiの生成

以下のコマンドでプロジェクトのWikiを生成します。

curl -X POST "http://localhost:7071/api/snippets/wiki" \
-H "Content-Type: application/json" \
-d '{"title":"<あなたのタイトル>", "content":"<あなたの内容>"}'

コードスタイルガイドの生成

以下のコマンドでコードスタイルガイドを生成します。

curl -X POST "http://localhost:7173/api/snippets/code-style" \
-H "Content-Type: application/json" \
-d '{"language":"<言語>", "styles":"<スタイルの説明>"}'

📚 ドキュメント

MCP設定

mcp.json のクイック作成

mkdir -p .vscode && cat > .vscode/mcp.json <<'EOF'
{
  "inputs": [
    {
      "type": "promptString",
      "id": "functions-mcp-extension-system-key",
      "description": "Azure Functions MCPシステムキー",
      "password": true
    },
    {
      "type": "promptString",
      "id": "functionapp-name",
      "description": "デプロイする関数アプリの名前"
    }
  ],
  "servers": {
    "local-snippy": {
      "type": "sse",
      "url": "http://localhost:7071/runtime/webhooks/mcp/sse"
    },
    "remote-snippy": {
      "type": "sse",
      "url": "https://${input:functionapp-name}.azurewebsites.net/runtime/webhooks/mcp/sse",
      "headers": { "x-functions-key": "${input:functions-mcp-extension-system-key}" }
    }
  }
}
EOF

システムキーを取得するには、以下のコマンドを実行します。

az functionapp keys list -g <リソースグループ名> -n <関数アプリ名> --query [0].value

貢献ガイド

貢献の方法

1. このプロジェクトのリポジトリをForkします。
2. 自分のブランチで変更を加えます。
3. 変更をコミットし、Pull Requestを作成します。

コード規約

• Microsoft Azureのコード規約 に従います。
• コードを簡潔で保守しやすいものに保ちます。

サポートとフィードバック

問題報告

問題や提案がある場合は、GitHubリポジトリでIssuesを作成してください。 Snippy Issues

コミュニティサポート

Discordコミュニティ に参加し、他の開発者と経験を共有しましょう。

🔧 技術詳細

主要コンポーネント

1. Azure Functions：RESTful APIインターフェースを実装し、ユーザーのリクエストを処理します。
2. Durable Functions：非同期タスクの処理（ドキュメント生成など）に使用されます。
3. Cosmos DB：コードスニペットとメタデータを保存するためのストレージバックエンドです。
4. OpenAI Integration：OpenAI APIを統合し、自然言語テキスト（Wikiやスタイルガイドなど）を生成します。

コア機能

コードスニペット管理

• APIエンドポイント: /api/snippets
  • POST: 新しいコードスニペットをアップロードします。
  • GET/{name}: 指定した名前のコードスニペットを取得します。

ドキュメント生成

• APIエンドポイント: /api/snippets/wiki と /api/snippets/code-style
  • POST: それぞれプロジェクトのWikiとコードスタイルガイドを生成します。

📄 ライセンス

このプロジェクトは MIT License の下でライセンスされています。