docs: coderabbit badge + markdown lints (#125)

tsinis · coderabbitai[bot] · web-flow · commit ec80c1e735ad · 2026-03-14T19:12:39.000+01:00
* style(pubspec): fix indentation and quote style in topics and
screenshots

* test: add type check for random status code result

- Verifies that StatusCode.random returns an int as well as StatusCode

* docs: standardize markdown headings and formatting in github templates
and docs

- Update issue template headings from `####` to `##` and `###` for
  proper hierarchy
- Add markdown titles to pull request template and MCP prompt files
- Fix minor formatting inconsistencies in CHANGELOG.md and code of
  conduct
- Improve markdown structure consistency across documentation

* chore: update development configuration and dependencies

- Replace VS Code tasks with Zed editor support (.vscode/ → .zed/)
- Add .vscode/ to .gitignore for local editor settings
- Update .pubignore to exclude Zed configuration instead of VS Code
- Bump Dart SDK minimum version from 3.11.0 to 3.11.1 in example
- Add CodeRabbit PR review badge to README
- Fix trailing newlines in configuration files
- Update CHANGELOG with new badge documentation

* chore: clarify refactor.md

Co-authored-by: coderabbitai[bot] &lt;136622811+coderabbitai[bot]@users.noreply.github.com&gt;

* chore: clarify performance.md

Co-authored-by: coderabbitai[bot] &lt;136622811+coderabbitai[bot]@users.noreply.github.com&gt;

* fix(json): remove trailing commas from json config

- Remove trailing comma from first debug configuration
- Remove trailing comma from second debug configuration
- Ensure valid JSON syntax

---------

Co-authored-by: coderabbitai[bot] &lt;136622811+coderabbitai[bot]@users.noreply.github.com&gt;
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -5,11 +5,11 @@ title: 'fix: '
 labels: bug
 ---
 
-#### Description
+## Description
 
 A clear and concise description of what the bug is.
 
-#### Steps To Reproduce
+### Steps To Reproduce
 
 1. Go to '...'
 2. Add '....'
diff --git a/.github/ISSUE_TEMPLATE/build.md b/.github/ISSUE_TEMPLATE/build.md
@@ -5,10 +5,10 @@ title: 'build: '
 labels: build
 ---
 
-#### Description
+## Description
 
 Describe what changes need to be done to the build system and why.
 
-#### Requirements
+### Requirements
 
 - [ ] The build system is passing.
diff --git a/.github/ISSUE_TEMPLATE/chore.md b/.github/ISSUE_TEMPLATE/chore.md
@@ -5,10 +5,10 @@ title: 'chore: '
 labels: chore
 ---
 
-#### Description
+## Description
 
 Clearly describe what change is needed and why. If this changes code then please use another issue type.
 
-#### Requirements
+### Requirements
 
 - [ ] No functional changes to the code.
diff --git a/.github/ISSUE_TEMPLATE/ci.md b/.github/ISSUE_TEMPLATE/ci.md
@@ -5,10 +5,10 @@ title: 'ci: '
 labels: ci
 ---
 
-#### Description
+## Description
 
 Describe what changes need to be done to the ci/cd system and why.
 
-#### Requirements
+### Requirements
 
 - [ ] The ci system is passing.
diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md
@@ -5,10 +5,10 @@ title: 'docs: '
 labels: documentation
 ---
 
-#### Description
+## Description
 
 Clearly describe what documentation you are looking to add or improve.
 
-#### Requirements
+### Requirements
 
 - [ ] Requirements go here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -5,11 +5,11 @@ title: 'feat: '
 labels: feature
 ---
 
-#### Description
+## Description
 
 Clearly describe what you are looking to add. The more business/user context the better.
 
-#### Requirements
+### Requirements
 
 - [ ] Checklist of requirements to be fulfilled.
 
diff --git a/.github/ISSUE_TEMPLATE/performance.md b/.github/ISSUE_TEMPLATE/performance.md
@@ -5,10 +5,10 @@ title: 'perf: '
 labels: performance
 ---
 
-#### Description
+## Description
 
-Clearly describe what code needs to be changed and what the performance impact is going to be. Bonus point's if you can tie this directly to user experience.
+Clearly describe what code needs to be changed and what the performance impact will be. Bonus points if you can tie this directly to user experience.
 
-#### Requirements
+### Requirements
 
 - [ ] There is no drop in the unit or widget test coverage percentage.
diff --git a/.github/ISSUE_TEMPLATE/refactor.md b/.github/ISSUE_TEMPLATE/refactor.md
@@ -5,10 +5,10 @@ title: 'refactor: '
 labels: refactor
 ---
 
-#### Description
+## Description
 
-Clearly describe what needs to be refactored any why. Please provide links to related issues (bugs or upcoming features) in order to help prioritize.
+Clearly describe what needs to be refactored and why. Please provide links to related issues (bugs or upcoming features) to help prioritize.
 
-#### Requirements
+### Requirements
 
 - [ ] There is no drop in the unit or widget test coverage percentage.
diff --git a/.github/ISSUE_TEMPLATE/revert.md b/.github/ISSUE_TEMPLATE/revert.md
@@ -5,11 +5,11 @@ title: 'revert: '
 labels: revert
 ---
 
-#### Description
+## Description
 
 Provide a link to a PR/Commit that you are looking to revert and why.
 
-#### Requirements
+### Requirements
 
 - [ ] Change has been reverted.
 - [ ] No change in unit/widget test coverage has happened.
diff --git a/.github/ISSUE_TEMPLATE/style.md b/.github/ISSUE_TEMPLATE/style.md
@@ -5,10 +5,10 @@ title: 'style: '
 labels: style
 ---
 
-#### Description
+## Description
 
 Clearly describe what you are looking to change and why.
 
-#### Requirements
+### Requirements
 
 - [ ] There is no drop in the unit test coverage percentage.
diff --git a/.github/ISSUE_TEMPLATE/test.md b/.github/ISSUE_TEMPLATE/test.md
@@ -5,10 +5,10 @@ title: 'test: '
 labels: test
 ---
 
-#### Description
+## Description
 
 List out the tests that need to be added or changed. Please also include any information as to why this was not covered in the past.
 
-#### Requirements
+### Requirements
 
 - [ ] There is no drop in the unit test coverage percentage.
diff --git a/.github/code_of_conduct.md b/.github/code_of_conduct.md
@@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
 ### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
+standards, including sustained inappropriate behavior, harassment of an
 individual, or aggression toward or disparagement of classes of individuals.
 
 **Consequence**: A permanent ban from any sort of public interaction within
diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml
@@ -27,4 +27,4 @@ updates:
       prefix: "chore"
       include: "scope"
     labels:
-      - "dependencies"
+      - "dependencies"
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,3 +1,5 @@
+# Pull Request
+
 <!--
 
   Thanks for contributing!
diff --git a/.gitignore b/.gitignore
@@ -43,6 +43,7 @@ doc/api/
 *.ipr
 *.iws
 .idea/
+.vscode/
 
 # Visual Studio Code related
 .classpath
diff --git a/.pubignore b/.pubignore
@@ -1,2 +1,2 @@
 .github/
-.vscode/
+.zed/
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
diff --git a/.zed/debug.json b/.zed/debug.json
@@ -0,0 +1,17 @@
+[
+  {
+    "adapter": "Dart",
+    "label": "Run example (simple)",
+    "type": "dart",
+    "args": ["--simple"],
+    "request": "launch",
+    "program": "$ZED_WORKTREE_ROOT/example/lib/main.dart"
+  },
+  {
+    "adapter": "Dart",
+    "label": "Run example (real client)",
+    "type": "dart",
+    "request": "launch",
+    "program": "$ZED_WORKTREE_ROOT/example/lib/main.dart"
+  }
+]
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,7 +11,7 @@
   ```
 
 - **Packaged AI assets** (`extension/mcp/`): The package now ships MCP-compatible resources and prompts for AI coding agents, following the [Dart/Flutter packaged AI assets proposal](https://flutter.dev/go/packaged-ai-assets).
-Once the Dart MCP server implements the proposal, agents will automatically have access to:
+  Once the Dart MCP server implements the proposal, agents will automatically have access to:
   - `@functional_status_codes/api_reference` — full API cheat-sheet
   - `@functional_status_codes/patterns` — idiomatic usage patterns
   - `/functional_status_codes/handle_response` — prompt to generate HTTP response handling code
@@ -27,6 +27,7 @@ Once the Dart MCP server implements the proposal, agents will automatically have
 ### Documentation
 
 - `maybeMapStatusCode` and `maybeWhenStatusCode`: added explicit note that the `isStatusCode` handler takes priority over all category handlers (`isSuccess`, `isClientError`, etc.) when both are provided.
+- Added new quality-related badges to the `README.md`.
 
 ## 3.1.0
 
@@ -280,7 +281,6 @@ NEW FEATURE: added two new methods for a `Map` like equivalent of `when` and `wh
 Contains **breaking changes** in `maybeMapStatusCode` method on `num`. Please follow migration guide below.
 
 - refactor!: orElse parameter in maybeMapStatusCode now returns input value in order to handle this unregistered status code.
-
 - docs: updated documentation of breaking update.
 - docs: added topics to pubspec.yaml.
 - chore: updated SDK upper-bound to 4.0.0.
diff --git a/README.md b/README.md
@@ -4,6 +4,7 @@
 [![CodeFactor](https://www.codefactor.io/repository/github/tsinis/functional_status_codes/badge)](https://www.codefactor.io/repository/github/tsinis/functional_status_codes)
 [![Pub points](https://img.shields.io/pub/points/functional_status_codes)](https://pub.dev/packages/functional_status_codes/score)
 [![Created](https://img.shields.io/github/created-at/tsinis/functional_status_codes)](https://github.com/tsinis/functional_status_codes/commit/23d35c4fc890d01b8dc93409738e4fc61712e94f)
+![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/tsinis/functional_status_codes?utm_source=oss&utm_medium=github&utm_campaign=tsinis%2Ffunctional_status_codes&labelColor=171717&color=FF570A&link=https%3A%2F%2Fcoderabbit.ai&label=CodeRabbit+Reviews)
 [![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
 [![Size](https://img.shields.io/github/languages/code-size/tsinis/functional_status_codes)](https://github.com/tsinis/functional_status_codes#why-should-i-use-this-package)
 [![Pub package](https://img.shields.io/pub/v/functional_status_codes.svg)](https://pub.dev/packages/functional_status_codes)
diff --git a/example/pubspec.yaml b/example/pubspec.yaml
@@ -3,7 +3,7 @@ description: A simple one and modified http package example with use of function
 publish_to: none
 
 environment:
-  sdk: ^3.11.0
+  sdk: ^3.11.1
 
 dependencies:
   functional_status_codes:
@@ -13,4 +13,4 @@ dependencies:
 dev_dependencies:
   dart_code_metrics_presets: ^2.29.0 # DCM.
   lints: ^6.1.0 # From Google.
-  test: ^1.30.0 # From Google.
+  test: ^1.30.0 # From Google.
diff --git a/extension/mcp/prompts/cache_strategy.md b/extension/mcp/prompts/cache_strategy.md
@@ -1,3 +1,5 @@
+# Cache Strategy
+
 Derive a caching strategy for HTTP status code **{{status_code}}** using the `functional_status_codes` package and RFC 7231 semantics.
 
 {{#cache_backend}}
diff --git a/extension/mcp/prompts/handle_response.md b/extension/mcp/prompts/handle_response.md
@@ -1,3 +1,5 @@
+# Handle Response
+
 Generate idiomatic Dart code to handle an HTTP response using the `functional_status_codes` package.
 
 {{#http_client}}
diff --git a/pubspec.yaml b/pubspec.yaml
diff --git a/test/src/status_code_test.dart b/test/src/status_code_test.dart
