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

Box alphabetical imports linter. #544

Merged
merged 17 commits into from
Mar 8, 2024
Merged

Box alphabetical imports linter. #544

merged 17 commits into from
Mar 8, 2024

Conversation

radbasa
Copy link
Contributor

@radbasa radbasa commented Jan 12, 2024 •
edited
Loading

Changes

  • Closes Box import alphabetical #543
  • Adds box_alphabetical_imports_linter()
  • Adds the linter to the .lintr template
  • Adds documentation
  • This linter ignores package/module/function aliases.

How to test

  1. Unit tests for box_alphabetical_imports_linter() is provided.

@radbasa radbasa changed the title initial attempt. unfinished. can check packages/modules. cannot check… [WIP] Box alphabetical imports linter. Jan 12, 2024
@codecov-commenter
Copy link

codecov-commenter commented Jan 12, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 38.55%. Comparing base (0ff3c44) to head (9d6bf91).

❗ Current head 9d6bf91 differs from pull request most recent head 7958999. Consider uploading reports for the commit 7958999 to get more accurate results

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #544      +/-   ##
==========================================
+ Coverage   34.11%   38.55%   +4.43%     
==========================================
  Files          10       10              
  Lines         554      594      +40     
==========================================
+ Hits          189      229      +40     
  Misses        365      365

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

Base automatically changed from box_universal_linter to main February 5, 2024 08:07
@radbasa radbasa changed the title [WIP] Box alphabetical imports linter. Box alphabetical imports linter. Mar 1, 2024
@radbasa radbasa marked this pull request as ready for review March 1, 2024 09:24
@radbasa radbasa requested a review from jakubnowicki March 1, 2024 09:24
jakubnowicki
jakubnowicki reviewed Mar 7, 2024
View reviewed changes
Copy link
Member

@jakubnowicki jakubnowicki left a comment

Choose a reason for hiding this comment

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

Works fine. I'm ok with how it handles aliases, but please make it clear in the documentation, what is the approach.

R/box_linters.R Outdated Show resolved Hide resolved
R/box_linters.R Show resolved Hide resolved
R/box_linters.R Show resolved Hide resolved
tests/testthat/test-linter_box_alphabetical.R Show resolved Hide resolved
jakubnowicki
jakubnowicki approved these changes Mar 8, 2024
View reviewed changes
Copy link
Member

@jakubnowicki jakubnowicki left a comment

Choose a reason for hiding this comment

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

LGTM

@jakubnowicki jakubnowicki merged commit 1b95e15 into main Mar 8, 2024
20 checks passed
@jakubnowicki jakubnowicki deleted the feature/box-alphabetical branch March 8, 2024 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jakubnowicki jakubnowicki jakubnowicki approved these changes

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

Successfully merging this pull request may close these issues.

Box import alphabetical
3 participants
@radbasa @codecov-commenter @jakubnowicki