Skip to content

Improve developer tooling #50

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

Merged
merged 4 commits into from
Feb 15, 2025
Merged

Improve developer tooling #50

merged 4 commits into from
Feb 15, 2025

Conversation

dalito
Copy link
Owner

@dalito dalito commented Feb 15, 2025

This PR adds some tools to help with writing consistent, well-formatted schemas with fewer spelling errors.

  • add typos spell checker as gh-action in this repository (but not in the created project)
  • add pre-commit config for the following tools:
    • some checks from pre-commit, e.g. on trailing white-space
    • codespell - was already used in a gh-action of the repo but had to be added to pre-commit
    • yamllint - linter for yaml files
    • ruff - Python code formatter and linter
    • typos - spell checker (detects other errors than codespell)

The presence of .pre-commit-config.yaml does not activate the tools so everyone can decide if they want to use them. To enabled the checks, install pre-commit with pipx install pre-commit and then activate it in the project by running pre-commit install at the root of the project. Once installed pre-commit will run the checks on every commit and reject the commit if errors are found; it will try to auto-correct several types of errors. It is also possible to run the checks manually with pre-commit run -a.

The checks in pre-commit are not run as gh-actions in the created project. This may be added later (as an option).

@dalito dalito added enhancement New feature or request _repo Related to the template-repository _project Related to the generated project labels Feb 15, 2025
@dalito dalito added this to the Release 0.2.1 milestone Feb 15, 2025
@dalito dalito self-assigned this Feb 15, 2025
@dalito dalito force-pushed the dev-tools branch 5 times, most recently from 3d788c0 to c845fba Compare February 15, 2025 17:24
@dalito dalito merged commit 994e6f8 into main Feb 15, 2025
2 checks passed
@dalito dalito deleted the dev-tools branch February 15, 2025 23:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request _project Related to the generated project _repo Related to the template-repository
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant