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.

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

[24.0] Tool linters: allow to skip by old linter names (by allowing to skip linter modules) #18091

Merged

Conversation

bernt-matthias
Copy link
Contributor

until 23.2 we had linter functions lint_xyz in linter modules xyz. with 24.0 we splited the functions linter classes.

lint contexts allow to skip linters by name (xyz for the old functions now the class name), i.e. we can not skip by the old names anymore. this may break planemo command lines xref
galaxyproject/planemo#1441 (comment).

here I suggest to add a check for the module name against the names listed in the skip list. this restores the possibility to skip by old linter names and adds the possibility to skip whole linter modules (which might be handy anyway). Note that there was a repeats linter before which has been removed since it's covered by the xsd linting.

tried to add some tests that hopefully help to maintain this functionality.

How to test the changes?

(Select all options that apply)

  • I've included appropriate automated tests.
  • This is a refactoring of components with existing test coverage.
  • Instructions for manual testing are as follows:
    1. [add testing steps and prerequisites here if you didn't write automated tests covering all your changes]

License

  • I agree to license these and all my past contributions to the core galaxy codebase under the MIT license.

until 23.2 we had linter functions lint_xyz in linter modules xyz.
with 24.0 we splited the functions linter classes.

lint contexts allow to skip linters by name (xyz for the old functions
now the class name), i.e. we can not skip by the old names anymore.
this may break planemo command lines xref
galaxyproject/planemo#1441 (comment).

here I suggest to add a check for the module name against the names
listed in the skip list. this restores the possibility to skip by old
linter names and adds the possibility to skip whole linter modules
(which might be handy anyway).

tried to add some tests that hopefully help to maintain this
functionality.
Copy link
Member

@mvdbeek mvdbeek left a comment

Choose a reason for hiding this comment

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

Awesome, thanks a lot for that fix!

@jdavcs
Copy link
Member

jdavcs commented May 3, 2024

@bernt-matthias Thank you for the detailed inline comments in the test - this is very helpful!

@jdavcs jdavcs merged commit dcf8207 into galaxyproject:release_24.0 May 3, 2024
49 of 50 checks passed
@galaxyproject galaxyproject deleted a comment from github-actions bot May 7, 2024
@jdavcs jdavcs removed this from the 24.1 milestone May 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants