Skip to content

fix(ui~cli): file watcher ignore directory logic #1549

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

Merged
merged 2 commits into from
Mar 26, 2025

Conversation

SutuSebastian
Copy link
Collaborator

@SutuSebastian SutuSebastian commented Mar 26, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Resolved issues with file monitoring that led to unintended triggers, ensuring only the correct directories are observed.
  • New Features
    • Improved file filtering by introducing dynamic management of file types and directories, enhancing the overall development workflow.

- Added new directories to the exclusion list in consts.ts.
- Introduced an `allowedExtensions` array to manage file types for processing.
- Updated the `dev`, `generateClassList`, and `findFiles` commands to utilize the new `allowedExtensions` for improved file filtering
@SutuSebastian SutuSebastian added 🐛 bug Something isn't working confirmed This bug was confirmed labels Mar 26, 2025
@SutuSebastian SutuSebastian self-assigned this Mar 26, 2025
@SutuSebastian SutuSebastian linked an issue Mar 26, 2025 that may be closed by this pull request
Copy link

changeset-bot bot commented Mar 26, 2025

🦋 Changeset detected

Latest commit: 9874f51

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
flowbite-react Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

vercel bot commented Mar 26, 2025

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

Name Status Preview Comments Updated (UTC)
flowbite-react ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 26, 2025 5:17pm
flowbite-react-storybook ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 26, 2025 5:17pm

Copy link
Contributor

coderabbitai bot commented Mar 26, 2025

Walkthrough

This pull request addresses issues within the file watcher logic. The updates refine the criteria for ignoring directories by switching from a path-ending check to a base name inclusion check. In addition, hardcoded file extension filters have been replaced with a dynamically managed constant, allowedExtensions. These adjustments are applied across multiple CLI command and utility files to ensure correct file monitoring and more flexible file type checks.

Changes

File(s) Change Summary
.changeset/mighty-buttons-poke.md Summarizes the patch that fixes the file watcher logic by correctly excluding specified directories from monitoring.
packages/ui/src/cli/commands/dev.ts
packages/ui/src/cli/utils/find-files.ts
Adjusts directory exclusion: replaces endsWith checks with a basename based includes check. Updates file ignore logic to integrate dynamic extension handling.
packages/ui/src/cli/commands/generate-class-list.ts
packages/ui/src/cli/consts.ts
Replaces hardcoded file extension patterns with a dynamic allowedExtensions array. Adds new entries to excludeDirs in the constants file to enhance exclusion rules.

Sequence Diagram(s)

sequenceDiagram
    participant W as File Watcher
    participant S as Search Function
    participant C as Config (excludeDirs & allowedExtensions)
    participant FS as File System

    W->>S: File event received
    S->>C: Retrieve excludeDirs & allowedExtensions
    S->>S: Extract basename of directory
    alt Basename is in excludeDirs
        S-->>W: Skip monitoring directory
    else File extension not in allowedExtensions
        S-->>W: Skip processing file
    else
        S->>FS: Process file event
    end
Loading

Poem

I'm a little rabbit, hopping with delight,
Watching files dance in the code's soft light.
With directories skipped by smart base name,
And extensions dancing in a flexible game,
I celebrate these tweaks with a happy twitch and a byte!
🐰✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/ui/src/cli/commands/dev.ts

Oops! Something went wrong! :(

ESLint: 8.57.0

ESLint couldn't find the plugin "eslint-plugin-react".

(The package "eslint-plugin-react" was not found when loaded as a Node module from the directory "/packages/ui".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-react@latest --save-dev

The plugin "eslint-plugin-react" was referenced from the config file in "packages/ui/.eslintrc.cjs".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

packages/ui/src/cli/commands/generate-class-list.ts

Oops! Something went wrong! :(

ESLint: 8.57.0

ESLint couldn't find the plugin "eslint-plugin-react".

(The package "eslint-plugin-react" was not found when loaded as a Node module from the directory "/packages/ui".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-react@latest --save-dev

The plugin "eslint-plugin-react" was referenced from the config file in "packages/ui/.eslintrc.cjs".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

packages/ui/src/cli/consts.ts

Oops! Something went wrong! :(

ESLint: 8.57.0

ESLint couldn't find the plugin "eslint-plugin-react".

(The package "eslint-plugin-react" was not found when loaded as a Node module from the directory "/packages/ui".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-react@latest --save-dev

The plugin "eslint-plugin-react" was referenced from the config file in "packages/ui/.eslintrc.cjs".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

  • 1 others

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8a8fa60 and 9874f51.

📒 Files selected for processing (5)
  • .changeset/mighty-buttons-poke.md (1 hunks)
  • packages/ui/src/cli/commands/dev.ts (2 hunks)
  • packages/ui/src/cli/commands/generate-class-list.ts (2 hunks)
  • packages/ui/src/cli/consts.ts (2 hunks)
  • packages/ui/src/cli/utils/find-files.ts (1 hunks)
🧰 Additional context used
🧬 Code Definitions (3)
packages/ui/src/cli/utils/find-files.ts (1)
packages/ui/src/cli/consts.ts (1)
  • excludeDirs (15-30)
packages/ui/src/cli/commands/generate-class-list.ts (1)
packages/ui/src/cli/consts.ts (1)
  • allowedExtensions (32-32)
packages/ui/src/cli/commands/dev.ts (1)
packages/ui/src/cli/consts.ts (3)
  • excludeDirs (15-30)
  • allowedExtensions (32-32)
  • configFilePath (13-13)
🔇 Additional comments (10)
.changeset/mighty-buttons-poke.md (1)

1-5: LGTM: Clear changeset description

The changeset clearly indicates this is a patch for the "flowbite-react" package that fixes file watcher directory ignoring logic to prevent false positives.

packages/ui/src/cli/commands/generate-class-list.ts (2)

2-2: LGTM: Import allowedExtensions constant

Good refactoring to import the centralized allowedExtensions constant from consts file.


14-14: LGTM: Replace hardcoded extensions with dynamic patterns

Excellent change to replace the hardcoded array of extensions with a dynamic pattern based on the centralized allowedExtensions constant. This improves maintainability and ensures consistency.

packages/ui/src/cli/consts.ts (2)

16-17: LGTM: Additional excluded directories

Good addition of more directories to exclude from file watching: .astro, .parcel-cache, and .vscode. This helps prevent scanning unnecessary directories.

Also applies to: 20-21, 23-24


32-32: LGTM: New allowedExtensions constant

Good addition of a centralized constant for allowed file extensions. This improves maintainability by having a single source of truth for extension filtering.

packages/ui/src/cli/utils/find-files.ts (1)

58-58: LGTM: Fixed directory exclusion logic

This is the key fix in the PR. Changing from directory.endsWith(dir) to path.basename(directory) is an important improvement that prevents false positives when matching directory names.

The previous approach would incorrectly exclude a directory like /some/my_node_modules_custom when trying to exclude node_modules. The new approach correctly only excludes directories that exactly match the names in the excludeDirs list.

packages/ui/src/cli/commands/dev.ts (4)

2-2: Good addition of the basename import.

The addition of basename from the path module is appropriate for the improved directory exclusion logic.


5-11: Well-structured imports from consts file.

The expanded imports are now better organized and include the new allowedExtensions constant, which centralizes extension management. This promotes consistency and maintainability across the codebase.


60-60: Improved directory exclusion logic.

The change from using endsWith to includes(basename(path)) makes the directory exclusion more precise. This prevents false positives where a path might contain a substring matching an excluded directory name.

Before: Would exclude /some/path/my_node_modules/file.js (incorrect)
After: Only excludes exact directory matches like /some/path/node_modules/file.js (correct)

This change properly fixes the issue described in the PR objective.


63-63: Good use of centralized file extensions constant.

Replacing hardcoded file extensions with the imported allowedExtensions constant improves maintainability. Now, supported file types can be modified in a single location rather than updating multiple files.

✨ Finishing Touches
  • 📝 Generate Docstrings

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

@SutuSebastian SutuSebastian merged commit 7327e55 into main Mar 26, 2025
8 checks passed
@SutuSebastian SutuSebastian deleted the 1548-no-css-styles-for-flowbite-react-components branch March 26, 2025 17:21
@github-actions github-actions bot mentioned this pull request Mar 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐛 bug Something isn't working confirmed This bug was confirmed
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

No css styles for flowbite-react components
1 participant