-
Notifications
You must be signed in to change notification settings - Fork 4
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.
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
Add minimal pre-commit config #150
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,15 @@ | ||
| ^.*\.Rproj$ | ||
| ^CITATION\.cff$ | ||
| ^LICENSE\.md$ | ||
| ^\.github$ | ||
| ^Meta$ | ||
| ^README\.Rmd$ | ||
| ^codecov\.yml$ | ||
| ^\.Rproj\.user$ | ||
| ^\.github$ | ||
| ^\.lintr$ | ||
| ^\.pre-commit-config\.yaml$ | ||
| ^_pkgdown\.yml$ | ||
| ^codecov\.yml$ | ||
| ^doc$ | ||
| ^docs$ | ||
| ^pkgdown$ | ||
| ^\.lintr$ | ||
| ^.*\.Rproj$ | ||
| ^\.Rproj\.user$ | ||
| ^CITATION\.cff$ | ||
| ^tools$ | ||
| ^doc$ | ||
| ^Meta$ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| # All available hooks: https://pre-commit.com/hooks.html | ||
| # R specific hooks: https://github.com/lorenzwalthert/precommit | ||
| repos: | ||
| - repo: https://github.com/lorenzwalthert/precommit | ||
| rev: v0.4.2 | ||
| hooks: | ||
| - id: style-files | ||
| args: [--style_pkg=styler, --style_fun=tidyverse_style] | ||
| - id: roxygenize | ||
| - id: use-tidy-description | ||
| - id: parsable-R | ||
| - id: no-browser-statement | ||
| - id: no-debug-statement | ||
| - id: deps-in-desc | ||
| - id: pkgdown | ||
| - repo: https://github.com/pre-commit/pre-commit-hooks | ||
| rev: v4.6.0 | ||
| hooks: | ||
| - id: check-added-large-files | ||
| args: ['--maxkb=700'] | ||
| - id: file-contents-sorter | ||
| files: '^\.Rbuildignore$' | ||
| - id: end-of-file-fixer | ||
| exclude: '\.Rd' | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This one can be quite annoying, to be honest. It often makes changes unrelated to the PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The way I understand stylers/linters like this is that making changes unrelated to the PR only happens if the style is not upheld to begin with. This is a common thing with for example
prettierin JavaScript too. Is the annoyance with the styler or with the style itself?This will not happen so much with new instances of packagetemplate inasmuch for existing packages. For new instances, the pre-commit hook ensures the style is applied from the beginning, hence, it will only make changes where the PR is doing things anyway. In older packages, if style is not consistent, it would cause changes upon first run to get everything in style. We could opt to run the styler before setting up the pre-commit hook to ensure PRs don't get clogged unnecessarily - which is a valid point by @jamesmbaazam 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, that's a good workaround. In the past, I've not included the style changes to a PR if it's not within its scope as it can be distracting to review.