Modernize codebase and fix issues

[aarondfrancis]

Summary

• Fix risky test by removing ob_get_clean() call in BasicTest
• Make compiledViewPath nullable to handle edge cases where config may not be set
• Remove redundant CliDumper import alias in CustomDumper
• Add void return types to service provider register() and boot() methods
• Add void return types to command handle() methods
• Add parameter types to CustomDumper::register()
• Move DumpTestOnly command to test-only service provider (keeps it out of production)
• Add prefer-stable: true to composer.json (recommended with minimum-stability: dev)
• Fix .phpunit.cache gitignore pattern to ignore entire directory
• Remove empty dev script from composer.json
• Add CLAUDE.md documentation for Claude Code

Test plan

• All PHPUnit tests pass
• No risky test warnings

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation

  • Added developer guidance documentation for repository interactions.

• Refactor

  • Improved type safety with explicit return type declarations across components.
  • Enhanced type annotations in method signatures and constructors.

• Bug Fixes

  • Fixed output buffer handling in integration tests.

• Chores

  • Updated dependency stability preference in package configuration.
  • Removed unused development script entry.
  • Updated test environment configuration.
  • Refined gitignore patterns for cache files.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Warning

Rate limit exceeded

@aarondfrancis has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 1 minutes and 35 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 258f06a and b258b1c.

📒 Files selected for processing (1)

• CLAUDE.md (1 hunks)

Walkthrough

This PR adds explicit return type declarations across command and service provider classes, reorganizes command registration to use a test-specific provider, updates package configuration preferences, and refines the CustomDumper implementation with strict type annotations.

Changes

Cohort / File(s)	Summary
Type Annotation Updates src/Console/Commands/DumpTestOnly.php, src/Console/Commands/Dumps.php, src/Providers/DumpServiceProvider.php, tests/Support/DumpTestServiceProvider.php	Added explicit void return types to handle() and boot()/register() methods across console commands and service providers, enforcing stricter type safety.
Service Provider Refactoring src/Providers/DumpServiceProvider.php, testbench.yaml, tests/Support/DumpTestServiceProvider.php	Removed DumpTestOnly command registration from main provider; moved to new test-specific DumpTestServiceProvider registered only in testbench configuration. Conditional registration checks console context.
CustomDumper Implementation src/Support/CustomDumper.php	Removed LaravelCliDumper alias and now directly instantiate CliDumper; added type annotations to register() method parameters and constructor; made $compiledViewPath property explicitly nullable.
Configuration & Documentation .gitignore, CLAUDE.md, composer.json	Updated git ignore pattern to .phpunit.cache; added prefer-stable: true to composer.json; removed legacy dev script; added CLAUDE.md with development guidance.
Test Adjustments tests/Integration/BasicTest.php	Removed ob_get_clean() call from output buffer handling in start_and_stop_test, altering buffer consumption timing.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

• Service provider reorganization (DumpServiceProvider and DumpTestServiceProvider): Verify command registration logic and test context detection are correct
• CustomDumper type changes: Confirm nullable $compiledViewPath doesn't introduce unexpected behavior; validate CliDumper instantiation is compatible with previous LaravelCliDumper usage
• Output buffer removal in BasicTest.php: Ensure test assertions still capture expected output correctly after buffer handling change
• Multiple signature updates: Verify type declarations align across the codebase and don't break polymorphism

Poem

🐰 With types declared, commands stand tall,
Test helpers moved to their own hall,
The cache is cleaned, preferences set,
A rabbit's refactoring, no regret! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.
Title check	❓ Inconclusive	The title is overly broad and vague, using a generic term 'modernize' without specifying the main changes, and 'fix issues' lacks clarity about what specific problems are being addressed.	Use a more specific title that captures the primary change, such as 'Add void return types and refactor service providers' or another concrete description of the main modification.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

CLAUDE.md (1)

1-65: Add a language to the architecture code fence to satisfy linters

Content and structure look solid and very helpful. The architecture diagram block (Line 30) uses a bare triple‑backtick fence, which triggers MD040. Consider marking it as text:

-```
+```text
 dump() call in app
     ↓
 ...
 CliDumper → terminal output with source info

This keeps the diagram readable while silencing markdownlint.

</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

**Configuration used**: CodeRabbit UI

**Review profile**: CHILL

**Plan**: Pro

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between 4565dca20e29b0578aa3080a49b724a48fb46f44 and 258f06ae1aa5e1b8508c057bc5786fad9e9badaf.

</details>

<details>
<summary>📒 Files selected for processing (10)</summary>

* `.gitignore` (1 hunks)
* `CLAUDE.md` (1 hunks)
* `composer.json` (1 hunks)
* `src/Console/Commands/DumpTestOnly.php` (1 hunks)
* `src/Console/Commands/Dumps.php` (1 hunks)
* `src/Providers/DumpServiceProvider.php` (1 hunks)
* `src/Support/CustomDumper.php` (3 hunks)
* `testbench.yaml` (1 hunks)
* `tests/Integration/BasicTest.php` (0 hunks)
* `tests/Support/DumpTestServiceProvider.php` (1 hunks)

</details>

<details>
<summary>💤 Files with no reviewable changes (1)</summary>

* tests/Integration/BasicTest.php

</details>

<details>
<summary>🧰 Additional context used</summary>

<details>
<summary>🧬 Code graph analysis (4)</summary>

<details>
<summary>src/Console/Commands/Dumps.php (1)</summary><blockquote>

<details>
<summary>src/Console/Commands/DumpTestOnly.php (1)</summary>

* `handle` (26-38)

</details>

</blockquote></details>
<details>
<summary>src/Console/Commands/DumpTestOnly.php (1)</summary><blockquote>

<details>
<summary>src/Console/Commands/Dumps.php (1)</summary>

* `handle` (25-49)

</details>

</blockquote></details>
<details>
<summary>src/Providers/DumpServiceProvider.php (3)</summary><blockquote>

<details>
<summary>src/Support/CustomDumper.php (1)</summary>

* `register` (24-27)

</details>
<details>
<summary>workbench/app/Providers/AppServiceProvider.php (2)</summary>

* `register` (19-22)
* `boot` (27-30)

</details>
<details>
<summary>tests/Support/DumpTestServiceProvider.php (1)</summary>

* `boot` (17-24)

</details>

</blockquote></details>
<details>
<summary>tests/Support/DumpTestServiceProvider.php (4)</summary><blockquote>

<details>
<summary>src/Console/Commands/Dumps.php (1)</summary>

* `Dumps` (19-50)

</details>
<details>
<summary>src/Console/Commands/DumpTestOnly.php (1)</summary>

* `DumpTestOnly` (14-39)

</details>
<details>
<summary>src/Providers/DumpServiceProvider.php (1)</summary>

* `boot` (23-32)

</details>
<details>
<summary>workbench/app/Providers/AppServiceProvider.php (1)</summary>

* `boot` (27-30)

</details>

</blockquote></details>

</details><details>
<summary>🪛 markdownlint-cli2 (0.18.1)</summary>

<details>
<summary>CLAUDE.md</summary>

30-30: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

</details>

</details>

</details>

<details>
<summary>🔇 Additional comments (9)</summary><blockquote>

<details>
<summary>.gitignore (1)</summary><blockquote>

`15-15`: **.phpunit cache ignore looks good**

Ignoring the full `.phpunit.cache` directory is consistent with modern PHPUnit behavior and should keep local cache out of version control without side effects.

</blockquote></details>
<details>
<summary>src/Console/Commands/Dumps.php (1)</summary><blockquote>

`25-25`: **Explicit `void` return type on `handle()` is appropriate**

The command never returns an exit code, so tightening the signature to `handle(): void` is consistent and safe given the current implementation.


If you ever decide to use exit codes (e.g., `return self::SUCCESS;`), remember to relax this return type accordingly for compatibility with `Illuminate\Console\Command`.

</blockquote></details>
<details>
<summary>composer.json (1)</summary><blockquote>

`13-13`: **`"prefer-stable": true` pairs well with `minimum-stability: "dev"`**

This will bias Composer toward stable packages while still allowing dev dependencies where required; good choice for a library.

</blockquote></details>
<details>
<summary>src/Console/Commands/DumpTestOnly.php (1)</summary><blockquote>

`26-38`: **`handle(): void` matches current usage**

The command only performs side effects and does not return an exit code, so declaring `handle(): void` is consistent and clarifies intent.


If you later need to return an int status for this test command, you’ll need to relax the return type.

</blockquote></details>
<details>
<summary>src/Support/CustomDumper.php (1)</summary><blockquote>

`24-27`: **Type‑safe registration and nullable compiled view path look good**

- Making `register(string $basePath, ?string $compiledViewPath): static` and the constructor parameters typed/nullable aligns with how `config('view.compiled')` can legitimately be `null`.
- Using constructor property promotion for `$basePath` and `$compiledViewPath` keeps the class concise.
- Instantiating `CliDumper` with `($output, $this->basePath, $this->compiledViewPath)` matches the expected signature and naturally handles a missing compiled view path.

No functional issues spotted with these changes.


Given this is a public API (`CustomDumper::register()`), double‑check any external usages (e.g., in host apps or docs) to ensure they are updated to pass a nullable second argument where needed.


Also applies to: 34-35, 91-91

</blockquote></details>
<details>
<summary>testbench.yaml (1)</summary><blockquote>

`3-3`: **Test‑only provider registration is well scoped**

Registering `SoloTerm\Dumps\Tests\Support\DumpTestServiceProvider` only in `testbench.yaml` cleanly confines the `DumpTestOnly` command to the test environment and keeps production providers lean.

</blockquote></details>
<details>
<summary>tests/Support/DumpTestServiceProvider.php (1)</summary><blockquote>

`13-13`: **Console‑guarded test command registration is correct**

- Importing `DumpTestOnly` and registering it via `$this->commands()` only when `$this->app->runningInConsole()` keeps the command available for tests without leaking into non‑CLI contexts.
- The `boot(): void` signature matches Laravel’s modern style and your other providers.

This setup cleanly separates test‑only tooling from the main package.



Also applies to: 17-23

</blockquote></details>
<details>
<summary>src/Providers/DumpServiceProvider.php (2)</summary><blockquote>

`18-21`: **Explicit `void` return on `register()` looks good**

Using `public function register(): void` matches modern PHP typing and your workbench AppServiceProvider style; no behavioral change introduced here.

---

`23-32`: **`boot(): void` typing and console-only command registration are consistent**

`boot(): void` plus the `CustomDumper::register(...)` call and `runningInConsole()` guard cleanly align with the updated `CustomDumper::register(string, ?string)` signature and keep the `Dumps` command scoped to console usage.

</blockquote></details>

</blockquote></details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->