tlgs / template.py Goto Github PK

Since Ruff rules are specified in pyproject.toml and this file is removed for the bare project type, Ruff hooks will revert to using the default configuration.

This is bad because all project types should ideally be linted the same way.

Possible solutions:

1. add a pyproject.toml for the bare project type - not ideal because the point behind this project type is for the repo to resemble a collection of independent Python scripts and not a cohesive Python project.
2. add arguments to the Ruff hooks in .pre-commit-config.yaml for the bare project type - not ideal because the arguments would likely become unwieldy. They would need to be duplicated for the ruff and ruff-format hooks and they would need to be synced with the configuration in pyproject.toml.
3. add a ruff.toml configuration file for the bare project type - not ideal because the file would need to be synced with the configuration in pyproject.toml. Plus it's another file to manage.
4. move the Ruff configuration to ruff.toml for all project types - not ideal because I'd prefer if file configuration was always set in the pyproject.toml. Plus it's another file to manage.
5. remove custom Ruff configuration - not ideal because I feel like Ruff's default configuration is a little bit tame. I like the idea of removing code from the project, though.
6. remove the bare project type - maybe a bit extreme or maybe not such a bad idea. I mostly had repositories like Advent of Code in mind when I thought about this option. Perhaps adding this was a bit of feature creep and it's not that useful?

I think the best way to go about this is a variation of option (3): create a ruff.toml file in which to keep the Ruff configuration and use Cookiecutter's machinery to move this configuration to pyproject.toml on the other project types. Or maybe keep the pyproject.toml configuration as is and extract the tool.ruff table into a ruff.toml file for the bare project type. This solves the keep-sync problem at the cost of more code.

Ah, that option has the benefit on deleting the wonky if in the .pre-commit-config.yaml template: the bare project will have a TOML file to deal with now!