Dart MCP

🚀 Dart MCP プロジェクトドキュメント

Dart MCP は、Dart 開発に関する一連の便利なツールを提供するプロジェクトです。このドキュメントでは、Dart MCP のインストール、使用方法、コマンドリファレンスなどについて詳しく説明します。

🚀 クイックスタート

Dart MCP を使用するには、まず Dart SDK をインストールする必要があります。インストールが完了したら、Dart MCP を使用して Dart プロジェクトを管理できます。

📦 インストール

Dart SDK のインストール

Dart MCP ツールを使用するには、まず Dart SDK をインストールする必要があります。お使いのオペレーティングシステムに応じて、適切なインストールパッケージを選択してください。

• Windows

  Dart Windows インストーラーをダウンロードして実行します。

• macOS

  以下のコマンドをターミナルで実行してインストールします。

  brew install dart --with-docs
  

• Linux

  以下のコマンドを使用してインストールします。

  sudo apt-get update && sudo apt-get install dart
  

インストールの確認

インストールが完了したら、以下のコマンドを使用して Dart が正しくインストールされていることを確認できます。

dart --version

以下のような情報が表示されれば、インストールは成功しています。

Dart SDK version: 3.0.1 (stable) (Thu Aug 24 13:58:50 GMT+7 2023)
Built by buildbot on Linux.

💻 使用例

基本的な使用法

ツールのインストール

dart-mcp install

ツールのアンインストール

dart-mcp uninstall

ヘルプ情報の取得

dart-mcp help

バージョンの確認

dart-mcp version

高度な使用法

コマンドリファレンス

以下は、Dart MCP がサポートするコマンドとその詳細な説明です。

dart-mcp config [options]

説明

Dart MCP ツールを構成します。

オプション

• --help：ヘルプ情報を表示します。
• -v, --version：現在のバージョン番号を表示します。
• --global：ツールチェーンをグローバルにインストールします（オプション）。

dart-mcp tools

説明

Dart ツールを管理します。

サブコマンド

dart-mcp tools list

インストールされている Dart ツールをリストします。

dart-mcp tools install [tool]

指定された Dart ツールをインストールします。

dart-mcp tools uninstall [tool]

指定された Dart ツールをアンインストールします。

dart-mcp package

説明

Dart パッケージ（Package）を管理します。

サブコマンド

dart-mcp package init

新しい Dart パッケージプロジェクトを初期化します。

dart-mcp package get

現在のプロジェクトの依存関係を取得します。

dart-mcp package upgrade

すべての依存関係を最新バージョンにアップグレードします。

dart-mcp package add [package]

指定された依存関係を追加します。

dart-mcp package remove [package]

指定された依存関係を削除します。

dart-mcp test

説明

Dart プロジェクトのテストを実行します。

オプション

• --coverage：コードカバレッジレポートを生成します。
• --name=TEST_TAG：タグで特定のテストケースを実行します。
• -v, --verbose：詳細モードを有効にし、より多くのログ情報を表示します。

📚 ドキュメント

型定義

Configuration クラス

class Configuration {
  final String name;
  final String version;
  
  const Configuration({
    required this.name,
    required this.version,
  });
}

説明

• name：プロジェクトの名前です。
• version：プロジェクトのバージョン番号です。

Command クラス

abstract class Command {
  /// コマンドを実行します。
  Future<void> execute();
}

🔧 技術詳細

コミット規則

以下の形式に従ってコードをコミットしてください。

タイプ(影響するモジュール): [ ISSUE番号 ] 説明情報

例：

• feat(tools): 新しいツールのサポートを追加します。
• fix(bug): 既知の問題を修正します。

コミットメッセージには、関連するリンク（PR ヒントや ISSUE リンクなど）を追加してください。

開発フロー

1. リポジトリのクローン

   git clone https://github.com/your-repository.git
   

2. 機能ブランチの作成

   git checkout -b feature/your-feature
   

3. コードのコミット

   git add .
   git commit -m "feat: 新しい機能を追加"
   

4. ブランチのプッシュと Pull Request の作成

   git push origin feature/your-feature
   

エラー処理

一般的な問題

1. インストール失敗

   • システムが最低要件を満たしていることを確認してください。
   • ネットワーク接続を確認し、外部リソースにアクセスできることを確認してください。

2. 依存関係の解決失敗

   • pubspec.yaml ファイルを確認し、依存関係のバージョンが正しいことを確認してください。
   • dart-mcp package get を使用して依存関係を更新してください。

3. テスト失敗

   • コンソール出力を確認し、具体的なエラー情報を取得してください。
   • すべての依存関係が正しくインストールされていることを確認してください。

プロジェクト規則

命名規則

以下の命名規則に従ってください。

• 変数名：camelCase を使用します。
• クラス名：PascalCase を使用します。
• メソッド名：lowerCamelCase を使用します。

コーディングスタイル

• Dart 公式のコーディング規約に従ってください。
• コードを簡潔に保ち、重複するコードを避けてください。
• 適切なコメントを追加し、可読性を向上させてください。

📄 ライセンス

Dart MCP プロジェクトは MIT ライセンスに従います。詳細な情報は LICENSE ファイルを参照してください。

🔗 連絡先

何か質問がある場合は、以下の方法で連絡してください。

• メール：contact@dartmcp.com
• GitHub：https://github.com/your-repository

Dart MCP プロジェクトへのご支援に感謝します！このドキュメントが、このツールの理解と使用に役立つことを願っています。