Initial implementation

[mlopezFC]

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced the Markdown Editor and Viewer components for enhanced Markdown content editing and display.
  • Added demo implementations for both the Markdown Editor and Viewer, showcasing their functionalities.

• Improvements

  • Updated project branding from "Template Add-on" to "Markdown Editor Add-on," including name changes in documentation and templates.
  • Enhanced README with expanded features and updated links.
  • Improved styling for the Markdown Editor to ensure better layout and usability.
  • Updated bug and feature request templates for clearer context.

• Chores

  • Removed outdated demo files associated with the previous template functionality.
  • Added licensing information to shared styles and updated package names for better organization.

[javier-godoy]

There have been some changes in the starter since this repository was created. See https://github.com/FlowingCode/AddonStarter24/compare/ae1a92b1...b859384

[javier-godoy]

Checklist for the initial commit

General

• The repository is based on Flowing Code add-on starter template.
• Commit messages follows Flowing Code Commit Message Guidelines
• Scopes used in commit messages are consistent
• Code is formatted according to Flowing Code Style Guide

POM

• <artifactId> has been replaced
• <artifactId> is suffixed with -addon
• <inceptionYear> is set to the current year.
• "Template Add-on" has been replaced in <name> and <description>.
• <scm> URLs point to this repository.

README

• The README file clearly describe the purpose of the add-on, highlighting its features and benefits.
• Links in badges references this add-on.
• All links in the README are correct and functional.
• Jenkins badge ends in -addon.
• All instances of "Template Add-on" have been replaced with the actual full name of the add-on.
• Double check spelling "add-on" vs "addon"

ISSUE_TEMPLATE

• "Template Add-on" have been replaced with the actual full name of the add-on in both Bug Report and Feature Request templates.

License

• License headers are included in all the source files that require a license header.
• The license header is located before the package declaration.
• The license header references the name of this project.

Documentation

• Public classes and methods are well-documented with clear explanations.

Demos

• Run the application locally to ensure demos are working as expected and check if sources are being displayed correctly.

Tests

• Unit and integration tests align with the functionality of the new add-on.

CI

• Jenkins job is configured for the initial-implementation branch.
• Webhook has been configured
• Dependency has been added to AddonsDemo

[javier-godoy]

"Template Add-on" has not been replaced with the actual full name of the add-on in both Bug Report and Feature Request templates.

[javier-godoy]

• Why is the enum class UPPERCASE?
• Enum constants have no documentation

[mlopezFC]

Done ✔️

[javier-godoy]

Enum constants have no documentation

[coderabbitai]

Warning

Rate limit exceeded

@mlopezFC has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 2 minutes and 58 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Files that changed from the base of the PR and between 9afb6f7 and 769d38f.

Walkthrough

The changes in this pull request encompass a comprehensive rebranding of the project from "Template Add-on" to "Markdown Editor Add-on." This includes updates to various files such as issue templates, README, POM configuration, and multiple Java classes and test files. New components for Markdown editing and viewing have been introduced, along with corresponding styles and integration tests. The modifications also involve renaming packages, classes, and updating dependencies to align with the new project focus.

Changes

File Path	Change Summary
.github/ISSUE_TEMPLATE/bug-report.yml	Updated description to "Markdown Editor add-on" and corrected indentation for problem-description.
.github/ISSUE_TEMPLATE/feature-request.yml	Changed description to "Markdown Editor add-on."
README.md	Rebranded project name, updated descriptions, features, demo links, and author attribution.
pom.xml	Renamed artifactId, name, and description to reflect new branding; updated SCM URL; adjusted dependency scopes.
src/main/java/com/flowingcode/vaadin/addons/markdown/BaseMarkdownComponent.java	Introduced BaseMarkdownComponent class with size management and color mode enumeration.
src/main/java/com/flowingcode/vaadin/addons/markdown/MarkdownEditor.java	Added MarkdownEditor class for editing Markdown content with placeholder and max length management.
src/main/java/com/flowingcode/vaadin/addons/markdown/MarkdownViewer.java	Introduced MarkdownViewer class for displaying Markdown text.
src/main/resources/META-INF/frontend/styles/markdown-editor-styles.css	Updated styles and removed references to "Template Add-on."
src/main/resources/META-INF/resources/frontend/markdown-editor.tsx	Added MarkdownEditorElement class for React-based Markdown editing, including custom rendering for code blocks.
src/main/resources/META-INF/resources/frontend/markdown-viewer.tsx	Introduced MarkdownViewerElement class for React-based Markdown viewing with Mermaid support.
src/test/java/com/flowingcode/vaadin/addons/DemoLayout.java	Updated header comment to "Markdown Editor Add-on."
src/test/java/com/flowingcode/vaadin/addons/markdown/DemoView.java	Changed package name and class references to reflect new Markdown context.
src/test/java/com/flowingcode/vaadin/addons/markdown/MarkdownDemoView.java	Updated package name, class name, routing annotation, and demo components for Markdown context.
src/test/java/com/flowingcode/vaadin/addons/markdown/MarkdownEditorDemo.java	Introduced demo for MarkdownEditor component with color mode selection.
src/test/java/com/flowingcode/vaadin/addons/markdown/MarkdownViewerDemo.java	Introduced demo for MarkdownViewer component with interactive features.
src/test/java/com/flowingcode/vaadin/addons/markdown/it/AbstractViewTest.java	Updated package name to reflect Markdown Editor Add-on.
src/test/java/com/flowingcode/vaadin/addons/markdown/it/MarkdownEditorIT.java	Added integration test for MarkdownEditor functionality.
src/test/java/com/flowingcode/vaadin/addons/markdown/it/MarkdownViewerIT.java	Added integration test for MarkdownViewer functionality.
src/test/java/com/flowingcode/vaadin/addons/markdown/test/SerializationTest.java	Updated package name and modified test cases for MarkdownEditor and MarkdownViewer.
src/test/java/com/flowingcode/vaadin/addons/template/TemplateDemo.java	Removed the file as it was associated with the old Template Add-on.
src/test/java/com/flowingcode/vaadin/addons/template/it/ViewIT.java	Removed the file as it was associated with the old Template Add-on.
src/test/resources/META-INF/frontend/styles/shared-styles.css	Added licensing information for "Markdown Editor Add-on."

---

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

🪧 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 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.

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.

[paodb]

Fixes look okay to me but I just notice the Readme needs update on the "Getting started" section.
Also the checklist expects in this stage to have the component added to AddonsDemo.

[javier-godoy]

Upgrade maven-javadoc-plugin to 3.10.0

[javier-godoy]

Enum constants have no documentation