chore: husky integration #136

MHase · 2025-06-24T20:48:28Z

Added pre-commit hook using husky togehter with lint-staged to format only changed files - not whole codebase.

Run format on everything just to make sure codebase is clean and somehow updated src/renderer/src/routes/pdf-viewer/pdf-viewer/index.tsx

Summary by CodeRabbit

Chores
- Added automated formatting and linting checks for staged files before commits.
- Integrated Husky and lint-staged tools into the project setup.
Style
- Simplified code formatting in the PDF viewer component without changing functionality.

coderabbitai · 2025-06-24T20:48:52Z

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)

bun.lock is excluded by !**/*.lock

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This update introduces Husky pre-commit hooks and lint-staged formatting to the project's development workflow. Configuration files and scripts are added or modified to ensure that staged files are automatically formatted before commits. Additionally, a minor code formatting adjustment is made in a TypeScript file without altering its logic.

Changes

File(s)	Change Summary
.husky/pre-commit	Added pre-commit hook to run `bun run lint-staged` on commit events.
.lintstagedrc.json	Introduced configuration to run `bun run format` on all staged files via lint-staged.
package.json	Added `lint-staged` script and included `husky` and `lint-staged` as dev dependencies.
src/renderer/src/routes/pdf-viewer/pdf-viewer/index.tsx	Reformatted inline assignment of `disableAutoFetch`; no logic or functional changes.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant Git (pre-commit)
    participant Husky
    participant lint-staged
    participant Formatter

    Developer->>Git (pre-commit): git commit
    Git (pre-commit)->>Husky: Trigger pre-commit hook
    Husky->>lint-staged: Run lint-staged
    lint-staged->>Formatter: Run format on staged files
    Formatter-->>lint-staged: Formatting complete
    lint-staged-->>Husky: Done
    Husky-->>Git (pre-commit): Allow commit if successful

Suggested reviewers

iamEvanYT

Poem

In the warren of code, a new rule is set,
Pre-commit checks so we never forget.
Husky hops in, lint-staged at its side,
Formatting files with every stride.
Now every commit is neat and bright—
A rabbit’s dream, code polished just right!
🐇✨

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.

iamEvanYT · 2025-06-24T20:49:54Z

Seems a bit excessive to add two new dependencies here.

coderabbitai

Actionable comments posted: 2

🔭 Outside diff range comments (1)

package.json (1)

12-32: Align package script with the staged-only formatting approach

If you adopt the format:staged solution above, remember to add the new script entry here (see diff in previous comment).
Without this adjustment, the hook will still format the whole project.

Also applies to: 80-83

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8d57b0c and 6b90448.

⛔ Files ignored due to path filters (1)

bun.lock is excluded by !**/*.lock

📒 Files selected for processing (4)

.husky/pre-commit (1 hunks)
.lintstagedrc.json (1 hunks)
package.json (2 hunks)
src/renderer/src/routes/pdf-viewer/pdf-viewer/index.tsx (1 hunks)

🔇 Additional comments (1)

src/renderer/src/routes/pdf-viewer/pdf-viewer/index.tsx (1)

14-16: No functional change – looks good

Purely stylistic tweak; behaviour remains unchanged.

.husky/pre-commit

.lintstagedrc.json

MHase · 2025-06-24T20:57:58Z

Seems a bit excessive to add two new dependencies here.

we can drop these changes and just keep in mind to format code before creating a PR
but for new devs it can be tricky (something like changing node version to 22 if you have other installed)

iamEvanYT · 2025-07-11T18:19:22Z

Hey @MHase, I'm looking to merge this PR, so can you resolve all of CodeRabbit's suggestions first? Many thanks 🙏

MHase · 2025-07-12T09:02:51Z

Hey @MHase, I'm looking to merge this PR, so can you resolve all of CodeRabbit's suggestions first? Many thanks 🙏

no changes are needed :)
pre-commit file is good as it is (examples https://github.com/lint-staged/lint-staged/tree/main/.husky)
and "new" command for formatting bunx prettier --write simply won't work 👍🏻

MHase added 2 commits June 24, 2025 22:18

chore: add husky package

fa63251

chore: add pre-commit hook

ce71c7d

MHase requested a review from iamEvanYT as a code owner June 24, 2025 20:48

coderabbitai bot reviewed Jun 24, 2025

View reviewed changes

.husky/pre-commit Show resolved Hide resolved

.lintstagedrc.json Show resolved Hide resolved

chore: add lint-staged

35a3b14

MHase force-pushed the chore/husky-integration branch from 6b90448 to ee50244 Compare June 24, 2025 20:55

chore: update bun.lock with husky installation

5667dc2

MHase force-pushed the chore/husky-integration branch from 51374e7 to 5667dc2 Compare June 24, 2025 20:58

iamEvanYT force-pushed the main branch from 312811b to cd1f024 Compare July 4, 2025 17:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore: husky integration #136

chore: husky integration #136

Uh oh!

MHase commented Jun 24, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jun 24, 2025 •

edited

Loading

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

iamEvanYT commented Jun 24, 2025

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

MHase commented Jun 24, 2025

Uh oh!

iamEvanYT commented Jul 11, 2025

Uh oh!

MHase commented Jul 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

chore: husky integration #136

Are you sure you want to change the base?

chore: husky integration #136

Uh oh!

Conversation

MHase commented Jun 24, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jun 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Walkthrough

Changes

Sequence Diagram(s)

Suggested reviewers

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

iamEvanYT commented Jun 24, 2025

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

MHase commented Jun 24, 2025

Uh oh!

iamEvanYT commented Jul 11, 2025

Uh oh!

MHase commented Jul 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

MHase commented Jun 24, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 24, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)