VSCode Extension ja - Tai-Kimura/SwiftJsonUI GitHub Wiki

SwiftJsonUI VSCode拡張機能

SwiftJsonUIは、SwiftJsonUI JSONファイルを扱う際の開発体験を向上させる公式Visual Studio Code拡張機能を提供しています。

インストール

SwiftJsonUI Helper拡張機能は以下からインストールできます：

機能

1. JSONスキーマ検証

.jsonファイルに対して自動的にJSON検証を提供し、JSON構造が有効でSwiftJsonUIのスキーマに従っていることを保証します。

2. IntelliSenseと自動補完

以下の項目に対するインテリジェントなコード補完の提案を取得：

  • コンポーネントタイプ（View、Label、Buttonなど）
  • 属性とプロパティ
  • 有効な属性値
  • ネストされた構造

3. テンプレート挿入

一般的なSwiftJsonUIコンポーネントの事前設定されたテンプレートを素早く挿入：

コンポーネント コマンド キーボードショートカット
View SwiftJsonUI: Insert View Template Cmd+Shift+V (Mac) / Ctrl+Shift+V (Win/Linux)
Label SwiftJsonUI: Insert Label Template Cmd+Shift+L (Mac) / Ctrl+Shift+L (Win/Linux)
Button SwiftJsonUI: Insert Button Template Cmd+Shift+B (Mac) / Ctrl+Shift+B (Win/Linux)
TextField SwiftJsonUI: Insert TextField Template -
ScrollView SwiftJsonUI: Insert ScrollView Template Cmd+Shift+S (Mac) / Ctrl+Shift+S (Win/Linux)
SafeAreaView SwiftJsonUI: Insert SafeAreaView Template Cmd+Shift+A (Mac) / Ctrl+Shift+A (Win/Linux)
SafeAreaView with Scroll SwiftJsonUI: Insert SafeAreaView with Scroll Template Cmd+Shift+X (Mac) / Ctrl+Shift+X (Win/Linux)
Collection SwiftJsonUI: Insert Collection Template Cmd+Shift+C (Mac) / Ctrl+Shift+C (Win/Linux)

4. 言語サポート

拡張機能は標準の.jsonファイルで動作し、以下を提供：

  • 標準的なJSONシンタックスハイライト
  • ブラケットマッチングと自動クローズ
  • 大きなJSONファイルでのナビゲーション向上のためのコードフォールディング

使い方

新しいSwiftJsonUIファイルの作成

  1. .json拡張子で新しいファイルを作成
  2. 拡張機能が自動的にアクティブになり、IntelliSenseサポートを提供
  3. キーボードショートカットまたはコマンドパレットを使用してテンプレートを挿入

テンプレートの使用

  1. .jsonファイルを開く
  2. 上記のキーボードショートカットのいずれかを使用、または
  3. コマンドパレットを開く（Cmd+Shift+P / Ctrl+Shift+P）
  4. 「SwiftJsonUI」を検索して利用可能なすべてのテンプレートコマンドを表示
  5. カーソル位置に挿入したいテンプレートを選択

ワークフローの例

// 1. 新しいファイルを作成: myscreen.json
// 2. Cmd+Shift+Aを押してSafeAreaViewテンプレートを挿入
// 3. 拡張機能が基本構造を挿入：
{
  "type": "SafeAreaView",
  "backgroundColor": "#FFFFFF",
  "views": [
    // ここにコンテンツを追加
  ]
}

設定

拡張機能は適切なデフォルト設定ですぐに動作します。以下の場合に自動的にアクティブになります：

  • .jsonファイルを開いたとき
  • SwiftJsonUI構造を含むJSONファイルで作業するとき

必要要件

  • Visual Studio Codeバージョン1.103.0以上
  • iOS/AndroidプロジェクトのSwiftJsonUIライブラリ

メリット

  1. 高速な開発: クイックテンプレート挿入と自動補完により入力を削減
  2. エラーの削減: JSON検証により実行時前に構文エラーをキャッチ
  3. より良いドキュメント: IntelliSenseが属性のインラインドキュメントを提供
  4. 生産性の向上: キーボードショートカットが一般的なタスクを効率化
  5. 一貫性のあるコード: テンプレートがプロジェクト全体で一貫した構造を保証

トラブルシューティング

拡張機能がアクティブにならない

  • ファイルが.json拡張子を持っていることを確認
  • 拡張機能はすべての標準JSONファイルで動作します

IntelliSenseが機能しない

  • ファイルが正しい拡張子で保存されていることを確認
  • 拡張機能をインストールしたばかりの場合はVSCodeを再起動

テンプレートが挿入されない

  • カーソルがテンプレートを挿入したい位置にあることを確認
  • .jsonファイル内にいることを確認（キーボードショートカットに必要）

貢献

拡張機能はオープンソースで、貢献を歓迎します：

バージョン履歴

現在のバージョン: 1.7.0

拡張機能は、新機能とコンポーネントとの互換性を確保するため、SwiftJsonUIライブラリのリリースと並行して積極的にメンテナンスおよび更新されています。

関連リソース