feat(nuxt): typecheck on hooks and ci

[antoinezanardi]

Summary by CodeRabbit

• New Features

  • Added a type-checking step to the build and pre-commit processes to enhance code quality and reliability.
  • Introduced a new script command for type checking in the project setup.

• Bug Fixes

  • Improved error handling in the GameThiefTurnStartsEvent component to prevent issues when additionalCards is undefined.

• Tests

  • Added a new test case for the GameThiefTurnStartsEvent component to ensure correct behavior when there are no additional cards available.

[coderabbitai]

Important

Review skipped

Review was skipped as selected files did not have any reviewable changes.

Files selected but had no reviewable changes (1)

• tests/stryker/incremental.json

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

Walkthrough

This pull request introduces several enhancements to the codebase, primarily focusing on type-checking integration within the development workflow. A new type-checking step is added to the GitHub Actions workflow, along with modifications to pre-commit hooks and TypeScript type definitions across various components. Additionally, tests are updated to ensure robustness against undefined values. These changes aim to improve code quality and maintainability throughout the project.

Changes

File	Change Summary
.github/workflows/build.yml	Added a new job step "Type check 🪨" to execute pnpm run typecheck in the workflow.
.husky/commit-msg	Removed an empty line at the beginning of the file.
.husky/pre-commit	Added npm run typecheck; to the pre-commit hook to enforce type checking before commits.
.run/Typecheck.run.xml	Introduced a new XML configuration for managing a Typecheck run configuration, specifying npm commands and project settings.
app/components/pages/game/.../GameEventsMonitorCurrentEvent.vue	Updated type definitions to use a more generic Component type instead of a specific event type, enhancing flexibility.
app/components/pages/game/.../GameThiefTurnStartsEvent.vue	Modified the thiefAdditionalCardsCount computed property to handle undefined additionalCards safely, returning 0 if not present.
app/components/pages/game/.../game-events-monitor-current-event.types.ts	Removed the type alias GameEventsMonitorEventTypeComponent, simplifying type exports.
app/components/shared/game/game-event/.../game-event-with-texts.types.ts	Changed the gameEventTextChange event type to enforce a string parameter, removing undefined.
package.json	Added a new script command "typecheck": "nuxt typecheck" for type checking functionality.
tests/unit/specs/components/pages/game/.../GameThiefTurnStartsEvent.nuxt.spec.ts	Added a test case to verify component behavior when additionalCards is undefined, ensuring correct handling of zero cards.

Possibly related PRs

• feat(audio): audio settings in local storage #831: This PR enhances audio settings management, indicating a broader focus on improving code quality and functionality in related areas.

Suggested labels

🚀 feature

Poem

🐰 In the code where bunnies play,
Type checks hop and save the day.
With every commit, we ensure,
Our types are safe, our code is pure.
So let us leap with joy and cheer,
For quality code is finally here! 🎉

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  -- I pushed a fix in commit <commit_id>, please review it.
  -- Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  -- @coderabbitai generate unit testing code for this file.
  -- @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  -- @coderabbitai generate interesting stats about this repository and render them as a table.
  -- @coderabbitai read src/utils.ts and generate unit testing code.
  -- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  -- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

Tip

Early access features: enabled

We are currently testing the following features in early access:

• OpenAI o1 for code reviews: OpenAI's new o1 model is being tested for code reviews. This model has advanced reasoning capabilities and can provide more nuanced feedback on your code.

Note:

• You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
• • Please join our Discord Community to provide feedback and report issues on the discussion post.

[coderabbitai]

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (3)

app/components/shared/game/game-event/GameEventWithTexts/game-event-with-texts.types.ts (1)

6-6: Issues found with gameEventTextChange type update

The type change from string | undefined to string for gameEventTextChange is not fully reflected across the codebase. There are test cases that still emit undefined, and the type definition in game-event-texts-manager.types.ts remains unchanged, allowing undefined. This inconsistency suggests that the broader impact of the type change has not been fully addressed.

• Test Case: tests/unit/specs/components/shared/game/game-event/GameEventWithTexts/GameEventWithTexts.nuxt.spec.ts emits undefined.
• Type Definition: app/components/shared/game/game-event/GameEventWithTexts/GameEventTextsManager/game-event-texts-manager.types.ts still allows string | undefined.

Please ensure all components and tests are updated to align with the new type definition.

Analysis chain

Approved change with a suggestion to verify broader impact.

The change from string | undefined to string for gameEventTextChange enforces stricter type safety. However, it's crucial to verify that all components emitting this event are updated accordingly to ensure they do not pass undefined.

Run the following script to verify the usage of gameEventTextChange:

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all components emitting `gameEventTextChange` are updated.

# Test: Search for the event usage. Expect: No occurrences of passing `undefined`.
rg --type ts -A 5 $'gameEventTextChange'

Length of output: 3586

.husky/pre-commit (1)

5-5: Approved addition with a suggestion for optimization.

The inclusion of npm run typecheck; in the pre-commit hook is a positive step towards enhancing type safety. Ensure that the typecheck script is optimized for pre-commit usage to avoid significant delays in the commit process.

Consider optimizing the typecheck script to run only on staged files to reduce the execution time during pre-commit.

.run/Typecheck.run.xml (1)

1-13: Approved configuration with a suggestion for documentation.

The new Typecheck.run.xml configuration is well-structured and supports the project's integration of type checking. It's advisable to document the choice of pnpm as the package manager, especially if it differs from what is used elsewhere in the project.

Document the rationale behind using pnpm for this configuration to ensure clarity for all project contributors.

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between cd8a2cb and f1045b2.

Files selected for processing (10)

• .github/workflows/build.yml (1 hunks)
• .husky/commit-msg (1 hunks)
• .husky/pre-commit (1 hunks)
• .run/Typecheck.run.xml (1 hunks)
• app/components/pages/game/GamePlaying/GameEventsMonitor/GameEventsMonitorCurrentEvent/GameEventsMonitorCurrentEvent.vue (2 hunks)
• app/components/pages/game/GamePlaying/GameEventsMonitor/GameEventsMonitorCurrentEvent/GameTurnStartsEvent/GameThiefTurnStartsEvent/GameThiefTurnStartsEvent.vue (1 hunks)
• app/components/pages/game/GamePlaying/GameEventsMonitor/GameEventsMonitorCurrentEvent/game-events-monitor-current-event.types.ts (1 hunks)
• app/components/shared/game/game-event/GameEventWithTexts/game-event-with-texts.types.ts (1 hunks)
• package.json (2 hunks)
• tests/unit/specs/components/pages/game/GamePlaying/GameEventsMonitor/GameEventsMonitorCurrentEvent/GameTurnStartsEvent/GameThiefTurnStartsEvent/GameThiefTurnStartsEvent.nuxt.spec.ts (1 hunks)

Files skipped from review due to trivial changes (2)

• .husky/commit-msg
• app/components/pages/game/GamePlaying/GameEventsMonitor/GameEventsMonitorCurrentEvent/game-events-monitor-current-event.types.ts

Additional comments not posted (5)

app/components/pages/game/GamePlaying/GameEventsMonitor/GameEventsMonitorCurrentEvent/GameTurnStartsEvent/GameThiefTurnStartsEvent/GameThiefTurnStartsEvent.vue (1)

25-30: Improved robustness in computed property.

The addition of a conditional check to ensure additionalCards is defined before filtering enhances the robustness of the component. This change prevents potential runtime errors from attempting to access properties on undefined.

tests/unit/specs/components/pages/game/GamePlaying/GameEventsMonitor/GameEventsMonitorCurrentEvent/GameTurnStartsEvent/GameThiefTurnStartsEvent/GameThiefTurnStartsEvent.nuxt.spec.ts (1)

80-93: Enhanced test coverage for edge cases.

The new test case effectively verifies the component's behavior when additionalCards is undefined, ensuring that it handles this edge case correctly. This addition is crucial for maintaining robust test coverage and preventing regressions.

app/components/pages/game/GamePlaying/GameEventsMonitor/GameEventsMonitorCurrentEvent/GameEventsMonitorCurrentEvent.vue (1)

24-24: Refactored type definitions for flexibility.

The changes to use a more generic Component type from Vue instead of a specific event type component increase the flexibility of component handling. This approach allows for a broader range of components to be utilized within the game event monitoring logic, although it may slightly reduce type specificity.

Also applies to: 51-52

.github/workflows/build.yml (1)

107-109: Approval: Type check step added correctly.

The addition of the "Type check 🪨" step in the GitHub Actions workflow is correctly implemented and well-placed to ensure type safety before the build process begins. The use of pnpm run typecheck aligns with the new script command added in package.json.

package.json (1)

35-35: Approval: New typecheck script added correctly.

The addition of the "typecheck": "nuxt typecheck" command in the scripts section of package.json is correctly implemented. This script enhances the development workflow by providing a straightforward tool for type safety checks.

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[antoinezanardi]

🎉 This PR is included in version 1.32.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀