search

themesberg / flowbite-angular

Official Angular components built for Flowbite and Tailwind CSS
https://flowbite-angular.com
Other
189 stars 42 forks source link

feat: creating DDRE project for the documentation #48

Closed MGREMY closed 3 months ago

MGREMY commented 4 months ago

DDRE Project

This project will help to create flowbite-angular's documentation by providing a way to generate both plain HTML and computed HTML as code example, and live preview of the same exact code

Summary by CodeRabbit

vercel[bot] commented 4 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
flowbite-angular ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 30, 2024 8:23am
coderabbitai[bot] commented 4 months ago

[!IMPORTANT]

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

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

Walkthrough

The changes mainly introduce a new Angular library called DDRE (Dynamic Documentation Renderer Engine) along with its configuration, testing, and packaging files. This library provides functionality to convert input into formatted HTML, supporting both plain strings and component-based input. Additionally, there are updates to the main project’s package.json to include new dependencies and scripts, and modifications to ESLint configuration.

Changes

File/Directory Change Summary
.eslintrc.json Adjusted @typescript-eslint/lines-around-comment rule from 1 to 0.
libs/ddre/.eslintrc.json Introduced ESLint configuration specific to the ddre project.
libs/ddre/README.md Introduced DDRE library documentation.
libs/ddre/jest.config.ts Provided Jest configuration for the ddre module.
libs/ddre/ng-package.json Added configuration for packaging the Angular library.
libs/ddre/package.json Introduced metadata and dependencies for flowbite-angular/ddre.
libs/ddre/project.json Defined project configuration for the ddre library including build, test, and lint configurations.
libs/ddre/src/index.ts Exported all items from the public_api.
libs/ddre/src/lib/core/... Introduced various core components and interfaces for DDRE (e.g., engine-input, engine-output, errors).
libs/ddre/src/lib/engine/... Added DDREService and HTML parser functions to support generating HTML strings from input.
libs/ddre/src/test-setup.ts Set up Jest for Angular testing.
libs/ddre/tsconfig*.json Added TypeScript configuration files for the ddre library, including settings for production, library, and testing.
nx.json Introduced configuration for @nx/angular:ng-packagr-lite with caching and dependencies.
package.json Added new dependencies and a script for bundle analysis.
tsconfig.base.json Updated to include path mapping for flowbite-angular/ddre.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DDREService
    participant HtmlParser

    User->>DDREService: generateString(input)
    DDREService->>HtmlParser: getString(input)
    HtmlParser->>HtmlParser: parseInputToArrayString(input)
    HtmlParser-->>DDREService: plainHtml
    DDREService-->>User: { plainHtml, compiledHtml: undefined }

Poem

In the code, a new dawn breaks,
With DDRE, HTML takes,
From strings and components, a blend so bright,
Rendering docs in the coder’s light.
Angular's strength, in each byte found,
A rabbit hops, new features abound.
🎉✨

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
MGREMY commented 4 months ago

@coderabbitai review

coderabbitai[bot] commented 4 months ago
Actions performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.