Skip to content

Conversation

abhijeetw035
Copy link
Contributor

@abhijeetw035 abhijeetw035 commented Apr 25, 2025

πŸ“‹ Description

JIRA ID:

Updated the linting to handle .java and .xml files

  • added Checkstyle.jar which allows linting for .java
  • xmllint for linting xml files

βœ… Type of Change

  • 🐞 Bug fix (non-breaking change which resolves an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • πŸ”₯ Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • πŸ›  Refactor (change that is neither a fix nor a new feature)
  • βš™οΈ Config change (configuration file or build script updates)
  • πŸ“š Documentation (updates to docs or readme)
  • πŸ§ͺ Tests (adding new or updating existing tests)
  • 🎨 UI/UX (changes that affect the user interface)
  • πŸš€ Performance (improves performance)
  • 🧹 Chore (miscellaneous changes that don't modify src or test files)

Screenshot

image

Summary by CodeRabbit

  • Chores
    • Updated pre-commit linting to include Java and XML file validation.
    • Adjusted linting rules for TypeScript and JavaScript files under the source directory.

Copy link

coderabbitai bot commented Apr 25, 2025

Walkthrough

The lint-staged configuration in the project's package.json was updated. The file patterns for pre-commit linting were changed to target TypeScript and JavaScript files under the src directory using eslint. Additionally, new rules were introduced to lint Java files with Checkstyle and validate XML files using xmllint, both applied across the entire project. No changes were made to any exported or public code entities.

Changes

File(s) Change Summary
package.json Updated lint-staged configuration: changed JS/TS file patterns for eslint, added Checkstyle linting for Java files, and xmllint validation for XML files.

Poem

In the garden of code, a new rule set appears,
Now Java and XML join, as the commit dust clears.
Eslint sweeps the scripts, Checkstyle keeps Java neat,
Xmllint checks tags, making XML complete.
With every staged file, the project hops aheadβ€”
Linting all the way, just as the rabbit said! πŸ‡βœ¨


πŸ“œ 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 4524ce5 and ba4f16c.

β›” Files ignored due to path filters (1)
  • checkstyle.jar is excluded by !**/*.jar
πŸ“’ Files selected for processing (1)
  • package.json (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (java)
πŸ”‡ Additional comments (3)
package.json (3)

15-17: Confirm CSS/HTML linting removal
It looks like the pre-commit pattern for CSS and HTML files (e.g. .css, .html) under src/ was removed in favor of only .ts/.js. Please verify that this was intentional and that CSS/HTML linting or formatting is still covered elsewhere (e.g., via stylelint, Prettier, or other hooks).


21-23: Verify xmllint availability on CI/Dev machines
The xmllint --noout step requires xmllint to be installed in the environment. Confirm that your CI pipelines and all developer machines have xmllint available (or provide installation instructions/fallback).


18-20:

❓ Verification inconclusive

Ensure Checkstyle JAR is available
The command java -jar checkstyle.jar -c checkstyle.xml will error out if checkstyle.jar isn't present at the repository root or the specified path. Please confirm that the JAR is committed (or installed via a package manager) and that the path is correct.


#!/bin/bash
# Verify if checkstyle.jar is committed anywhere in the repo
find . -type f -name 'checkstyle.jar'

#!/bin/bash
# Search for checkstyle.jar in the repository
find . -type f -name 'checkstyle.jar'

Verify presence and path of Checkstyle JAR

The java -jar checkstyle.jar -c checkstyle.xml hook in your package.json (lines 18–20) will fail if checkstyle.jar isn’t located at the repository root (or at the specified path). Please:

  • Confirm that checkstyle.jar is committed to the repo or installed via a package manager.
  • If it lives in a subdirectory (e.g., tools/checkstyle.jar), update the command to reference the correct relative path.

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.
    • 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 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

@drtechie
Copy link
Member

drtechie commented May 1, 2025

Thanks @abhijeetw035

@drtechie
Copy link
Member

drtechie commented May 2, 2025

@abhijeetw035 I have actually reverted this commit.
We don't need binary files in the repo.

These checks can be done with Maven. See how it's done in GitHub Actions.
https://github.com/PSMRI/.github/blob/main/.github/workflows/checkstyle.yml

@abhijeetw035
Copy link
Contributor Author

@drtechie , okay will make the changes.

@abhijeetw035
Copy link
Contributor Author

abhijeetw035 commented May 16, 2025

@abhijeetw035 I have actually reverted this commit. We don't need binary files in the repo.

These checks can be done with Maven. See how it's done in GitHub Actions. https://github.com/PSMRI/.github/blob/main/.github/workflows/checkstyle.yml

@drtechie Made the required changes here:
#81

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