Improve local installation

[sorinmarta]

This PR makes the module easier to install and configure by moving the files to the root directory and by adding a php artisan install command.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

The changes add a new Artisan console command (freescout-github:install) to manage GitHub module migrations, update the service provider to register console commands, modify installation documentation to reflect a module-enablement workflow, and add vendor to gitignore.

Changes

Cohort / File(s)	Summary
Configuration \.gitignore	Added vendor directory to ignore patterns
Console Command Registration Providers/GithubServiceProvider.php	Introduced registerCommands() method to register Artisan commands; updated imports and added console-mode boot logic
New Console Command Console/InstallCommand.php	New Artisan command freescout-github:install with --force flag; handles module discovery, migration execution with error handling, and user feedback
Documentation README.md	Replaced direct migration step with module enablement workflow: module:enable, cache clearing, and dedicated install command; reordered configuration step to follow setup

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

• Console/InstallCommand.php: Verify module existence checks and error handling logic; confirm exit codes align with Laravel conventions
• Providers/GithubServiceProvider.php: Confirm registerCommands() is called correctly during console boot and command registration syntax

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Improve local installation' is related to the changeset, which adds an install command and updates installation documentation, but is vague and doesn't specify the primary change.	Consider a more specific title like 'Add freescout-github:install command and update installation steps' to better convey the main changes.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description check	✅ Passed	The description accurately relates to the changeset by mentioning the addition of a php artisan install command and module setup improvements.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

---

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

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7a31ba2 and 3d31f01.

⛔ Files ignored due to path filters (1)

• composer.lock is excluded by !**/*.lock

📒 Files selected for processing (4)

• .gitignore (1 hunks)
• Console/InstallCommand.php (1 hunks)
• Providers/GithubServiceProvider.php (3 hunks)
• README.md (1 hunks)

🧰 Additional context used

🧬 Code graph analysis (1)

Providers/GithubServiceProvider.php (1)

Console/InstallCommand.php (1)

• InstallCommand (9-69)

🔇 Additional comments (8)

.gitignore (1)

3-3: LGTM! Standard practice for PHP projects.

Adding the vendor directory to .gitignore is correct and prevents third-party dependencies from being committed to the repository.

Providers/GithubServiceProvider.php (3)

6-6: LGTM! Correct import for the new functionality.

The import has been properly updated to include InstallCommand for the new console command registration.

---

27-29: LGTM! Proper console command registration.

The check for runningInConsole() ensures commands are only registered in CLI context, which is the correct approach for Artisan command registration.

---

195-205: LGTM! Clean command registration implementation.

The registerCommands() method follows Laravel conventions for registering Artisan commands via service providers.

README.md (1)

48-63: LGTM! Clear and improved installation workflow.

The updated installation steps provide a better user experience with the dedicated installation command. The flow (enable module → clear cache → run installation) is logical and well-documented.

Console/InstallCommand.php (3)

1-23: LGTM! Proper command structure and documentation.

The command signature, description, and class structure follow Laravel Artisan command conventions correctly.

---

30-45: LGTM! Proper module validation and setup.

The module lookup, validation, and parameter preparation logic is correct. The error handling for missing modules is appropriate.

---

52-68: LGTM! Excellent error handling and user feedback.

The try-catch block properly handles exceptions with logging via Helper::logException, and the success/failure messages provide clear feedback to users about the migration status.

[sorinmarta]

These changes will be merged in #9