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

Replace flake8 and isort with ruff linter and add black --check to linting step #1763

Merged
merged 17 commits into from Jul 15, 2023

Conversation

micahellison
Copy link
Member

@micahellison micahellison commented Jul 3, 2023

This PR:

While flakeheaven has worked out well for us, it is an order of magnitude slower than ruff on my machine. Moreover, ruff's configuration feels a lot simpler -- we don't have to install a bunch of packages for various rule sets.

FlakeHeaven was ignoring long lines with comments or strings, whereas ruff is a bit more strict. I reworded comments as necessary and broke long strings into multiple lines. In a couple instances, I added the noqa directive to ignore this rule on particular lines since I think they're already most readable in their current forms.

This should only affect developers, and developers shouldn't have to change anything in their process. Just keep running poe lint for linting checks and poe format to automatically sort imports and allow black to reformat code.

Checklist

  • I have read the contributing doc.
  • I have included a link to the relevant issue number.
  • I have checked to ensure there aren't other open pull requests
    for the same issue.
  • I have written new tests for these changes, as needed.

@micahellison micahellison added the build Issues related to the build pipeline label Jul 3, 2023
@micahellison micahellison marked this pull request as ready for review July 3, 2023 19:14
Copy link
Member

@wren wren left a comment

Choose a reason for hiding this comment

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

🐩

@micahellison micahellison merged commit 34c7903 into jrnl-org:develop Jul 15, 2023
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Issues related to the build pipeline
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Linting rules aren't enforced the same as format rules
2 participants