Development: Ignore build directory in Jest's module path

[magaupp]

Checklist

General

• Language: I followed the guidelines for inclusive, diversity-sensitive, and appreciative language.
• I chose a title conforming to the naming conventions for pull requests.

Motivation and Context

Currently, client tests always start with this message:

jest-haste-map: Haste module naming collision: artemis-exercise
  The following files share their name; please adjust your hasteImpl:
    * <rootDir>/build/resources/main/templates/javascript/exercise/package.json
    * <rootDir>/build/resources/main/templates/javascript/solution/package.json

jest-haste-map: Haste module naming collision: artemis-test
  The following files share their name; please adjust your hasteImpl:
    * <rootDir>/build/resources/main/templates/javascript/test/package.json
    * <rootDir>/build/resources/main/templates/typescript/test/package.json

Jest detects the package.json files in the build directory and tries to add them as modules.

Description

The modulePathIgnorePatterns option of Jest is used to ignore the build directory, like it's already done with the template resources.

Review Progress

Code Review

• Code Review 1
• Code Review 2

Summary by CodeRabbit

• Chores
  • Updated Jest configuration to expand ignored module paths.

[coderabbitai]

Walkthrough

The changes in this pull request involve modifications to the jest.config.js file, specifically updating the modulePathIgnorePatterns to include an additional path, <rootDir>/build/, alongside the existing ignored path. This adjustment expands the directories Jest will ignore when resolving modules, while maintaining the existing configuration structure and settings without altering their logic or functionality.

Changes

File	Change Summary
jest.config.js	Updated modulePathIgnorePatterns to include <rootDir>/build/ along with <rootDir>/src/main/resources/templates/.

Possibly related PRs

• Development: Merge test classes for same service #9359: This PR modifies the jest.config.js file to update the modulePathIgnorePatterns, which is directly related to the changes made in the main PR that also updates this configuration.
• Development: Synchronize windfiles and build scripts #9466: This PR mentions ignoring modules in the templates folder, which aligns with the changes in the main PR that expands the ignored paths in jest.config.js.

Suggested labels

chore, ready for review, small, ready to merge

Suggested reviewers

• BBesrour
• florian-glombik
• SimonEntholzer

---

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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 generate docstrings to generate docstrings for this PR. (Experiment)
• @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 or @coderabbitai title 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.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 037d35d and 5008149.

📒 Files selected for processing (1)

• jest.config.js (1 hunks)

🔇 Additional comments (1)

jest.config.js (1)

131-131: LGTM! This change appropriately addresses the module naming collisions.

The addition of <rootDir>/build/ to modulePathIgnorePatterns is the correct approach to prevent Jest from detecting duplicate modules in the build directory. This aligns with Jest's recommended practices for handling module resolution conflicts.