Development: Add linting rule for dayjs

[az108]

Checklist

General

• This is a small issue that I tested locally and was confirmed by another developer on a test server.
• 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

While working on this PR (#10269) , I accidentally imported dayjs without /esm. Since we want to avoid this, new developers who might not be aware of it should be informed.

Description

I added a restriction in the ESLint config to prevent importing dayjs directly and included a message kindly asking developers to import dayjs/esm instead. Now, if someone tries to push with dayjs as an import, it won’t be possible anymore.

Review Progress

Code Review

• Code Review 1

Summary by CodeRabbit

• Chores
  • Updated internal quality guidelines to enforce consistent module imports, enhancing overall stability and maintainability.
  • Strengthened development practices to mitigate potential issues without altering user-facing functionality.
  • This implementation reflects our ongoing efforts to refine the development process and ensure a robust, seamless experience for end-users.

[coderabbitai]

Walkthrough

The change updates the ESLint configuration in eslint.config.mjs by adding a new rule. The new rule, 'no-restricted-imports', is configured to trigger an error when the module 'dayjs' is imported directly. Instead, it enforces importing from 'dayjs/esm'. This configuration change aims to ensure that the code adheres to a specific module structure during the linting process.

Changes

File	Summary
eslint.config.mjs	Added the 'no-restricted-imports' rule to disallow direct imports of 'dayjs' in favor of 'dayjs/esm'.

Tip

🌐 Web search-backed reviews and chat

• We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
• You can disable this feature by setting web_search: false in the knowledge_base settings.
• Please share any feedback in the Discord discussion.

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cc1e3cb and f821a6a.

📒 Files selected for processing (1)

• eslint.config.mjs (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (5)

• GitHub Check: Call Build Workflow / Build .war artifact
• GitHub Check: Call Build Workflow / Build and Push Docker Image
• GitHub Check: client-tests
• GitHub Check: server-tests
• GitHub Check: Analyse

🔇 Additional comments (1)

eslint.config.mjs (1)

120-130: LGTM! The ESLint rule is well-configured.

The implementation effectively blocks direct imports of 'dayjs' and provides a clear message guiding developers to use 'dayjs/esm' instead.

Let's verify that the rule catches direct dayjs imports and allows the correct import path:

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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. (Beta)
• @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.

[Strohgelaender]

Good idea, thanks. Works locally.