Brew setup and sonar coverage setup#54
Conversation
|
Warning Rate limit exceeded@pateash has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 22 minutes and 13 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughThe recent changes primarily involve introducing Homebrew formulae management capabilities and related documentation to the project. Additionally, there are updates to the SonarCloud configuration, contributing guide paths, and security information. Specific configurations and dependency requirements have also been adjusted for better project maintenance and development practices. Changes
Assessment against linked issues
Poem
Tip Early access features: enabledWe are currently testing the following features in early access:
Note:
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 7
Outside diff range and nitpick comments (10)
SECURITY.md (1)
Line range hint
12-12: Fix multiple consecutive blank lines.There are multiple consecutive blank lines which should be reduced to one.
- Tell them where to go, how often they can expect to get an update on a - reported vulnerability, what to expect if the vulnerability is accepted or + Tell them where to go, how often they can expect to get an update on a reported vulnerability, what to expect if the vulnerability is accepted ordev/CONTRIBUTING.md (7)
Line range hint
16-16: Use consistent unordered list style.Unordered list style should be consistent throughout the document.
-* Use python3.8 in development + - Use python3.8 in development ```diff -* Once we publish a release, Publish workflow [publish.yml](.github%2Fworkflows%2Fpublish.yml) automatically publishes a version to [PyPi](https://pypi.org/p/hckr) + - Once we publish a release, Publish workflow [publish.yml](.github%2Fworkflows%2Fpublish.yml) automatically publishes a version to [PyPi](https://pypi.org/p/hckr) ```diff -* we use pre-commits to make sure we only pushes if lint and other checks are passed. + - we use pre-commits to make sure we only pushes if lint and other checks are passed. ```diff -* Install `pre-commit` from pypi and install in Git to enable this. + - Install `pre-commit` from pypi and install in Git to enable this. ```diff -* we can easily clean up all the dev version using this command. + - we can easily clean up all the dev version using this command.Also applies to: 19-19, 23-23, 24-24, 31-31
Tools
LanguageTool
[typographical] ~36-~36: Consider adding a comma here.
Context: ...ake pypi-clean ``` ## Homebrew formulae Please find contributing guide for `Homebrew f...(PLEASE_COMMA)
Markdownlint
36-36: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
Line range hint
15-15: Fix trailing spaces.There are trailing spaces that should be removed.
-## Python +## Python ```diff - make pypi-clean + make pypi-cleanAlso applies to: 25-25
Tools
LanguageTool
[typographical] ~36-~36: Consider adding a comma here.
Context: ...ake pypi-clean ``` ## Homebrew formulae Please find contributing guide for `Homebrew f...(PLEASE_COMMA)
Markdownlint
36-36: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
Line range hint
15-15: Add a blank line below the heading.Headings should be surrounded by blank lines.
-## Python +## Python + ```diff -## Publishing to Pypi +## Publishing to Pypi + ```diff -## Pre-commits +## Pre-commits + ```diff -## Dev versions cleanup +## Dev versions cleanup + ```diff -## Homebrew formulae +## Homebrew formulae +Also applies to: 18-18, 22-22, 30-30, 36-36
Tools
LanguageTool
[typographical] ~36-~36: Consider adding a comma here.
Context: ...ake pypi-clean ``` ## Homebrew formulae Please find contributing guide for `Homebrew f...(PLEASE_COMMA)
Markdownlint
36-36: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
Line range hint
25-25: Add blank lines around fenced code blocks.Fenced code blocks should be surrounded by blank lines.
-```bash +```bash + - make pypi-clean + make pypi-clean + ```shellAlso applies to: 32-32
Tools
LanguageTool
[typographical] ~36-~36: Consider adding a comma here.
Context: ...ake pypi-clean ``` ## Homebrew formulae Please find contributing guide for `Homebrew f...(PLEASE_COMMA)
Markdownlint
36-36: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
Line range hint
16-16: Add blank lines around lists.Lists should be surrounded by blank lines.
-* Use python3.8 in development +* Use python3.8 in development + ```diff -* Once we publish a release, Publish workflow [publish.yml](.github%2Fworkflows%2Fpublish.yml) automatically publishes a version to [PyPi](https://pypi.org/p/hckr) +* Once we publish a release, Publish workflow [publish.yml](.github%2Fworkflows%2Fpublish.yml) automatically publishes a version to [PyPi](https://pypi.org/p/hckr) + ```diff -* we use pre-commits to make sure we only pushes if lint and other checks are passed. +* we use pre-commits to make sure we only pushes if lint and other checks are passed. + ```diff -* Install `pre-commit` from pypi and install in Git to enable this. +* Install `pre-commit` from pypi and install in Git to enable this. + ```diff -* we can easily clean up all the dev version using this command. +* we can easily clean up all the dev version using this command. +Also applies to: 19-19, 23-23, 24-24, 31-31
Tools
LanguageTool
[typographical] ~36-~36: Consider adding a comma here.
Context: ...ake pypi-clean ``` ## Homebrew formulae Please find contributing guide for `Homebrew f...(PLEASE_COMMA)
Markdownlint
36-36: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
Line range hint
23-23: Fix grammatical error.The pronoun 'we' must be used with a non-third-person form of a verb.
- we use pre-commits to make sure we only pushes if lint and other checks are passed. + we use pre-commits to make sure we only push if lint and other checks are passed.Tools
LanguageTool
[typographical] ~36-~36: Consider adding a comma here.
Context: ...ake pypi-clean ``` ## Homebrew formulae Please find contributing guide for `Homebrew f...(PLEASE_COMMA)
Markdownlint
36-36: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
Line range hint
31-31: Fix grammatical number.The grammatical number of this noun doesn’t look right. Consider replacing it.
- we can easily clean up all the dev version using this command. + we can easily clean up all the dev versions using this command.Tools
LanguageTool
[typographical] ~36-~36: Consider adding a comma here.
Context: ...ake pypi-clean ``` ## Homebrew formulae Please find contributing guide for `Homebrew f...(PLEASE_COMMA)
Markdownlint
36-36: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
README.md (2)
Line range hint
1-1: Add a blank line below the heading.Headings should be surrounded by blank lines.
-# hckr - cli hack for developers +# hckr - cli hack for developers +Tools
LanguageTool
[typographical] ~40-~40: Consider adding a comma here.
Context: ...nses/MIT.html) license. ## Contributing Please find contributing guide here [CONTRIBUT...(PLEASE_COMMA)
Markdownlint
40-40: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
43-43: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
Line range hint
22-22: Fix multiple consecutive blank lines.There are multiple consecutive blank lines which should be reduced to one.
- If you feel awesome and want to support us in a small way, please consider starring and sharing the repo! This helps us get known and grow the community. 🙏 + If you feel awesome and want to support us in a small way, please consider starring and sharing the repo! This helps us get known and grow the community. 🙏Tools
LanguageTool
[typographical] ~40-~40: Consider adding a comma here.
Context: ...nses/MIT.html) license. ## Contributing Please find contributing guide here [CONTRIBUT...(PLEASE_COMMA)
Markdownlint
40-40: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
43-43: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (7)
- .github/workflows/build.yml (1 hunks)
- README.md (1 hunks)
- SECURITY.md (1 hunks)
- dev/CONTRIBUTING.md (1 hunks)
- dev/HOMEBREW.md (1 hunks)
- dev/brew.sh (1 hunks)
- sonar-project.properties (1 hunks)
Files skipped from review due to trivial changes (2)
- .github/workflows/build.yml
- sonar-project.properties
Additional context used
Markdownlint
SECURITY.md
12-12: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
dev/HOMEBREW.md
19-19: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
1-1: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
4-4: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
9-9: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
14-14: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
5-5: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
10-10: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
15-15: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
21-21: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
2-2: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
20-20: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
dev/CONTRIBUTING.md
16-16: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
19-19: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
23-23: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
24-24: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
31-31: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
15-15: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
25-25: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
15-15: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
18-18: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
22-22: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
30-30: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
36-36: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
25-25: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
32-32: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
16-16: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
19-19: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
23-23: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
24-24: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
31-31: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
31-31: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
7-7: null
Link fragments should be valid(MD051, link-fragments)
README.md
22-22: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
1-1: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
40-40: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
43-43: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
LanguageTool
dev/CONTRIBUTING.md
[style] ~12-~12: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional.
Context: ...ckr](https://github.com/pateash/hckr/) Please feel free to provide any suggestion for new utility ...(FEEL_FREE_TO_STYLE_ME)
[grammar] ~23-~23: The pronoun ‘we’ must be used with a non-third-person form of a verb.
Context: ...we use pre-commits to make sure we only pushes if lint and other checks are passed. * ...(NON3PRS_VERB)
[uncategorized] ~31-~31: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...up * we can easily clean up all the dev version using this command. ```shell make pypi...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[typographical] ~36-~36: Consider adding a comma here.
Context: ...ake pypi-clean ``` ## Homebrew formulae Please find contributing guide for `Homebrew f...(PLEASE_COMMA)
README.md
[style] ~18-~18: Consider using a more formal and expressive alternative to ‘awesome’.
Context: ...# Supporting the project ⭐ If you feel awesome and want to support us in a small way, ...(AWESOME)
[style] ~18-~18: Using many exclamation marks might seem excessive (in this case: 7 exclamation marks for a text that’s 1604 characters long)
Context: ...e consider starring and sharing the repo! This helps us get known and grow the co...(EN_EXCESSIVE_EXCLAMATION)
[typographical] ~40-~40: Consider adding a comma here.
Context: ...nses/MIT.html) license. ## Contributing Please find contributing guide here [CONTRIBUT...(PLEASE_COMMA)
Additional comments not posted (15)
dev/CONTRIBUTING.md (2)
Line range hint
12-12: Consider using a more professional alternative to 'feel free to'.The phrase 'feel free to' is used frequently and can be replaced with a more professional alternative.
- Please feel free to provide any suggestion for new utility in [Issues](https://github.com/pateash/hckr/issues) + Please provide any suggestions for new utilities in [Issues](https://github.com/pateash/hckr/issues)Tools
LanguageTool
[typographical] ~36-~36: Consider adding a comma here.
Context: ...ake pypi-clean ``` ## Homebrew formulae Please find contributing guide for `Homebrew f...(PLEASE_COMMA)
Markdownlint
36-36: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
36-36: Consider adding a comma.Consider adding a comma to improve readability.
-## Homebrew formulae +## Homebrew formulae,Tools
LanguageTool
[typographical] ~36-~36: Consider adding a comma here.
Context: ...ake pypi-clean ``` ## Homebrew formulae Please find contributing guide for `Homebrew f...(PLEASE_COMMA)
Markdownlint
36-36: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
README.md (3)
Line range hint
18-18: Consider using a more formal and expressive alternative to 'awesome'.The word 'awesome' can be replaced with a more formal and expressive alternative.
- If you feel awesome and want to support us in a small way, please consider starring and sharing the repo! This helps us get known and grow the community. 🙏 + If you feel great and want to support us in a small way, please consider starring and sharing the repo! This helps us get known and grow the community. 🙏Tools
LanguageTool
[typographical] ~40-~40: Consider adding a comma here.
Context: ...nses/MIT.html) license. ## Contributing Please find contributing guide here [CONTRIBUT...(PLEASE_COMMA)
Markdownlint
40-40: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
43-43: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
Line range hint
18-18: Avoid excessive exclamation marks.Using many exclamation marks might seem excessive.
- If you feel awesome and want to support us in a small way, please consider starring and sharing the repo! This helps us get known and grow the community. 🙏 + If you feel awesome and want to support us in a small way, please consider starring and sharing the repo. This helps us get known and grow the community. 🙏Tools
LanguageTool
[typographical] ~40-~40: Consider adding a comma here.
Context: ...nses/MIT.html) license. ## Contributing Please find contributing guide here [CONTRIBUT...(PLEASE_COMMA)
Markdownlint
40-40: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
43-43: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
40-40: Consider adding a comma.Consider adding a comma to improve readability.
-## Contributing +## Contributing,Tools
LanguageTool
[typographical] ~40-~40: Consider adding a comma here.
Context: ...nses/MIT.html) license. ## Contributing Please find contributing guide here [CONTRIBUT...(PLEASE_COMMA)
Markdownlint
40-40: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
dev/brew.sh (10)
1-4: Consider using a relative path for the source file.Using an absolute path can cause issues when running the script on different machines. Consider using a relative path or an environment variable.
- SOURCE="/Users/ashishpatel/pateash/homebrew-core/Formula/h/hckr.rb" + SOURCE="$(pwd)/path/to/hckr.rb"
7-11: LGTM!The
cleanfunction is straightforward and works as expected.
13-17: LGTM!The
uninstallfunction is straightforward and works as expected.
19-23: LGTM!The
installfunction is straightforward and works as expected.
25-29: LGTM!The
testfunction is straightforward and works as expected.
31-35: LGTM!The
auditfunction is straightforward and works as expected.
38-42: LGTM!The
stylefunction is straightforward and works as expected.
44-57: Consider using environment variables for paths.Using hardcoded paths can cause issues when running the script on different machines. Consider using environment variables or relative paths.
- TAP_DIR="/opt/homebrew/Library/Taps/pateash/homebrew-local/Formula/" + TAP_DIR="${HOMEBREW_PREFIX}/Library/Taps/pateash/homebrew-local/Formula/"
64-67: Improve error handling for missing commands.Consider providing more specific error messages for missing commands.
- echo -e "Please pass COMMAND, Please use $COMMANDS" + echo -e "Error: No command provided.\nUsage: $COMMANDS"
96-99: Improve error handling for invalid commands.Consider providing more specific error messages for invalid commands.
- echo -e "Invalid command, Please use $COMMANDS" + echo -e "Error: Invalid command '$CMD'.\nUsage: $COMMANDS"
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- .github/workflows/build.yml (3 hunks)
Files skipped from review as they are similar to previous changes (1)
- .github/workflows/build.yml
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #54 +/- ##
=======================================
Coverage 87.96% 87.96%
=======================================
Files 14 14
Lines 623 623
Branches 64 64
=======================================
Hits 548 548
Misses 57 57
Partials 18 18 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- .github/workflows/build.yml (2 hunks)
- pyproject.toml (1 hunks)
- sonar-project.properties (1 hunks)
Files skipped from review due to trivial changes (1)
- pyproject.toml
Files skipped from review as they are similar to previous changes (2)
- .github/workflows/build.yml
- sonar-project.properties
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- .github/workflows/build.yml (2 hunks)
- pyproject.toml (2 hunks)
Files skipped from review as they are similar to previous changes (2)
- .github/workflows/build.yml
- pyproject.toml
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- .github/workflows/build.yml (2 hunks)
- sonar-project.properties (1 hunks)
Files skipped from review as they are similar to previous changes (2)
- .github/workflows/build.yml
- sonar-project.properties
|
1 participant
Closes #50
Summary by CodeRabbit
Documentation
Chores
coverage[toml]in pyproject.toml.