docs(readme): document allowed-packages

[javier-godoy]

Summary by CodeRabbit

• Documentation
  • Added a new section that details special configuration instructions for Spring users. This guide explains how to adjust package scanning settings in your application properties to ensure proper display of UI components, and includes an example configuration and a reference link for more details.

[coderabbitai]

Walkthrough

A new section titled "Special configuration when using Spring" has been added to the README file. This section explains that Vaadin Flow, by default, only scans the com/vaadin/flow/component package for UI components and views, and instructs users to include the com.flowingcode package by adding it to the vaadin.allowed-packages property in the application's configuration file. An example configuration and a link to additional Spring scanning configuration information are also provided.

Changes

File(s)	Change Summary
README.md	Added a new section "Special configuration when using Spring" detailing how to include the com.flowingcode package in the vaadin.allowed-packages to ensure proper functionality with Spring.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

README.md (2)

117-120: Enhance Clarity and Brevity of the Section Description.
The new "Special configuration when using Spring" section is a useful addition. However, the sentence on line 119 appears a bit wordy. Consider shortening it for clarity, for example:

"By default, Vaadin Flow scans only com/vaadin/flow/component for UI components. To display the add-on properly, add com.flowingcode to your allowed packages."

🧰 Tools

🪛 LanguageTool

[style] ~119-~119: Consider a shorter alternative to avoid wordiness.
Context: ...on, the add-on might need to be allowed in order to display correctly. To do so, just add...

(IN_ORDER_TO_PREMIUM)

---

123-125: Improve Code Block Formatting for Syntax Highlighting.
The configuration snippet would benefit from specifying a language in the fenced code block. For example, changing the block header from “” to “properties” will enhance readability. Consider applying the following diff:

-```
+```properties
   vaadin.allowed-packages = com.vaadin,org.vaadin,dev.hilla,com.flowingcode
-```
+```

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

123-123: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

---

123-123: Code block style
Expected: indented; Actual: fenced

(MD046, code-block-style)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5263510 and 695824f.

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

README.md

[style] ~119-~119: Consider a shorter alternative to avoid wordiness.
Context: ...on, the add-on might need to be allowed in order to display correctly. To do so, just add...

(IN_ORDER_TO_PREMIUM)

🪛 markdownlint-cli2 (0.17.2)

README.md

123-123: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

---

123-123: Code block style
Expected: indented; Actual: fenced

(MD046, code-block-style)