Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/getcodelimit/codelimit
Your Refactoring Alarm π
https://github.com/getcodelimit/codelimit
codequality precommit precommit-hooks python refactoring
Last synced: 4 months ago
JSON representation
Your Refactoring Alarm π
- Host: GitHub
- URL: https://github.com/getcodelimit/codelimit
- Owner: getcodelimit
- License: gpl-3.0
- Created: 2022-10-29T12:57:44.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-16T17:41:01.000Z (4 months ago)
- Last Synced: 2024-10-28T03:49:27.407Z (4 months ago)
- Topics: codequality, precommit, precommit-hooks, python, refactoring
- Language: Python
- Homepage: https://codelimit.vercel.app
- Size: 5.69 MB
- Stars: 35
- Watchers: 1
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Code Limit

*Your Refactoring Alarm π*
[](https://github.com/getcodelimit/codelimit/actions/workflows/main.yml)
[](https://codecov.io/gh/getcodelimit/codelimit)
[](https://mypy-lang.org/)
[](https://github.com/psf/black)
[](https://github.com/astral-sh/ruff)
[](https://github.com/getcodelimit/codelimit)## Introduction
Code Limit is a tool for developers with one goal: _it tells the developer when
itβs time to refactor_.Check out the [documentation](https://codelimit-docs.vercel.app) and start
using Code Limit today to keep your code maintainable.## Quickstart
Depending on your development workflow, Code Limit can run in many different
ways (e.g.: pre-commit hook, GitHub Action, standalone, etc.). See the
[Quickstart documentation](https://codelimit-docs.vercel.app/quickstart/) for
examples.## Standalone usage
Code Limit can run as a standalone program to check and inspect a codebase, see
the [Standalone Usage documentation](https://codelimit-docs.vercel.app/usage/)
to get started.## Configuration
Code Limit aims to be zero-configuration. However, sometimes the exception
proves the rule. Check out the [Configuration
documentation](https://codelimit-docs.vercel.app/configuration/) for all
configuration options.## Development
See the [Development
documentation](https://codelimit-docs.vercel.app/development) if you want to
extend or contribute to Code Limit.## Feedback, suggestions and bug reports
If you have suggestions for how Code Limit could be improved, or want to report
a bug, [open an issue](https://github.com/getcodelimit/codelimit/issues)! All
and any contributions are appreciated.To show your project uses Code Limit place this badge in the README markdown:
[](https://github.com/getcodelimit/codelimit)
```
](https://github.com/getcodelimit/codelimit)
```## License
[GPL-3.0-or-later](LICENSE) Β© 2022 Rob van der Leek
(https://twitter.com/robvanderleek)