add ruff support - Githubissues

biocommons / biocommons.example

Template for new biocommons packages, and source of configuration for periodic updates to derived packages

1 stars 1 forks source link

add ruff support #3

Closed reece closed 1 month ago

reece commented 11 months ago

See https://beta.ruff.rs/docs/configuration/

Decision at 2024-05-20 maintainers' meeting:

adopt ruff
drop pylint, pylint, isort, black
keep pyright as-is for now
Do the above in this repo initially, then propagate as separate issues
for now, separate ruff check and ruff format operations

github-actions[bot] commented 10 months ago

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days.

reece commented 9 months ago

@ecalifornica : Seems like something that you'd be interested in

github-actions[bot] commented 8 months ago

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days.

ecalifornica commented 8 months ago

Do we want to add this to the Makefile/PR checks?

github-actions[bot] commented 7 months ago

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days.

github-actions[bot] commented 7 months ago

This issue was closed because it has been stalled for 7 days with no activity.

reece commented 4 months ago

This issue was closed by stalebot. It has been reopened to give more time for community review. See biocommons coding guidelines for stale issue and pull request policies. This resurrection is expected to be a onos.environ["GITHUB_TOKEN"]e-time event.

jsstevenson commented 3 months ago

Would like to bump this for consideration (@reece, @korikuzma, others). We're now using Ruff in virtually all of our projects as the single source of linting and formatting, and I think we're pretty happy with it -- it's fast, easy to use, centrally configurable, and offers a wide array of available rules. I'm confident that it could replace most of the linting checks currently listed in pyproject.toml/.flake8 in this repo (I don't believe Ruff has complete coverage of every Pylint rule, but it's got a whole lot of them).

So, my proposal would be to go a bit further than #36 and either trim or remove entirely the other included linters/formatters.

korikuzma commented 3 months ago

@jsstevenson I like using ruff and would be fine only using it as our sole linter/formatter.

jsstevenson commented 3 months ago

One other observation: the biocommons.org dev guide says that code style is enforced with black, isort, and pylint. However, the template also checks with flake8 in GitHub Actions and via pre-commit, but doesn't perform pylint checks in either case (although it is included as a dev dependency). It might be good to clean this up in one direction or another.

korikuzma commented 1 month ago

@biocommons/maintainers have decided on dropping isort, pylint, and black in favor of ruff