目录
- .githubCI: Drop 3.6 and 3.7 versions6个月前
- dataAdd %dnl to excludes-bracketing.txt6个月前
- obsCall /bin/sh directly instead of env to fix rpmlint errors6年前
- spec_cleanerPost release version bump4个月前
- testsAdd %dnl to excludes-bracketing.txt6个月前
- .banditAdd bandit file to control warnings reported by it6年前
- .gitignoreignore mypy cache dir5年前
- .isort.cfgpre-commit: add isort hook4年前
- .landscape.yamlSay goodbye to python2 issue #2346年前
- .pre-commit-config.yamlpre-commit: add isort hook4年前
- AUTHORSUpdate licences and AUTHORS5年前
- COPYINGCleanup whitespace to comfor pep8 and fix trailing \n in files.11年前
- MANIFEST.inUpdate MANIFEST.in to reflect reality8年前
- MakefileAdd new script for rpmlint.4年前
- README.mdUpdate README.md1年前
- README.md.inUse pytest-isort to check import ordering in tests4年前
- RELEASE.mdEnhance RELEASE.md5年前
- TESTSUITE.mdRemove year mention from the testsuite guide, now we don't use header there8年前
- conversions-update.plTweak generators of the conversions8年前
- conversions-update.shSwitch to Leap 15.0 as a base for conversions6年前
- devel-requirements.pipFix tests with new python-rpm-spec6个月前
- generate-licenses-for-rpmlint.pyAdd new script for rpmlint.4年前
- license-update.shReplace calls to w3m with calls to curl.1年前
- pyproject.tomlMove setup.py configuration to pyproject.toml3个月前
- pytest.iniUse pytest-isort to check import ordering in tests4年前
- rpmcleaner.pyBy default remove groups from packages. Issue #2565年前
- setup.cfgFix pep8 errors to pass flake8 tests (#296)2年前
- spec-cleaner-exec-profile.svgAdd calls profile of spec-cleaner 0.8.9.8年前
邀请码
spec-cleaner
spec-cleaner is a tool that cleans the given RPM spec file according to the style guide and returns the result.
It’s used for openSUSE, where it’s planned to be a replacement for
osc service localrun format_spec_fileand it is intended to provide the same or better features in order to be able to unify all the spec files in OBS.Table of contents
Installation and usage
Installation
The latest version is available on PyPI. It can be installed by running
pip install spec_cleaner.spec-cleaner is also provided as an RPM package for openSUSE Leap (15.0 and 15.1) and openSUSE Tumbleweed. When the new version of spec-cleaner is released then the version updates are performed for all maintained openSUSE codestreams. That means that there is always the latest version available in openSUSE:Leap.
Usage
Simply run
spec-cleaner -i <specfile>to clean your specfile up.Tests
Running the tests
spec-cleaner provides quite an extensive testsuite. You can run these tests locally either directly via
pytest.pytest
Just install
python3-pytest,python3-pytest-cov,python3-pytest-isortandpython3-pytest-sugar(for a nice progress bar) and then run all tests via:Contributing
You are more than welcome to contribute to this project. If you are not sure about your changes, feel free to create an issue where you can discuss it before the implementation.
Contribution Guidelines
When changing anything in the code, make sure that you don’t forget to:
pre-commit installto installpre-commitinto your git hooks.mypysupport for the new code.flake8andmypychecks.See below for more details.
pre-commit
spec-cleaner project adopted
pre-commitframework for managing and maintaining pre-commit hooks. After you clone the spec-cleaner repository, please install pre-commit framework (pip install pre-commit) and runpre-commit installto installpre-commitinto your git hooks. Thenpre-commitwill run automatically ongit commitand it will check your contribution withisort,black,flake8,flake8-docstringsandmypy.Please note that similar checks run in CI when you submit a PR and it won’t pass code review without passing these checks.
mypy
Optional static type checker support was implemented for the most important parts of the code. If you want to run it on your own, just install
python3-mypyand runBlack
The code of spec-cleaner is formated with Black. We use
--skip-string-normalizationand--line-length 100options. Black runs automatically in thepre-commithook.Adding new tests
When a new feature is added to spec-cleaner then a test for this piece of code must be added. See how to write tests for spec-cleaner.
Versioning and releasing
For the versions available, see the tags on this repository.
If you have proper permissions you can find handy how to do a new release.
Authors
SPDX Licenses
SPDX Exceptions
SUSE Additions