kilo59 / ruff-sync Goto Github PK

View Code? Open in Web Editor NEW

1.0 2.0 2.0 303 KB

Keep ruff toml files in sync

License: MIT License

Python 100.00%

ruff-sync's Introduction

ruff-sync

CLI tool for keeping multiple project in sync with a single ruff config.

Quick start

VCS Install

pip install git+https://github.com/Kilo59/ruff-sync

Or with pipx (recommended for isolated installations)

pipx install git+https://github.com/Kilo59/ruff-sync

$ ruff-sync --help
usage: ruff-sync [-h] [--source SOURCE] [--exclude EXCLUDE [EXCLUDE ...]] upstream

positional arguments:
  upstream              The URL to download the pyproject.toml file from.

optional arguments:
  -h, --help            show this help message and exit
  --source SOURCE       The directory to sync the pyproject.toml file to. Default: .
  --exclude EXCLUDE [EXCLUDE ...]
                        Exclude certain ruff configs. Default: per-file-ignores

ruff-sync's People

Contributors

Stargazers

Watchers

Forkers

dustinbowers sourcery-ai-experiments

ruff-sync's Issues

Work for `ruff.toml`

Currently ruff-sync expects all config files to be pyproject.toml, ruff.toml is not supported.

Either file should work.

Publish to PyPi with `build-and-inspect-python-package`

Use Hynek's GA for this
https://github.com/hynek/build-and-inspect-python-package

Dependencies

Extract raw poetry file from github link

Given a link to a pryoject.toml hosted on github such as https://github.com/great-expectations/great_expectations/blob/develop/pyproject.toml I should be able to pass that link as my upstream parameter and it should work.

Currently this only works if I link to the "raw" file. https://raw.githubusercontent.com/great-expectations/great_expectations/develop/pyproject.toml

Strech goal

Allow for upstream link to a github repo that contains a pyproject.toml

Fix Whitespace Issues

Updated to pypoject.toml introduces extra whitespace and/or remove too much whitespace.

[tool.ruff]
target-version = "py310"
line-length = 120
lint.select = ["F", "ASYNC", "RUFF", "B", "S", "PTH", "W", "E"]
lint.ignore = ["W191", "E111"]
# 1 too many newlines


[tool.ruff.lint.per-file-ignores]
"__init__.py" = [
    "F401", # unused import
    "F403", # star imports
] # should be a newline after this table
[tool.coverage.run]
include = [
    "foo.py",
    "bar.py"
    ]

This is almost certainly introduced by trying to operate on individual Table items and then re-inserting them into the TOMLDocument rather than always just operating on the full document.
See get_ruff_tool_table() & merge_ruff_toml().

Switch from `poetry` -> `rye`

https://rye-up.com/

Because...
ruff-sync is closely tied to the python+rust ecosystem.

But mostly, because I just I want to try it out.

Allow for upstream link to a github repo that contains a pyproject.toml

See #12

Pull config from ` tool.ruff-sync` `pyproject.toml`

Allow ruff-sync to pull upstream & exclude parameters from a pyproject.toml section.

Implementation Notes

I started this work by adding a get_config() method, but it isn't being used yet.
We would need to resolve the config pulled here with any CLI arguments and raise errors if any required arguments cannot be resolved.

ruff-sync/ruff_sync.py

Lines 45 to 61 in 791a3c3

 @lru_cache(maxsize=1) 

 def get_config( 

 source: pathlib.Path, 

 ) -> Mapping[Literal["upstream", "source", "exclude"], str | list[str]]: 

 local_toml = source / "pyproject.toml" 

 # TODO: use pydantic to validate the toml file 

 cfg_result = {} 

 if local_toml.exists(): 

 toml = tomlkit.parse(local_toml.read_text()) 

 config = toml.get("tool", {}).get("ruff-sync") 

 if config: 

 for arg, value in config.items(): 

 if arg in Arguments.fields(): 

 cfg_result[arg] = value 

 else: 

 warnings.warn(f"Unknown ruff-sync configuration: {arg}", stacklevel=2) 

 return cfg_result

Use `pydantic_settings`

If we don't care about pulling in extra dependences we should use the new pydantic_settings.TomlConfigSetttingSource base class for pulling and validating toml config.

https://docs.pydantic.dev/latest/api/pydantic_settings/#pydantic_settings.TomlConfigSettingsSource

	@lru_cache(maxsize=1)
	def get_config(
	source: pathlib.Path,
	) -> Mapping[Literal["upstream", "source", "exclude"], str \| list[str]]:
	local_toml = source / "pyproject.toml"
	# TODO: use pydantic to validate the toml file
	cfg_result = {}
	if local_toml.exists():
	toml = tomlkit.parse(local_toml.read_text())
	config = toml.get("tool", {}).get("ruff-sync")
	if config:
	for arg, value in config.items():
	if arg in Arguments.fields():
	cfg_result[arg] = value
	else:
	warnings.warn(f"Unknown ruff-sync configuration: {arg}", stacklevel=2)
	return cfg_result