fix: 🩹 Semantics

Author: robvanderleek

README.md

@@ -1 +1 @@
-# Code Limit Documentation
+# CodeLimit Documentation

docs/assets/scan.cast

@@ -26,7 +26,7 @@
 [5.763746, "o", "\u001b[?2004l\r\r\n"]
 [5.765945, "o", "\u001b]2;codelimit scan .\u0007\u001b]1;codelimit\u0007"]
 [5.766406, "o", "\u001b]0;fastapi: codelimit scan .\u0007"]
-[6.010441, "o", "  \u001b[1mCode Limit\u001b[0m: \u001b[1;36m0.8\u001b[0m.\u001b[1;36m1\u001b[0m\r\n"]
+[6.010441, "o", "  \u001b[1mCodeLimit\u001b[0m: \u001b[1;36m0.8\u001b[0m.\u001b[1;36m1\u001b[0m\r\n"]
 [6.010585, "o", "  \u001b[1mScan date\u001b[0m: \u001b[1;36m2024\u001b[0m-\u001b[1;36m04\u001b[0m-\u001b[1;36m06\u001b[0m \u001b[1;92m18:06:10\u001b[0m\r\n"]
 [6.010803, "o", "  \u001b[1mScan root\u001b[0m: \u001b[35m/Users/rob/projects/opensource/\u001b[0m\u001b[95mfastapi\u001b[0m\r\n\u001b[?25l"]
 [7.022598, "o", "\r\u001b[2K                                                                                \r\n \u001b[1m \u001b[0m\u001b[1mLanguage        \u001b[0m\u001b[1m \u001b[0m \u001b[1m \u001b[0m\u001b[1m   Files\u001b[0m\u001b[1m \u001b[0m \u001b[1m \u001b[0m\u001b[1m       Lines of Code\u001b[0m\u001b[1m \u001b[0m \u001b[1m \u001b[0m\u001b[1m    Functions\u001b[0m\u001b[1m \u001b[0m \u001b[1m \u001b[0m\u001b[1m ⚠\u001b[0m\u001b[1m \u001b[0m \u001b[1m \u001b[0m\u001b[1m ✖\u001b[0m\u001b[1m \u001b[0m \r\n ────────────────────────────────────────────────────────────────────────────── \r\n  JavaScript                2                    341              21    0   \u001b[31m 1\u001b[0m  \r\n                                                                                "]

docs/development.md

@@ -1,6 +1,6 @@
 # Development
 
-After installing dependencies with `poetry install`, Code Limit can be run from
+After installing dependencies with `poetry install`, CodeLimit can be run from
 the repository root like this:
 
 ```shell

docs/faq.md

@@ -1,8 +1,8 @@
 # F.A.Q.
 
-### Q. What programming languages does Code Limit support?
+### Q. What programming languages does CodeLimit support?
 
-Currently Code Limit supports these programming languages:
+Currently CodeLimit supports these programming languages:
 
 - C
 - C++
@@ -11,16 +11,16 @@ Currently Code Limit supports these programming languages:
 - Python
 - TypeScript
 
-### Q. How does Code Limit compare to ...
+### Q. How does CodeLimit compare to ...
 
 **Black**
 
-[Black](https://github.com/psf/black) is a code formatter and can run alongside Code Limit.
+[Black](https://github.com/psf/black) is a code formatter and can run alongside CodeLimit.
 
 **Flake8**
 
 [Flake8](https://github.com/PyCQA/flake8) is a linter and can run alongside
-Code Limit. Flake8 can be extended with third-party plugins.
+CodeLimit. Flake8 can be extended with third-party plugins.
 
 **Lizard**
 
@@ -38,4 +38,4 @@ development.
 **Ruff**
 
 [Ruff](https://github.com/astral-sh/ruff) is a linter and can run alongside
-Code Limit. Ruff has no linting rule for function length.
+CodeLimit. Ruff has no linting rule for function length.

docs/getting-started/development-workflow.md

@@ -2,14 +2,14 @@
 
 ## GitHub Action
 
-Code Limit is available as a [GitHub
+CodeLimit is available as a [GitHub
 Action](https://github.com/getcodelimit/codelimit-action)
 
-When running as a GitHub Action, Code Limit only checks modified files and
+When running as a GitHub Action, CodeLimit only checks modified files and
 *warns* about functions that *should* be refactored and *fails* for functions
 that *need* to be refactored.
 
-To run Code Limit on every push and before every merge to `main`, append it to
+To run CodeLimit on every push and before every merge to `main`, append it to
 your GH Action workflow:
 
 ```yaml
@@ -30,13 +30,13 @@ jobs:
       - name: 'Checkout'
         uses: actions/checkout@v2
 
-      - name: 'Run Code Limit'
+      - name: 'Run CodeLimit'
         uses: getcodelimit/codelimit-action@v1
 ```
 
 ## Pre-commit hook
 
-Code Limit can be installed as a [pre-commit](https://pre-commit.com/) hook so
+CodeLimit can be installed as a [pre-commit](https://pre-commit.com/) hook so
 it alarms you during development when it's time to refactor:
 
 ```yaml
@@ -46,14 +46,14 @@ it alarms you during development when it's time to refactor:
     - id: codelimit
 ```
 
-Code Limit is intended to be used alongside formatting, linters and other hooks
+CodeLimit is intended to be used alongside formatting, linters and other hooks
 that improve the consistency and quality of your code (such as
 [Black](https://github.com/psf/black),
 [Ruff](https://github.com/astral-sh/ruff) and
 [MyPy](https://github.com/python/mypy).) As an example pre-commit configuration
 see the
 [`pre-commit-config.yaml`](https://github.com/getcodelimit/codelimit/blob/main/.pre-commit-config.yaml)
-from Code Limit itself.
+from CodeLimit itself.
 
-When running as a hook, Code Limit *warns* about functions that *should* be
+When running as a hook, CodeLimit *warns* about functions that *should* be
 refactored and *fails* for functions that *need* to be refactord.

docs/getting-started/standalone-usage.md

@@ -4,7 +4,7 @@
 
 ### Homebrew
 
-Code Limit is available on
+CodeLimit is available on
 [Homebrew](https://formulae.brew.sh/formula/codelimit):
 
 ```shell
@@ -13,7 +13,7 @@ brew install codelimit
 
 ### Pipx
 
-To install the standalone version of Code Limit in an isolated Python
+To install the standalone version of CodeLimit in an isolated Python
 environment using [pipx](https://pypa.github.io/pipx) run:
 
 ```
@@ -22,7 +22,7 @@ pipx install codelimit
 
 ### PyPi
 
-To install the standalone version of Code Limit for your default Python
+To install the standalone version of CodeLimit for your default Python
 installation run:
 
 ```shell
@@ -37,7 +37,7 @@ page](https://github.com/getcodelimit/codelimit/releases/latest).
 
 ## Usage
 
-Run Code Limit without arguments to see the usage page:
+Run CodeLimit without arguments to see the usage page:
 
 ```shell
 $ codelimit
@@ -56,7 +56,7 @@ $ codelimit
 │ check          Check file(s)                                                 │
 │ scan           Scan a codebase                                               │
 │ report         Show report for codebase                                      │
-│ app            Code Limit GitHub App commands                                │
+│ app            CodeLimit GitHub App commands                                │
 ╰──────────────────────────────────────────────────────────────────────────────╯
 ```
 

docs/index.md

@@ -32,11 +32,11 @@ Developers can make simple things complex, like unmaintainable code, but they
 are much better at making complex things simple. Refactoring makes complex code
 simple again.
 
-But when to refactor? How much to refactor? What to refactor? That's where Code Limit comes in.
+But when to refactor? How much to refactor? What to refactor? That's where CodeLimit comes in.
 
-## Meet Code Limit
+## Meet CodeLimit
 
-Code Limit is a tool for developers with one goal: _it tells the developer when
+CodeLimit is a tool for developers with one goal: _it tells the developer when
 it’s time to refactor_.
 
 ### Key features and design principles
@@ -52,13 +52,13 @@ hook](getting-started/development-workflow.md#pre-commit-hook), or
 * **Covers many languages**: A single tool for all your projects
 * **Sane defaults**: Zero configuration, but allows customization
 * **Low threshold to get started**: Can only check new or modified code, so
-  even if you have a backlog of technical debt, you can start using Code Limit
+  even if you have a backlog of technical debt, you can start using CodeLimit
 today
 
 *[functions]: Also called methods or procedures, depending on your programming language
 
 ## Next steps
 
 Go to the [Getting Started](getting-started/development-workflow.md) section to
-start using Code Limit, or read more about the [function length
+start using CodeLimit, or read more about the [function length
 metric](why-function-length.md).

docs/why-function-length.md

@@ -17,20 +17,20 @@ It's also a (fairly) non-controversial metric, most developers agree longer
 functions are harder to maintain. Also, there's always a refactoring possible
 to make functions smaller.
 
-## Why Code Limit?
+## Why CodeLimit?
 
 Because function length is such a simple code metric, many code quality tools
 measure it. But these tools measure a lot more metrics, sometimes so much
 metrics that developers are overwhemled and loose focus on the metrics that
 matter most.
 
-Code Limit measures only function length but it tries to be the best developer
+CodeLimit measures only function length but it tries to be the best developer
 tool for measuring it. By notifying developers when it's time to refactor, Code
 Limit prevents unmaintainable code.
 
-## How Code Limit measures function length
+## How CodeLimit measures function length
 
-Code Limit measures the lines of code for each function in your codebase and
+CodeLimit measures the lines of code for each function in your codebase and
 assigns each function to a category:
 
 | Easy | Verbose | Hard-to-maintain <span style="color: #e5832f;">&#x26A0;</span> | Unmaintainable <span style="color: #ff0000;">&#x2716;</span> |

mkdocs.yml

@@ -1,4 +1,4 @@
-site_name: Code Limit Documentation
+site_name: CodeLimit Documentation
 repo_url: https://github.com/getcodelimit/codelimit
 theme:
   name: material
@@ -37,7 +37,7 @@ markdown_extensions:
   - attr_list
   - pymdownx.snippets
 nav:
-    - Code Limit: 'index.md'
+    - CodeLimit: 'index.md'
     - 'why-function-length.md'
     - Getting Started:
       - 'getting-started/development-workflow.md'