Overview Version History Q & A Rating & Review
Gherkin Support - VSCode拡張機能
Gherkinファイル(.feature
)のシンタックスハイライトと記述支援を提供するVSCode拡張機能です。日本語にも完全対応 しています。
機能
🎨 シンタックスハイライト
日本語・英語両対応のキーワードハイライト
コメント、タグ、文字列の色分け
データテーブルの見やすい表示
パラメータ(<param>
)の強調表示
📝 サポートされているGherkinキーワード
日本語
機能
/ フィーチャ
(Feature)
背景
(Background)
ルール
(Rule)
シナリオ
(Scenario)
シナリオアウトライン
/ シナリオテンプレート
/ テンプレ
/ シナリオテンプレ
(Scenario Outline)
例
/ サンプル
(Examples)
前提
(Given)
もし
(When)
ならば
(Then)
且つ
/ かつ
(And)
然し
/ しかし
/ 但し
/ ただし
(But)
英語
Feature
, Background
, Rule
, Scenario
, Scenario Outline
, Examples
Given
, When
, Then
, And
, But
インストール方法
このプロジェクトをクローン
git clone <このリポジトリのURL>
cd gherkin-support
依存関係をインストール
npm install
TypeScriptをコンパイル
npm run compile
VSCodeで開発版として実行
F5
キーを押して新しいVSCodeウィンドウを開く
または、コマンドパレット(Ctrl+Shift+P
)から Debug: Start Debugging
を実行
使用方法
.feature
ファイルを作成または開く
自動的にGherkin言語として認識され、シンタックスハイライトが適用される
日本語での記述例
# language: ja
@smoke
機能: ユーザーログイン
システムにログインできるようにしたい
背景:
前提 システムが起動している
シナリオ: 正常ログイン
前提 ユーザー "田中" が登録されている
もし ユーザー名 "tanaka" でログインする
ならば ログインが成功する
且つ ホーム画面が表示される
英語での記述例
# language: en
@smoke
Feature: User Login
As a user I want to login to the system
Background:
Given the system is running
Scenario: Successful login
Given user "Tanaka" is registered
When I login with username "tanaka"
Then login should be successful
And home page should be displayed
開発
ファイル構造
gherkin-support/
├── package.json # 拡張機能の設定
├── language-configuration.json # 言語設定
├── syntaxes/
│ └── gherkin.tmLanguage.json # シンタックスハイライト定義
├── src/
│ └── extension.ts # メインロジック
├── examples/
│ ├── sample-japanese.feature # 日本語サンプル
│ └── sample-english.feature # 英語サンプル
└── README.md
拡張機能のテスト
examples/
フォルダ内のサンプルファイルを開く
シンタックスハイライトが正しく適用されているか確認
今後の機能拡張予定
[ ] 自動補完機能
[ ] ステップ定義へのジャンプ機能
[ ] スニペット機能
[ ] 構文エラーの検出
[ ] フォーマッター機能
貢献
バグ報告や機能提案はIssueでお願いします。プルリクエストも歓迎します!
ライセンス
MIT License