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

Format YAML with yamlfmt and dprint #250

Merged
merged 3 commits into from
Feb 6, 2024
Merged

Format YAML with yamlfmt and dprint #250

merged 3 commits into from
Feb 6, 2024

Conversation

kachick
Copy link
Collaborator

@kachick kachick commented Feb 6, 2024

#247 で頭出ししていた、YAMLへフォーマッタをかける件です。

なぜ yamlfmt直接でなく dprint を経由したかは kachick/times_kachick#257 へ詳細を書いたんですが、vscode 利用者(僕)の為という意味合いが強いです。これまで使われてなかったものの dprint 自体への依存は nix 入れた時に入ってたのでそのまま使っちゃいました。

俺は vi を使うんだから vscode の事とか無視してとにかく依存性を減らせ!

ということであれば、 dprint への依存を落として yamlfmt だけにする事は可能です。
個人的に不便だからやだけど・・・

Summary by CodeRabbit

  • 新機能
    • GitHub Actionsに「Lint」ワークフローを追加し、タイポチェックとファイルフォーマットのジョブを導入しました。
  • リファクタ
    • 複数のGitHub Actionsワークフローファイルのステップの再フォーマットとインデント調整を行いましたが、機能に変更はありません。
  • Chores
    • 依存関係にyamlfmtを追加しました。

Copy link

coderabbitai bot commented Feb 6, 2024

Walkthrough

この変更では、GitHub Actionsのワークフローファイルの再フォーマットやインデントの調整が主に行われています。機能的な変更はほとんどありませんが、新たにLintワークフローが導入され、typoチェックとファイルのフォーマットが可能になりました。また、依存関係にyamlfmtが追加されています。

Changes

ファイルパス 変更概要
.github/workflows/.../generate_pr_from_issue.yaml,
.github/workflows/.../generate_site_and_deploy.yaml
ワークフローステップの再フォーマットとインデント調整(機能変更なし)
.github/workflows/lint.yml typoチェックとファイルフォーマット用の"Lint"ワークフローを導入
.github/workflows/.../notify_long_time_no_see.yaml ワークフローステップのインデント調整(機能変更なし)
flake.nix 依存関係にyamlfmtを追加

🐰✨

コードの森を駆ける

バグなき世界へ

Lintの風、清めの雨

新たな旅立ちの朝に🌅🚀

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

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.

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 2ae065b and 2e5a376.
Files ignored due to path filters (1)
  • dprint.json is excluded by: !**/*.json
Files selected for processing (5)
  • .github/workflows/generate_pr_from_issue.yaml (1 hunks)
  • .github/workflows/generate_site_and_deploy.yaml (1 hunks)
  • .github/workflows/lint.yml (1 hunks)
  • .github/workflows/notify_long_time_no_see.yaml (2 hunks)
  • flake.nix (1 hunks)
Files skipped from review due to trivial changes (3)
  • .github/workflows/generate_pr_from_issue.yaml
  • .github/workflows/generate_site_and_deploy.yaml
  • .github/workflows/notify_long_time_no_see.yaml
Additional comments: 1
flake.nix (1)
  • 27-27: yamlfmt の追加は PR の目的に沿っています。依存関係リストに正しく追加されていることを確認しました。

.github/workflows/lint.yml Show resolved Hide resolved
@kachick kachick requested a review from pankona February 6, 2024 10:26
@pankona
Copy link
Owner

pankona commented Feb 6, 2024

最近 VSCode も使うんで...

Copy link
Owner

@pankona pankona left a comment

Choose a reason for hiding this comment

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

良いです!

@pankona pankona merged commit 93727e0 into main Feb 6, 2024
8 checks passed
@pankona pankona deleted the fmt-yaml branch February 6, 2024 13:07
@kachick
Copy link
Collaborator Author

kachick commented Feb 6, 2024

最近 VSCode も使うんで...

子供も二人、エディタも2つ・・・

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants