Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix theme tailwind #99

Merged
merged 2 commits into from
Oct 25, 2024
Merged

Fix theme tailwind #99

merged 2 commits into from
Oct 25, 2024

Conversation

Romakita
Copy link
Contributor

@Romakita Romakita commented Oct 25, 2024

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced a new Tailwind CSS preset configuration to enhance theming capabilities.
    • Added a utility function to capitalize the first letter of a string.
  • Bug Fixes

    • Updated import paths for improved accuracy in component references.
  • Documentation

    • Streamlined setup instructions in the README for easier theme configuration.
    • Added a new section for Tailwind CSS configuration guidance.
  • Style

    • Implemented new base styles for consistent link and list presentations.
    • Removed outdated CSS classes to simplify styling rules.
  • Tests

    • Added a test suite for the new upperFirst utility function.

Copy link
Contributor

coderabbitai bot commented Oct 25, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduced in this pull request primarily involve updates to the styling and configuration files of the @tsed/vitepress-theme package. Key modifications include the replacement of local stylesheet imports with imports from the @tsed/vitepress-theme package, the removal of certain CSS files, and the introduction of new styles and a Tailwind CSS preset configuration. Additionally, the .npmignore file was updated to exclude test and story files from package distribution. These alterations aim to streamline the style management and enhance the theme's modularity.

Changes

File Path Change Summary
.storybook/preview.ts Updated import from local stylesheet to @tsed/vitepress-theme/styles/global.css.
docs/.vitepress/theme/index.ts Removed import statement for ./style.css.
docs/.vitepress/theme/style.css Deleted file containing various CSS imports, affecting the visual presentation of the documentation site.
packages/theme/.npmignore Added patterns to ignore **/*.spec.ts and **/*.stories.ts files in npm package distribution.
packages/theme/DefaultTheme.ts Added import for ./styles/global.css.
packages/theme/organisms/warehouse/Warehouse.vue Updated import paths and standardized formatting; no logic changes.
packages/theme/package.json Added new export for tailwind.preset module.
packages/theme/readme.md Simplified configuration instructions and added a section for tailwind.config.ts.
packages/theme/styles/base.css Introduced new CSS styles for resetting list and link styles, and defining component styles.
packages/theme/styles/global.css Added imports for variables.css, tailwind.css, base.css, and algolia.css.
packages/theme/styles/tailwind.css Removed several CSS classes related to list and link resets, affecting component styling.
packages/theme/tailwind.preset.ts Introduced a new Tailwind CSS preset configuration with custom colors and font sizes.
packages/theme/utils/upperFirst.spec.ts Added a new test suite for the upperFirst function with three test cases.
packages/theme/utils/upperFirst.ts Introduced a new utility function upperFirst for capitalizing the first letter of a string.
tailwind.config.ts Updated import path for tailwindPreset and changed content array path.
vitest.config.ts Increased coverage thresholds and updated exclusions for coverage.

Possibly related PRs

  • feat: add projects component #87: Updates to the .storybook/preview.ts file, including the addition of a new property and registration of the Projects component, which relates to overall theme and styling configuration in Storybook.
  • fix(theme): rework how the default theme must be installed #98: Modifications to the .storybook/preview.ts file changing the import statement for global styles to use the @tsed/vitepress-theme package, directly connecting to the changes made in this PR.

🐰 In a world of styles so bright,
A rabbit hops with pure delight.
With global themes now set to play,
Our docs will shine in a new way!
So let’s embrace this vibrant hue,
For every tale, there's something new! 🌼


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

@Romakita Romakita merged commit 679ea5e into main Oct 25, 2024
12 of 13 checks passed
@Romakita
Copy link
Contributor Author

🎉 This PR is included in version 1.0.7 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant