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.

Sign up for GitHub

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

Jump to bottom

feat: add pre-commit hooks #73

Closed
wants to merge 9 commits into from
Closed

feat: add pre-commit hooks #73

wants to merge 9 commits into from

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Jul 14, 2024 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • New Features

    • Introduced pre-commit hook configuration for checking JSON files.
    • Added documentation on using pre-commit hooks for JSON file checks.

  • Documentation

    • Updated README to include information on JSON file checking.
    • Added a new section on pre-commit in the documentation index.
    • Introduced a new pre-commit.md file for detailed guidance.

  • Bug Fixes

    • Improved parsing of function names in the check_cli command.

njzjz added 5 commits July 14, 2024 06:00
@njzjz
add hook
0713668 
Signed-off-by: Jinzhe Zeng <[email protected]>
@njzjz
strip
adb9c21 
Signed-off-by: Jinzhe Zeng <[email protected]>
@njzjz
add test
9abfd09 
Signed-off-by: Jinzhe Zeng <[email protected]>
@njzjz
update
a6a7c76 
Signed-off-by: Jinzhe Zeng <[email protected]>
@njzjz
feat: add pre-commit hooks
07b1ab6 
Signed-off-by: Jinzhe Zeng <[email protected]>
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 14, 2024 •
edited
Loading

Walkthrough

Walkthrough

The recent changes introduce a new pre-commit hook configuration for dargs-check to validate JSON files. Additionally, there's documentation enhancement on using pre-commit hooks, and a minor modification in the dargs CLI to ensure proper parsing of function names. The enhancements aim to streamline JSON validation through the pre-commit framework, offering a more robust tool for developers.

Changes

File(s) Change Summary
.pre-commit-hooks.yaml Added configuration for dargs-check to run dargs check on JSON files.
README.md Updated to highlight the new JSON file checking feature using pre-commit.
dargs/cli.py Modified check_cli function to properly strip and split function names for correct parsing.
docs/index.rst Added a new section pre-commit to the documentation index.
docs/pre-commit.md Introduced information on using pre-commit hooks to check JSON files via dargs v0.4.8.
Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 17e7d61 and 44b66fa.

Files selected for processing (5)
  • .pre-commit-hooks.yaml (1 hunks)
  • README.md (1 hunks)
  • dargs/cli.py (1 hunks)
  • docs/index.rst (1 hunks)
  • docs/pre-commit.md (1 hunks)
Files skipped from review due to trivial changes (4)
  • .pre-commit-hooks.yaml
  • README.md
  • docs/index.rst
  • docs/pre-commit.md
Additional context used
GitHub Check: codecov/patch
dargs/cli.py

[warning] 93-93: dargs/cli.py#L93
Added line #L93 was not covered by tests

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 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @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.
  • 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.

@codecov Codecov
Copy link

codecov bot commented Jul 14, 2024 •
edited
Loading

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 78.49%. Comparing base (17e7d61) to head (44b66fa).
Report is 3 commits behind head on master.

Files with missing lines Patch % Lines
dargs/cli.py 0.00% 1 Missing ⚠️
Additional details and impacted files 
@@           Coverage Diff           @@
##           master      #73   +/-   ##
=======================================
  Coverage   78.49%   78.49%           
=======================================
  Files           9        9           
  Lines         758      758           
=======================================
  Hits          595      595           
  Misses        163      163

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

coderabbitai[bot]
coderabbitai bot reviewed Jul 14, 2024
View reviewed changes
Copy link
Contributor

@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

dargs/cli.py
@@ -90,7 +90,7 @@
dict
normalized data
"""
module_name, attr_name = func.rsplit(".", 1)
module_name, attr_name = func.strip().rsplit(".", 1)
Copy link
Contributor

Choose a reason for hiding this comment

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

LGTM! Consider adding tests for the new functionality.

The addition of strip() ensures that any leading or trailing whitespace in the func string is removed before splitting it to derive module_name and attr_name. This is a useful change to prevent potential errors due to extra whitespace.

However, the new line is not covered by tests.

Do you want me to generate the unit testing code or open a GitHub issue to track this task?

Tools
GitHub Check: codecov/patch

[warning] 93-93: dargs/cli.py#L93
Added line #L93 was not covered by tests

@njzjz
Copy link
Member Author

njzjz commented Jul 15, 2024

Close. I can't find a workaround for pre-commit/pre-commit#2610.

@njzjz njzjz closed this Jul 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@njzjz