0
1

Github Copilot mdファイルのコーディング規約に基づいてレビューする

Last updated at Posted at 2024-09-20

概要

github copilotでリポジトリ内のコーディング規約を読ませて、ソースをレビューできるか試してみました。結果はきっちりレビューしてくれました。

検証開発環境 

javascript
HTML
github codespaces(ブラウザで動かす方)

準備

コーディング規約

ルールは以下の通り
変数の記法はアッパーキャメル記法
配列のfor文は for ofを使う
if文は比較したい変数は比較演算子の左側に書く

詳細の形式はgithub参照
https://github.com/RYA234/laravel9_vite_vue3/blob/master/review_test/javascritpt_rule.md

レビュー前のファイル

適当です

main.html
<script>
	let aCompany_printers_Number = new Array();
	aCompany_printers_Number.push(5);
	aCompany_printers_Number.push(1000);

	for (let i = 0; i < aCompany_printers_Number.length; i++) {
		if (10 < aCompany_printers_Number[i]) {
			console.log(aCompany_printers_Number[i])
		}
	}

</script>

操作方法

ファイルをチャットに追加

ファイルを開く。エディター上で右クリックして以下操作を実行。
「Copilot」→「ファイルをチャットに追加」を選択
{569B519F-3190-4CC5-8609-882173F63506}.png

チャットでメッセージを送信

以下内容を送信
「review_test/main.htmlをreview_test/javascript_rule.mdに基づいてレビューしてください。」
{9426811C-16D1-4623-8979-0A5586F693D6}.png

結果

項目名 結果 備考
変数の記法 文頭のa(Array)だけが残った
for文
if文

{89561634-954E-43A1-A765-954B6A34432B}.png

レビュー後のファイル

ファイル名は自分で変えました。

review_after.html
<script>
    let ACompanyPrintersNumber = [];
    ACompanyPrintersNumber.push(5);
    ACompanyPrintersNumber.push(1000);

    for (let printer of ACompanyPrintersNumber) {
        if (printer > 10) {
            console.log(printer);
        }
    }

</script>

感想

割と満足した結果ですね。実案件でも使えそうな印象を受けました。
短時間でチェック漏れを探せるところが良いと思いました。

参考リンク

変数の記法について
https://blog.e2info.co.jp/2015/09/24/namingrules/

配列のfor文について
https://qiita.com/redrabbit1104/items/40f3e2aa6cd4361150ee

if文について
https://qiita.com/Nossa/items/3fb1f1e4c429cacd3365

githubコミット分
https://github.com/RYA234/laravel9_vite_vue3/commit/0363936989ef91598bcbf0d2983c5818d43bb1a2

0
1
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
1