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

Figma: Refactor CSS files in src/components/CollapsibleDropdown #3330 #3473

Conversation

Anushkaguptaaaa
Copy link

@Anushkaguptaaaa Anushkaguptaaaa commented Jan 28, 2025

What kind of change does this PR introduce?

Refactoring

Issue Number:

Fixes #3330

Snapshots/Videos:
image

Summary
Aim is to consolidate style sheet in Collapsible Dropdown into app.module style sheet

Does this PR introduce a breaking change?
No

Checklist

CodeRabbit AI Review

  • I have reviewed and addressed all critical issues flagged by CodeRabbit AI
  • I have implemented or provided justification for each non-critical suggestion
  • I have documented my reasoning in the PR comments where CodeRabbit AI suggestions were not implemented

Test Coverage

  • I have written tests for all new changes/features
  • I have verified that test coverage meets or exceeds 95%
  • I have run the test suite locally and all tests pass

Have you read the contributing guide?

Yes

Summary by CodeRabbit

  • Style
    • Relocated styles for the CollapsibleDropdown component from a dedicated module to the main app stylesheet.
    • Introduced new CSS classes for improved styling of the collapsible dropdown feature.
    • Renamed CSS classes to follow a more consistent naming convention while preserving original styling properties for dropdown elements.

Copy link
Contributor

coderabbitai bot commented Jan 28, 2025

"""

Walkthrough

This pull request focuses on refactoring the CSS for the CollapsibleDropdown component by moving its specific styles from a component-level CSS module to the global app.module.css file. The changes involve deleting the CollapsibleDropdown.module.css file, updating the import statement in the CollapsibleDropdown.tsx component, and adding new CSS classes with more descriptive names to the global CSS file.

Changes

File Change Summary
src/components/CollapsibleDropdown/CollapsibleDropdown.module.css Deleted entire CSS module file
src/components/CollapsibleDropdown/CollapsibleDropdown.tsx Updated import statement from local CSS module to global app.module.css and updated class names
src/style/app.module.css Added new CSS classes: .collapsibleDropdownIconWrapper, .collapsibleDropdownCollapseBtn, .collapsibleDropdownIconWrapperSm

Assessment against linked issues

Objective Addressed Explanation
Streamline CSS into single global file [#3330]
Delete component-specific CSS files [#3330]
Use descriptive variable names for colors [#3296] No color variables were modified in this PR

Possibly related issues

Possibly related PRs

Suggested reviewers

  • palisadoes

Poem

🐰 CSS Consolidation Hop! 🎨

In global styles, we now reside,
No more scattered classes to hide
One file to rule them all with grace,
A rabbit's refactor, leaving no trace!

Hop, hop, hooray! 🌈✨
"""


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 44dd99f and c479597.

📒 Files selected for processing (1)
  • src/style/app.module.css (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/style/app.module.css
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Check Python Code Style
  • GitHub Check: Test Application
  • GitHub Check: Analyse Code With CodeQL (javascript)

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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.

Copy link

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

Remember, your PRs won't be reviewed until these criteria are met:

  1. We don't merge PRs with poor code quality.
    1. Follow coding best practices such that CodeRabbit.ai approves your PR.
  2. We don't merge PRs with failed tests.
    1. When tests fail, click on the Details link to learn more.
    2. Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
    3. Tests may fail if you edit sensitive files. Ask to add the ignore-sensitive-files-pr label if the edits are necessary.
  3. We cannot merge PRs with conflicting files. These must be fixed.

Our policies make our code better.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
  2. Read the CONTRIBUTING.md file make

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
src/components/CollapsibleDropdown/CollapsibleDropdown.tsx (2)

4-4: Consider using absolute imports for better maintainability.

While the style import change aligns with the refactoring goal, using relative paths (../../) can be fragile during future refactoring. Consider using absolute imports instead.

-import styles from '../../style/app.module.css';
+import styles from 'style/app.module.css';

76-78: Consider extracting complex class composition logic.

The template literal mixing Bootstrap and module classes could be simplified for better maintainability.

-className={`${styles.collapsibleDropdownCollapseBtn} ${
-  isActive === true ? 'text-white' : 'text-secondary'
-}`}
+className={getButtonClasses(styles.collapsibleDropdownCollapseBtn, isActive)}

Add this helper function:

const getButtonClasses = (baseClass: string, isActive: boolean): string => {
  return `${baseClass} ${isActive ? 'text-white' : 'text-secondary'}`;
};
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a7f3771 and 44dd99f.

📒 Files selected for processing (3)
  • src/components/CollapsibleDropdown/CollapsibleDropdown.module.css (0 hunks)
  • src/components/CollapsibleDropdown/CollapsibleDropdown.tsx (3 hunks)
  • src/style/app.module.css (1 hunks)
💤 Files with no reviewable changes (1)
  • src/components/CollapsibleDropdown/CollapsibleDropdown.module.css
🧰 Additional context used
🪛 GitHub Actions: PR Workflow
src/style/app.module.css

[warning] Code style issues found. Run Prettier with --write to fix formatting issues.

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyse Code With CodeQL (javascript)
🔇 Additional comments (5)
src/components/CollapsibleDropdown/CollapsibleDropdown.tsx (3)

51-51: Well-structured class naming!

The new class name collapsibleDropdownIconWrapper follows a good namespacing pattern, which helps prevent style conflicts in the global CSS file.


84-84: Consistent class naming maintained!

The class name collapsibleDropdownIconWrapperSm maintains consistency with the component's naming pattern.


4-4: Verify complete migration of styles.

Let's ensure all required styles were properly migrated to app.module.css.

✅ Verification successful

CSS migration successfully verified

All required styles are present in app.module.css and no references to the old module remain in the codebase.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if all required styles exist in app.module.css
rg -l "collapsibleDropdownIconWrapper|collapsibleDropdownCollapseBtn|collapsibleDropdownIconWrapperSm" "src/style/app.module.css"

# Check for any remaining references to the old module
fd -g "*.tsx" -g "*.ts" -x rg -l "CollapsibleDropdown\.module\.css"

Length of output: 316


Script:

#!/bin/bash
# Show the actual style definitions in app.module.css
echo "=== Styles in app.module.css ==="
rg "collapsibleDropdownIconWrapper|collapsibleDropdownCollapseBtn|collapsibleDropdownIconWrapperSm" "src/style/app.module.css"

# Fixed command to check for old module references
echo -e "\n=== Files still referencing old module ==="
fd -e tsx -e ts -x rg -l "CollapsibleDropdown\.module\.css" {}

# Check if old module file exists
echo -e "\n=== Check for old module file ==="
fd -g "CollapsibleDropdown.module.css"

Length of output: 595

src/style/app.module.css (2)

9132-9145: Well-structured CSS classes with clear naming.

The CSS classes follow good practices:

  • Descriptive names that clearly indicate their purpose
  • Component-specific prefixes to avoid naming conflicts
  • Simple, focused implementations for each class
🧰 Tools
🪛 GitHub Actions: PR Workflow

[warning] Code style issues found. Run Prettier with --write to fix formatting issues.


9129-9145: Fix Prettier formatting issues.

The implementation looks good but there are some formatting issues flagged by the pipeline. Please run Prettier with the --write flag to fix the formatting.

Run the following script to verify and fix the formatting:

🧰 Tools
🪛 GitHub Actions: PR Workflow

[warning] Code style issues found. Run Prettier with --write to fix formatting issues.

coderabbitai[bot]
coderabbitai bot previously approved these changes Jan 28, 2025
Copy link

codecov bot commented Jan 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.65%. Comparing base (73cf8cd) to head (c479597).
Report is 7 commits behind head on develop-postgres.

Additional details and impacted files
@@                  Coverage Diff                  @@
##           develop-postgres    #3473       +/-   ##
=====================================================
+ Coverage              1.90%   88.65%   +86.75%     
=====================================================
  Files                   316      338       +22     
  Lines                  8249     8620      +371     
  Branches               1880     1918       +38     
=====================================================
+ Hits                    157     7642     +7485     
+ Misses                 8083      649     -7434     
- Partials                  9      329      +320     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Anushkaguptaaaa
Copy link
Author

@Cioppolo14 @palisadoes please review.

@palisadoes palisadoes merged commit 5477f18 into PalisadoesFoundation:develop-postgres Jan 28, 2025
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants