[feat] Review according to own guide

[baseballyama]

No description provided.

[github-actions]

import文の型指定がありません。型指定を追加してください。

[github-actions]

関数addの引数xとyに明示的な型を指定してください。

[github-actions]

関数buildPromptの引数ruleに型を指定しましょう。

[github-actions]

非同期操作の取り扱いに関するコーディングガイドに従っていません。Promiseチェーンを使用していますが、async/awaitパターンを使用するように改善してください。

[github-actions]

関数readRulesに明示的な型を指定しましょう。

[github-actions]

関数の引数と戻り値に明示的な型を指定しましょう。

[github-actions]

import文の型指定がありません。型指定を追加してください。

Reference: ## 型定義の適用

[github-actions]

関数addの引数xとyに明示的な型を指定してください。

Reference: ## 型定義の適用

[github-actions]

コーディングガイドが記載されていません。コーディングガイドを記載する必要があります。

Reference: ## 非同期操作の取り扱い

[github-actions]

コーディングガイドに従っていません。コーディングガイドに従っているかどうかを判断するためのコメントが必要です。

Reference: ## 非同期操作の取り扱い

[github-actions]

非同期操作の取り扱いのコーディングガイドに従っていません。async/awaitパターンを使用して非同期操作を実装する必要があります。

Reference: ## 非同期操作の取り扱い

[github-actions]

非同期操作の取り扱いに関するコーディングガイドに従っていません。非同期操作はasync/awaitパターンを使用して実装する必要がありますが、80行目から86行目ではPromiseチェーンを使用しています。async/awaitパターンに書き換える必要があります。

Reference: ## 非同期操作の取り扱い

[github-actions]

関数の引数と戻り値に明示的な型を指定しましょう。

Reference: ## 型定義の適用

[github-actions]

関数内の非同期処理をPromise.allで実行するように修正しましょう。

Reference: ## 型定義の適用

[github-actions]

関数readRulesに明示的な型を指定しましょう。

Reference: ## 型定義の適用

[github-actions]

import文の順番が間違っています。node:fsモジュールは先にインポートする必要があります。

Reference: ## 非同期操作の取り扱い

[github-actions]

import文の型指定がありません。型指定を追加してください。

Reference: ## 型定義の適用

[github-actions]

関数の引数と戻り値に明示的な型を指定しましょう。

Reference: ## 型定義の適用

[github-actions]

buildPrompt関数の中でprompt.replaceを使用しているが、promptの中には{{CODING_GUIDE}}が含まれていないため、置換が行われない可能性がある。promptの中に{{CODING_GUIDE}}が含まれていることを確認する必要があります。

Reference: ## 非同期操作の取り扱い

[github-actions]

コーディングガイドに従っていません。コーディングガイドでは非同期操作はasync/awaitパターンを使用するように指示されていますが、このコードではimport文が使用されています。import文は非同期操作ではないため、async/awaitパターンを使用する必要があります。

Reference: ## 非同期操作の取り扱い

[github-actions]

関数buildPromptの引数ruleに型が指定されていません。ruleは文字列として扱われているので、型をstringとして明示してください。

Reference: ## 型定義の適用

[github-actions]

関数readRulesの戻り値に型が指定されていません。この関数は文字列の配列を返しているので、戻り値の型をstring[]として明示してください。

Reference: ## 型定義の適用

[github-actions]

この部分のコードでは、ファイルの読み込みやMarkdownのパースなど非同期操作が含まれていますが、これらの操作はasync/awaitパターンを使用して実装するべきです。現在のコードでは同期的なファイル読み込み関数readFileSyncが使用されていますが、これを非同期のreadFileに変更し、関数readRulesを非同期関数に変更することを推奨します。

改善後のコードは以下のようになります。

const readRules = async () => {
  const getRule = (node: MarkdownSectionNode) => {
    let rule = `${node.title}\n\n${node.content}`;
    if (node.children.length > 0) {
      for (const child of node.children) {
        rule += getRule(child);
      }
    }
    return rule;
  };

  const markdown = await fs.promises.readFile("GUIDE.md", "utf-8");
  const parsed = parseMarkdown(markdown);
  const rules: string[] = [];
  for (const level1 of parsed.children) {
    for (const level2 of level1.children) {
      const rule = getRule(level2);
      if (rule.match(/AI Review.*ON/g)) {
        rules.push(getRule(level2));
      }
    }
  }
  return rules;
};

ここではfs.promises.readFileを使用してファイルを非同期に読み込んでいます。また、関数readRulesは非同期関数として定義されているため、この関数を呼び出す際にはawaitを使用する必要があります。

Reference: ## 非同期操作の取り扱い

[github-actions]

関数 buildPrompt の引数 rule に型が指定されていません。rule は文字列として扱われているので、型を string として明示的に指定してください。

Reference: ## 型定義の適用

[github-actions]

関数 getRule の引数 node と戻り値に型が指定されていません。node の型と getRule の戻り値の型を明示的に指定してください。

Reference: ## 型定義の適用

[github-actions]

関数 splitComments の引数 response と戻り値に型が指定されていません。response は文字列として扱われているので、型を string として明示的に指定してください。また、この関数はオブジェクトの配列を返しているので、戻り値の型を { start: number; end: number; comment: string }[] として明示的に指定してください。

Reference: ## 型定義の適用

[github-actions]

関数 readRules の戻り値に型が指定されていません。この関数は文字列の配列を返しているので、戻り値の型を string[] として明示的に指定してください。

Reference: ## 型定義の適用

[github-actions]

関数readRulesの戻り値に型が指定されていません。この関数は文字列の配列を返しているので、戻り値の型をstring[]と明示してください。

Reference: ## 型定義の適用

,,,| Meta | Content |,| --------- | ------------------------------------------------------------------ |,| Level | 必須 |,| Link | https://www.typescriptlang.org/docs/handbook/2/everyday-types.html |,| AI Review | ON |,### 説明,,,,全ての変数、関数の引数、および戻り値には明示的な型またはインターフェースを指定すること。,### 理由,,,,型を明示的に宣言することで、コンパイル時の型チェックの恩恵を受けられ、ランタイムエラーのリスクを減らします。また、コードの意図が明確になり、他の開発者がコードを理解しやすくなります。,### 例,,,,```typescript,// 良いコードの例,function add(x: number, y: number): number {, return x + y;,},,// 悪いコードの例,function add(x, y) {, return x + y;,},```,### 例外ケース,,,,- ライブラリが提供する関数や変数の型が any である場合は、適宜型アサーションを使用する。,### リファクタリングガイドライン,,,,既存のコードでは、任意の型が使われていた場合、それを具体的な型に置き換えていく。新規コードでは初めから型を適用する。,,---,

[github-actions]

関数buildPromptの引数ruleに型が指定されていません。ruleは文字列として扱われているので、型をstringと明示してください。

Reference: ## 型定義の適用

,,,| Meta | Content |,| --------- | ------------------------------------------------------------------ |,| Level | 必須 |,| Link | https://www.typescriptlang.org/docs/handbook/2/everyday-types.html |,| AI Review | ON |,### 説明,,,,全ての変数、関数の引数、および戻り値には明示的な型またはインターフェースを指定すること。,### 理由,,,,型を明示的に宣言することで、コンパイル時の型チェックの恩恵を受けられ、ランタイムエラーのリスクを減らします。また、コードの意図が明確になり、他の開発者がコードを理解しやすくなります。,### 例,,,,```typescript,// 良いコードの例,function add(x: number, y: number): number {, return x + y;,},,// 悪いコードの例,function add(x, y) {, return x + y;,},```,### 例外ケース,,,,- ライブラリが提供する関数や変数の型が any である場合は、適宜型アサーションを使用する。,### リファクタリングガイドライン,,,,既存のコードでは、任意の型が使われていた場合、それを具体的な型に置き換えていく。新規コードでは初めから型を適用する。,,---,

[github-actions]

関数splitCommentsの引数responseと戻り値に型が指定されていません。responseは文字列として扱われているので、型をstringと明示してください。また、この関数はオブジェクトの配列を返しているので、戻り値の型を{ start: number; end: number; comment: string }[]と明示してください。

Reference: ## 型定義の適用

,,,| Meta | Content |,| --------- | ------------------------------------------------------------------ |,| Level | 必須 |,| Link | https://www.typescriptlang.org/docs/handbook/2/everyday-types.html |,| AI Review | ON |,### 説明,,,,全ての変数、関数の引数、および戻り値には明示的な型またはインターフェースを指定すること。,### 理由,,,,型を明示的に宣言することで、コンパイル時の型チェックの恩恵を受けられ、ランタイムエラーのリスクを減らします。また、コードの意図が明確になり、他の開発者がコードを理解しやすくなります。,### 例,,,,```typescript,// 良いコードの例,function add(x: number, y: number): number {, return x + y;,},,// 悪いコードの例,function add(x, y) {, return x + y;,},```,### 例外ケース,,,,- ライブラリが提供する関数や変数の型が any である場合は、適宜型アサーションを使用する。,### リファクタリングガイドライン,,,,既存のコードでは、任意の型が使われていた場合、それを具体的な型に置き換えていく。新規コードでは初めから型を適用する。,,---,

[github-actions]

ここでは非同期操作が行われていますが、async/awaitパターンが使用されていません。コーディングガイドに従って、非同期操作はasync/awaitパターンを使用して実装するように改善してください。

例えば、以下のように修正できます。

async function splitComments() {
  try {
    const response = await fetchResponse();
    const lines = response.match(/.*?((#+)?\s*改善点[\s\S]*)/m)?.[0].split("\n") ?? [];
    // 以下、同様の処理を続ける
  } catch (error) {
    throw new Error(error);
  }
}

ここで、fetchResponse()は非同期でレスポンスを取得する関数とします。

Reference: ## 非同期操作の取り扱い

,,,| Meta | Content |,| --------- | ------------------------------------------------------------------------------------------- |,| Level | 必須 |,| Link | https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function |,| AI Review | ON |,### 説明,,,,非同期操作は`async/await`パターンを使用して実装すること。コールバックや`.then()`、`.catch()`メソッドを用いた Promise チェーンは避ける。,### 理由,,,,`async/await`は非同期コードをより読みやすく、同期的な流れで記述できるためです。コードの可読性とメンテナンス性が向上します。,### 例,,,,```typescript,// 良いコードの例,async function getUser(id: string): Promise {, try {, const response = await fetch(`/api/users/${id}`);, const user = await response.json();, return user;, } catch (error) {, throw new Error(error);, },},,// 悪いコードの例,function getUser(id: string): Promise {, return fetch(`/api/users/${id}`), .then((response) => response.json()), .then((user) => user), .catch((error) => {, throw new Error(error);, });,},```,### 例外ケース,,,,- 既存のコードベースで`Promise`チェーンが広範に使用されている場合は、段階的に`async/await`にリファクタリングする。,### リファクタリングガイドライン,,,,新規プロジェクトや新規機能では`async/await`を用いること。既存のコードは、重要なバグ修正や機能追加の際に、この新しいパターンに徐々に置き換えていく。,

[github-actions]

この部分のコードでは、ファイルを読み込むためにreadFileSyncを使用していますが、これは同期的な操作です。非同期操作の取り扱いに関するコーディングガイドに従うためには、readFileを使用し、その結果をawaitで待つように変更するべきです。また、そのためにはreadRules関数を非同期関数（async function）にする必要があります。

以下に改善後のコードを示します。

const readRules = async () => {
  const getRule = (node: MarkdownSectionNode) => {
    let rule = `${node.title}\n\n${node.content}`;
    if (node.children.length > 0) {
      for (const child of node.children) {
        rule += getRule(child);
      }
    }
    return rule;
  };

  const markdown = await fs.promises.readFile("GUIDE.md", "utf-8");
  const parsed = parseMarkdown(markdown);
  const rules: string[] = [];
  for (const level1 of parsed.children) {
    for (const level2 of level1.children) {
      const rule = getRule(level2);
      if (rule.match(/AI Review.*ON/g)) {
        rules.push(getRule(level2));
      }
    }
  }
  return rules;
};

この変更により、ファイルの読み込みが非同期になり、他の操作がブロックされることなく実行できるようになります。

Reference: ## 非同期操作の取り扱い

Meta	Content
Level	必須
Link	https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function
AI Review	ON

説明

非同期操作はasync/awaitパターンを使用して実装すること。コールバックや.then()、.catch()メソッドを用いた Promise チェーンは避ける。

理由

async/awaitは非同期コードをより読みやすく、同期的な流れで記述できるためです。コードの可読性とメンテナンス性が向上します。

例

// 良いコードの例
async function getUser(id: string): Promise<User> {
  try {
    const response = await fetch(`/api/users/${id}`);
    const user = await response.json();
    return user;
  } catch (error) {
    throw new Error(error);
  }
}

// 悪いコードの例
function getUser(id: string): Promise<User> {
  return fetch(`/api/users/${id}`)
    .then((response) => response.json())
    .then((user) => user)
    .catch((error) => {
      throw new Error(error);
    });
}

例外ケース

• 既存のコードベースでPromiseチェーンが広範に使用されている場合は、段階的にasync/awaitにリファクタリングする。

リファクタリングガイドライン

新規プロジェクトや新規機能ではasync/awaitを用いること。既存のコードは、重要なバグ修正や機能追加の際に、この新しいパターンに徐々に置き換えていく。

[github-actions]

関数readRulesの戻り値に型が指定されていません。この関数は文字列の配列を返しているので、戻り値の型をstring[]と明示してください。

Reference: ## 型定義の適用

Meta	Content
Level	必須
Link	https://www.typescriptlang.org/docs/handbook/2/everyday-types.html
AI Review	ON

説明

全ての変数、関数の引数、および戻り値には明示的な型またはインターフェースを指定すること。

理由

型を明示的に宣言することで、コンパイル時の型チェックの恩恵を受けられ、ランタイムエラーのリスクを減らします。また、コードの意図が明確になり、他の開発者がコードを理解しやすくなります。

例

// 良いコードの例
function add(x: number, y: number): number {
  return x + y;
}

// 悪いコードの例
function add(x, y) {
  return x + y;
}

例外ケース

• ライブラリが提供する関数や変数の型が any である場合は、適宜型アサーションを使用する。

リファクタリングガイドライン

既存のコードでは、任意の型が使われていた場合、それを具体的な型に置き換えていく。新規コードでは初めから型を適用する。

---

[github-actions]

関数splitCommentsの引数responseと戻り値に型が指定されていません。responseは文字列として扱われているので、型をstringと明示してください。また、この関数はオブジェクトの配列を返しているので、戻り値の型を{ start: number; end: number; comment: string }[]と明示してください。

Reference: ## 型定義の適用

Meta	Content
Level	必須
Link	https://www.typescriptlang.org/docs/handbook/2/everyday-types.html
AI Review	ON

説明

全ての変数、関数の引数、および戻り値には明示的な型またはインターフェースを指定すること。

理由

型を明示的に宣言することで、コンパイル時の型チェックの恩恵を受けられ、ランタイムエラーのリスクを減らします。また、コードの意図が明確になり、他の開発者がコードを理解しやすくなります。

例

// 良いコードの例
function add(x: number, y: number): number {
  return x + y;
}

// 悪いコードの例
function add(x, y) {
  return x + y;
}

例外ケース

• ライブラリが提供する関数や変数の型が any である場合は、適宜型アサーションを使用する。

リファクタリングガイドライン

既存のコードでは、任意の型が使われていた場合、それを具体的な型に置き換えていく。新規コードでは初めから型を適用する。

---

[github-actions]

関数buildPromptの引数ruleに型が指定されていません。ruleは文字列として扱われているので、型をstringと明示してください。

Reference: ## 型定義の適用

Meta	Content
Level	必須
Link	https://www.typescriptlang.org/docs/handbook/2/everyday-types.html
AI Review	ON

説明

全ての変数、関数の引数、および戻り値には明示的な型またはインターフェースを指定すること。

理由

型を明示的に宣言することで、コンパイル時の型チェックの恩恵を受けられ、ランタイムエラーのリスクを減らします。また、コードの意図が明確になり、他の開発者がコードを理解しやすくなります。

例

// 良いコードの例
function add(x: number, y: number): number {
  return x + y;
}

// 悪いコードの例
function add(x, y) {
  return x + y;
}

例外ケース

• ライブラリが提供する関数や変数の型が any である場合は、適宜型アサーションを使用する。

リファクタリングガイドライン

既存のコードでは、任意の型が使われていた場合、それを具体的な型に置き換えていく。新規コードでは初めから型を適用する。

---

[github-actions]

関数buildCommentの引数commentとrule、戻り値に型が指定されていません。それぞれ適切な型を指定してください。例えば、以下のように修正できます。

const buildComment = (comment: string, rule: string): string => {
  // ...
};

Reference: ## 型定義の適用

Meta	Content
Level	必須
Link	https://www.typescriptlang.org/docs/handbook/2/everyday-types.html
AI Review	ON

説明

全ての変数、関数の引数、および戻り値には明示的な型またはインターフェースを指定すること。

理由

型を明示的に宣言することで、コンパイル時の型チェックの恩恵を受けられ、ランタイムエラーのリスクを減らします。また、コードの意図が明確になり、他の開発者がコードを理解しやすくなります。

例

// 良いコードの例
function add(x: number, y: number): number {
  return x + y;
}

// 悪いコードの例
function add(x, y) {
  return x + y;
}

例外ケース

• ライブラリが提供する関数や変数の型が any である場合は、適宜型アサーションを使用する。

リファクタリングガイドライン

既存のコードでは、任意の型が使われていた場合、それを具体的な型に置き換えていく。新規コードでは初めから型を適用する。

---