Code Limit

</div> <div align="center">

Your Refactoring Alarm 🔔

</div> <div align="center">

</div>

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 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 for examples.

Standalone usage

Code Limit can run as a standalone program to check and inspect a codebase, see the Standalone Usage documentation to get started.

Configuration

Code Limit aims to be zero-configuration. However, sometimes the exception proves the rule. Check out the Configuration documentation for all configuration options.

Development

See the Development documentation 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! All and any contributions are appreciated.

To show your project uses Code Limit place this badge in the README markdown:

![Checked with Code Limit](https://img.shields.io/badge/Code%20Limit-checked-green.svg)](https://github.com/getcodelimit/codelimit)

Codelimit

Install / Use

README