Skip to content

Comments

[CI] Speed up githooks#3732

Merged
testableapple merged 1 commit intodevelopfrom
ci/githooks
Jul 18, 2025
Merged

[CI] Speed up githooks#3732
testableapple merged 1 commit intodevelopfrom
ci/githooks

Conversation

@testableapple
Copy link
Contributor

@testableapple testableapple commented Jul 18, 2025

Summary by CodeRabbit

  • Chores
    • Updated pre-commit hook configuration to run code formatting and linting tools sequentially on staged Swift files.

@testableapple testableapple requested a review from a team as a code owner July 18, 2025 11:51
@testableapple testableapple added the 🤖 CI/CD Any work related to CI/CD label Jul 18, 2025
@coderabbitai
Copy link

coderabbitai bot commented Jul 18, 2025

Walkthrough

The pre-commit hook configuration in lefthook.yml was updated to run three sequential jobs for Swift code formatting and linting, replacing a single parallelized Fastlane job. Each job targets staged Swift files, applies fixes, and skips execution during merge or rebase operations.

Changes

File(s) Change Summary
lefthook.yml Replaced parallel Fastlane-based formatting with three sequential jobs: swiftformat, swiftlint (autofix), swiftlint (strict), all targeting staged Swift files and skipping on merge/rebase.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant Lefthook
    participant Mint
    participant SwiftFormat
    participant SwiftLint

    Developer->>Lefthook: Trigger pre-commit
    Lefthook->>Mint: Run swiftformat on staged files
    Mint->>SwiftFormat: Format code
    SwiftFormat-->>Mint: Return formatted files
    Lefthook->>SwiftLint: Run swiftlint with --fix on staged files
    SwiftLint-->>Lefthook: Return linted files
    Lefthook->>SwiftLint: Run swiftlint in strict mode on staged files
    SwiftLint-->>Lefthook: Return lint results
    Lefthook-->>Developer: Complete pre-commit checks
Loading

Possibly related PRs

Suggested labels

🤖 CI/CD

Suggested reviewers

  • martinmitrevski

Poem

A rabbit hops through code so neat,
With hooks that run, no task repeat.
Swift files staged, the checks begin,
Format, lint, and then—no sin!
Sequential steps, a tidy feat,
The code now sparkles, oh so sweet!
🐇✨


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1fc5e10 and 12dd5b2.

📒 Files selected for processing (1)
  • lefthook.yml (1 hunks)
🔇 Additional comments (1)
lefthook.yml (1)

2-2: Re-check the decision to disable parallel execution

Setting parallel: false guarantees deterministic ordering (useful because swiftformat mutates files), but it also removes any chance of running the two subsequent swiftlint steps concurrently.
If the mutations are fully finished and staged after the first job, the two linting passes could still safely run in parallel and cut the hook time roughly in half.

Consider:

-  parallel: false
+  parallel: true          # keep deterministic order via explicit `run` dependencies (see docs)

or using a dedicated pre-commit-sequential hook for the first step and keeping the default hook parallelised.

parallel: false
jobs:
- run: bundle exec fastlane run_swift_format
- run: mint run swiftformat --config .swiftformat --exclude '**/Generated', 'Sources/StreamChatUI/StreamNuke', 'Sources/StreamChatUI/StreamSwiftyGif', 'Sources/StreamChatUI/StreamDifferenceKit' {staged_files}
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

--exclude argument will be parsed incorrectly – commas end up inside the individual tokens

The current quoting causes the shell to pass four distinct arguments:

'**/Generated,'  'Sources/StreamChatUI/StreamNuke,'  'Sources/StreamChatUI/StreamSwiftyGif,'  'Sources/StreamChatUI/StreamDifferenceKit'

swiftformat expects a single comma-separated string (--exclude a,b,c) or multiple --exclude flags.
As written, none of the paths (except the last) will match and formatting is applied to generated code.

-    - run: mint run swiftformat --config .swiftformat --exclude '**/Generated', 'Sources/StreamChatUI/StreamNuke', 'Sources/StreamChatUI/StreamSwiftyGif', 'Sources/StreamChatUI/StreamDifferenceKit' {staged_files}
+    - run: >
+        mint run swiftformat \
+          --config .swiftformat \
+          --exclude '**/Generated, Sources/StreamChatUI/StreamNuke, Sources/StreamChatUI/StreamSwiftyGif, Sources/StreamChatUI/StreamDifferenceKit' \
+          {staged_files}
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- run: mint run swiftformat --config .swiftformat --exclude '**/Generated', 'Sources/StreamChatUI/StreamNuke', 'Sources/StreamChatUI/StreamSwiftyGif', 'Sources/StreamChatUI/StreamDifferenceKit' {staged_files}
- run: >
mint run swiftformat \
--config .swiftformat \
--exclude '**/Generated, Sources/StreamChatUI/StreamNuke, Sources/StreamChatUI/StreamSwiftyGif, Sources/StreamChatUI/StreamDifferenceKit' \
{staged_files}
🤖 Prompt for AI Agents
In lefthook.yml at line 4, the --exclude argument is incorrectly quoted, causing
the shell to split it into multiple arguments with trailing commas. Fix this by
either providing a single quoted string with all paths comma-separated and no
spaces, or by using multiple --exclude flags for each path. This ensures
swiftformat correctly receives the exclude patterns as intended.

@testableapple testableapple merged commit 1526065 into develop Jul 18, 2025
14 checks passed
@testableapple testableapple deleted the ci/githooks branch July 18, 2025 12:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🤖 CI/CD Any work related to CI/CD

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants