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

Migrate tooling to use Ruff for linting and Formatting, MyPy for type checking. Add MkDocs tooling. #257

Merged
merged 20 commits into from
Nov 19, 2023

Conversation

seapagan
Copy link
Owner

@seapagan seapagan commented Nov 19, 2023

Migrate to a more integrated development tooling - Ruff has all the functionality of the existing linting/formatting tools. This removes a good amount of dev dependencies.

Also, add MkDocs and support libraries for future documentation.

Mypy is added and set up but not checked by default since it needs much work to get Typing running on Django.

  • Remove Black, Flake8 and other tools, plus their supporting plugins, to use Ruff instead.
  • Update pre-commit to use the same tools.
  • Ensure the codebase passes 100% on Ruff.
  • Add Ruff as a GitHub action.

@seapagan seapagan self-assigned this Nov 19, 2023
@seapagan seapagan added the refactor Internal refactoring of code or linting etc label Nov 19, 2023
seapagan and others added 6 commits November 19, 2023 11:33
too muxh of a pain in django - you need to explicity specify EVERY
dependency as an 'additional_dependencies' item

Signed-off-by: Grant Ramsay <[email protected]>
many of the packages used have no typing, ignore this warning

Signed-off-by: Grant Ramsay <[email protected]>
@seapagan seapagan marked this pull request as ready for review November 19, 2023 12:45
@seapagan seapagan marked this pull request as draft November 19, 2023 12:45
seapagan and others added 11 commits November 19, 2023 15:11
in this case the ckeditor prism README

Signed-off-by: Grant Ramsay <[email protected]>
Signed-off-by: Grant Ramsay <[email protected]>
need more investigation

Signed-off-by: Grant Ramsay <[email protected]>
Signed-off-by: Grant Ramsay <[email protected]>
it causes mkdocs to crash. I suspect different versions of 'htmlmin'
are used. Not too fussed about compressing the Blog HTML at this point

Signed-off-by: Grant Ramsay <[email protected]>
that plugin will not be bundled in the future, so run it from its own
repo

Signed-off-by: Grant Ramsay <[email protected]>
@seapagan seapagan marked this pull request as ready for review November 19, 2023 16:41
@seapagan seapagan merged commit ad6190b into main Nov 19, 2023
6 checks passed
@seapagan seapagan deleted the migrate-tooling branch November 19, 2023 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactor Internal refactoring of code or linting etc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant