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

Add linter command option to kedro-starters #251

Open
lrcouto opened this issue Nov 6, 2024 · 0 comments
Open

Add linter command option to kedro-starters #251

lrcouto opened this issue Nov 6, 2024 · 0 comments

Comments

@lrcouto
Copy link
Contributor

lrcouto commented Nov 6, 2024

Description

kedro-starters currently does not have a make lint command on its Makefile, and all of the checks for linting is done on the e2e-tests. This causes some issues when working on the repo, as linter errors are found only when changes are pushed to remote.

Context

Adding a linting option do be used while developing on the kedro-starters repo would make it easier to fix linter errors without having to run e2e tests locally and then go through each one of the errors manually, or only find out about them when the changes are going through CI.

Possible Implementation

The challenge with linting this repo is that ruff, which is what is being used on the e2e-tests, will break on the cookiecutter placeholders. The linting on CI is done on projects built from the templates, and not on the templates themselves:

image

The most straightforward option would be to use a command like ruff check --fix --exit-zero, which will still fix errors if fixable, and will not stop on the parsing errors above. It will still display the parsing errors, though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant