Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

カスタムルールのコンパイル後にprettierでフォーマットする #81

Merged
merged 3 commits into from
Dec 7, 2024

Conversation

XeicuLy
Copy link
Owner

@XeicuLy XeicuLy commented Dec 7, 2024

close #80

Summary by CodeRabbit

  • 新機能
    • TypeScriptコンパイルとフォーマット用のカスタムルールスクリプトを追加しました。
  • バグ修正
    • ESLintの無視設定を更新し、特定のファイルを無視するようにしました。
  • ドキュメンテーション
    • スクリプト名をbuild:custom-lintからbuild:custom-ruleに変更しました。

@XeicuLy XeicuLy added the enhancement New feature or request label Dec 7, 2024
@XeicuLy XeicuLy self-assigned this Dec 7, 2024
Copy link

coderabbitai bot commented Dec 7, 2024

Walkthrough

このプルリクエストでは、ESLintの設定ファイルeslint.config.mjsignores配列が更新され、特定のファイルが無視されるように変更されました。また、package.jsonscriptsセクションにおいて、スクリプト名の変更と新しいスクリプトの追加が行われ、TypeScriptのコンパイルとPrettierによるファイルの整形が実行されるようになりました。さらに、いくつかのファイルでインポート文の順序が整理されましたが、機能自体には変更はありません。

Changes

ファイル名 変更概要
eslint.config.mjs ignores配列から'prettier.config.mjs''settings/rules/**/*'を削除し、['.cz-config.cts']に変更。
package.json スクリプトbuild:custom-lintbuild:custom-ruleに変更し、custom-rule:tsccustom-rule:formatを追加。
settings/rules/src/helpers/astHelpers.ts インポート文addToListの順序を変更(下から上へ移動)。
settings/rules/src/store-state-suffix.ts インポート文TSESLintの順序を変更(下から上へ移動)。

Possibly related issues

Possibly related PRs

うさぎの詩
ぴょんぴょん跳ねて、
新しいルールが生まれ、
整形も忘れず、
みんなで楽しむ、
コードの世界、
うさぎの夢、続くよ! 🐇✨


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
package.json (1)

15-16: スクリプトのエラーハンドリングを改善することを推奨します

コンパイルとフォーマットを分離したのは良い改善ですが、エラーハンドリングを追加することを推奨します。

以下のような変更を提案します:

-    "custom-rule:tsc": "tsc --project settings/rules/tsconfig.json",
-    "custom-rule:format": "prettier --write settings/rules/dist/**",
+    "custom-rule:tsc": "tsc --project settings/rules/tsconfig.json || exit 1",
+    "custom-rule:format": "prettier --write settings/rules/dist/** || echo 'Formatting failed' && exit 1",

この変更により:

  • コンパイルエラー時に明確にビルドが失敗します
  • フォーマットエラー時にも適切なエラーメッセージが表示されます
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between e7b848b and 5934f86.

⛔ Files ignored due to path filters (1)
  • settings/rules/dist/helpers/astHelpers.js is excluded by !**/dist/**
📒 Files selected for processing (4)
  • eslint.config.mjs (1 hunks)
  • package.json (1 hunks)
  • settings/rules/src/helpers/astHelpers.ts (1 hunks)
  • settings/rules/src/store-state-suffix.ts (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • settings/rules/src/store-state-suffix.ts
  • settings/rules/src/helpers/astHelpers.ts
🔇 Additional comments (2)
eslint.config.mjs (1)

11-11: ESLint の無視設定の変更を確認してください

settings/rules/**/* を ignores から削除することで、コンパイル後のカスタムルールに対して ESLint が実行されるようになりました。この変更は意図的なものと思われますが、以下の点を確認してください。

✅ Verification successful

Let me gather more information about the ESLint configuration and the compiled rules.


ESLint の無視設定の変更は適切です

コードベースの分析から、以下の点が確認できました:

  • カスタムルールのソースは settings/rules/src/ にあり、コンパイル後のファイルは settings/rules/dist/ に出力されます
  • settings/rules/index.js を通じてカスタムルールが ESLint に正しく登録されています
  • coding-rules/store-state-suffix ルールが設定で有効化されています

ignores からの settings/rules/**/* の削除は意図的で適切な変更です。これにより、コンパイルされたカスタムルールに対して ESLint が実行され、コード品質が向上します。

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify if the custom rules are properly linted after compilation

# Check if ESLint is running on the compiled rules
eslint settings/rules/dist/** --print-config .eslintrc.json | jq '.ignores'

# Verify the existence of compiled rules
ls -la settings/rules/dist/

Length of output: 658


Script:

#!/bin/bash
# Check the content of eslint.config.mjs to understand the current configuration
cat eslint.config.mjs

# Check if there are any ESLint related files in the settings/rules directory
fd -t f -e js -e ts -e mjs -e cjs . settings/rules/

# Check if there are any ESLint configurations in package.json
cat package.json | jq '.eslintConfig, .devDependencies | select(.!=null)'

Length of output: 3019

package.json (1)

7-7: スクリプト名の変更は適切です

build:custom-lint から build:custom-rule への名前変更は、機能をより正確に表現しており、良い変更です。

@XeicuLy XeicuLy merged commit eba33eb into main Dec 7, 2024
6 checks passed
@XeicuLy XeicuLy deleted the feature/build-custom-rule-after-prettier branch December 7, 2024 12:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

カスタムルールを生成したあとに、整形するようにする
1 participant