chore: husky setup with lint by hidaytrahman · Pull Request #32 · hidaytrahman/template-rtw

hidaytrahman · 2025-06-15T13:25:12Z

Summary by CodeRabbit

Chores
- Introduced automated linting, formatting, and targeted test runs on staged files before committing.
- Added configuration and tooling to enforce code quality standards during the commit process.
- Updated development dependencies to include tools for Git hooks and code quality checks.
- Standardized code formatting rules and enhanced linting configurations for JavaScript and TypeScript files.

coderabbitai · 2025-06-15T13:26:40Z

Walkthrough

This update introduces Husky and lint-staged to automate code quality checks during the Git commit process. A Husky pre-commit hook is added to trigger lint-staged, which uses a new .lintstagedrc configuration to run ESLint, Prettier, and targeted test coverage on staged files. The package.json is updated to include Husky and lint-staged as development dependencies, adds ESLint, and introduces a "prepare" script to set up Husky during installation. Additionally, a new ESLint configuration file is added for TypeScript and JavaScript linting. A .prettierrc file is introduced to enforce consistent code formatting rules. The only code change is a whitespace adjustment in the createTodo function with no effect on logic or types. No changes are made to exported or public entity signatures.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant Git
    participant Husky Pre-commit Hook
    participant lint-staged
    participant ESLint
    participant Prettier
    participant Test Runner

    Developer->>Git: git commit
    Git->>Husky Pre-commit Hook: Trigger pre-commit
    Husky Pre-commit Hook->>lint-staged: Run lint-staged
    lint-staged->>ESLint: Lint/fix JS/TS files
    lint-staged->>Prettier: Format JS/TS/MD files
    lint-staged->>Test Runner: Run tests with coverage on affected files
    lint-staged-->>Husky Pre-commit Hook: Return status
    Husky Pre-commit Hook-->>Git: Allow or block commit

Poem

Hopping through the code so neat,
Husky guards each commit’s beat.
Lint and format, tests in tow,
Only the cleanest changes go!
But watch those types that twist and twine,
A bunny’s caution saves the line.
🐇✨

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a18cb6b and f2a6eb3.

📒 Files selected for processing (1)

src/services/app.services.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

src/services/app.services.ts

✨ Finishing Touches

📝 Generate Docstrings

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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

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.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

.husky/pre-commit (1)

1-4: Husky hook: Validate command invocation.

The shebang and sourcing of husky.sh are correct. For consistency in a Yarn-based project, consider invoking lint-staged via yarn lint-staged instead of npx lint-staged, or verify that npx resolves the intended binary in all environments.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e604909 and 56e32eb.

⛔ Files ignored due to path filters (1)

yarn.lock is excluded by !**/yarn.lock, !**/*.lock

📒 Files selected for processing (3)

.husky/pre-commit (1 hunks)
.lintstagedrc (1 hunks)
package.json (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: build-and-test

🔇 Additional comments (5)

package.json (2)

11-12: Scripts: Enable coverage and Husky installation.

Adding "test:coverage": "jest --coverage" simplifies coverage reporting, and introducing "prepare": "husky" correctly bootstraps Husky hooks after install.

43-43: DevDependencies: ESLint, Husky, and lint-staged added.

Including eslint, husky, and lint-staged in devDependencies aligns with the new pre-commit workflow. Ensure these versions are compatible with your existing toolchain.

Also applies to: 45-45, 49-49

.lintstagedrc (3)

2-4: Lint-staged: ESLint autofix configuration.

Applying eslint --fix on staged JS/TS files ensures style consistency. Confirm that your ESLint configuration supports all intended autofixes.

5-7: Lint-staged: Prettier formatting.

Formatting code and markdown with Prettier on commit prevents style drift. Ensure your Prettier settings are in sync with project conventions.

8-10: Lint-staged: Run related tests with coverage.

Using --findRelatedTests and --bail accelerates feedback on staged changes. Verify that yarn test:coverage --findRelatedTests --bail correctly passes flags to Jest under your Yarn version; if not, consider invoking Jest directly.

coderabbitai

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 56e32eb and 6da792b.

📒 Files selected for processing (3)

.husky/pre-commit (1 hunks)
package.json (2 hunks)
src/services/app.services.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

.husky/pre-commit
package.json

🧰 Additional context used

🪛 Biome (1.9.4)

src/services/app.services.ts

[error] 31-31: Can't assign a because it's a constant

This is where the variable is defined as constant

Unsafe fix: Replace const with let if you assign it to a new value.

(lint/correctness/noConstAssign)

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: build-and-test

src/services/app.services.ts

hidaytrahman added 2 commits June 15, 2025 18:49

chore: husky setup with lint

56e32eb

husky fixes for deprecate

52b288b

coderabbitai bot reviewed Jun 15, 2025

View reviewed changes

src/services/app.services.ts Outdated Show resolved Hide resolved

more

c09dea6

hidaytrahman force-pushed the chore/quality-code branch from 6da792b to c09dea6 Compare June 15, 2025 13:40

hidaytrahman added 3 commits June 15, 2025 19:22

prettier setup with husky

2be512d

husky setup eslint

a18cb6b

fix: file issue

f2a6eb3

hidaytrahman merged commit afa62aa into main Jun 21, 2025
1 check passed

This was referenced Jun 21, 2025

Feat: implement husky with lint and test #31

Closed

Code Improvements #26

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: husky setup with lint#32

chore: husky setup with lint#32
hidaytrahman merged 6 commits intomainfrom
chore/quality-code

hidaytrahman commented Jun 15, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jun 15, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

hidaytrahman commented Jun 15, 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 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Sequence Diagram(s)

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

hidaytrahman commented Jun 15, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 15, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)