546-refactor: Widget StudyWithUs

[YulikK]

What type of PR is this? (select all that apply)

• 🍕 Feature
• 🐛 Bug Fix
• 🚧 Breaking Change
• 🧑‍💻 Code Refactor
• 📝 Documentation Update

Description

1. move study-with-us.test.tsx to ui folder
2. replace div with section and article
3. remove OptionItem component
4. rename image to rsSchool.
5. add descriptive alt attribute
6. update tests
7. make module scss file
8. update styles

Related Tickets & Documents

• Related Issue FSD: widgets folder refactor #347
• Closes FSD: Widget StudyWithUs #546

Screenshots, Recordings

Please replace this line with any relevant images for UI changes.

Added/updated tests?

• 👌 Yes
• 🙅‍♂️ No, because they aren't needed
• 🙋‍♂️ No, because I need help

[optional] Are there any post deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

Summary by CodeRabbit

• New Features

  • Introduced a new SCSS module for styling the "OptionItem" component, enhancing its layout and responsiveness.
  • Added a new test suite for the "StudyWithUs" component to validate its rendering and functionality.

• Bug Fixes

  • Improved semantic structure of the "OptionItem" and "StudyWithUs" components for better accessibility.

• Refactor

  • Updated component structures to use semantic HTML elements and CSS modules for improved styling practices.

• Chores

  • Removed outdated test files and stylesheets to streamline the codebase.

[github-actions]

Lighthouse Report:

• Performance: 72 / 100
• Accessibility: 98 / 100
• Best Practices: 100 / 100
• SEO: 100 / 100

View detailed report

[github-actions]

Lighthouse Report:

• Performance: 87 / 100
• Accessibility: 98 / 100
• Best Practices: 100 / 100
• SEO: 100 / 100

View detailed report

[github-actions]

Lighthouse Report:

• Performance: 100 / 100
• Accessibility: 98 / 100
• Best Practices: 100 / 100
• SEO: 100 / 100

View detailed report

[github-actions]

Lighthouse Report:

• Performance: 91 / 100
• Accessibility: 100 / 100
• Best Practices: 100 / 100
• SEO: 100 / 100

View detailed report

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

The pull request introduces several modifications across multiple files, primarily focusing on refactoring components to utilize SCSS modules, enhancing semantic HTML usage, and adjusting type declarations. Key changes include the removal of type exports, updates to component structures, and the introduction of new styling files, while ensuring that the functionality of the components remains intact.

Changes

Files	Change Summary
src/widgets/contribute/ui/contribute.tsx	Removed OptionItemProps import and changed contributeOptions to implicit typing.
src/widgets/option-item/index.ts	Removed export of OptionItemProps, retaining only OptionItem.
src/widgets/option-item/option-item.test.tsx	Deleted file containing unit tests for OptionItem.
src/widgets/option-item/ui/option-item.module.scss	Added new SCSS module for styling OptionItem.
src/widgets/option-item/ui/option-item.scss	Deleted old SCSS file with styles for OptionItem.
src/widgets/option-item/ui/option-item.test.tsx	Introduced new test suite for OptionItem with comprehensive scenarios.
src/widgets/option-item/ui/option-item.tsx	Refactored to use <article> instead of <div>, removed export from OptionItemProps.
src/widgets/study-with-us/constants.ts	Removed type annotation from studyOptions, allowing more flexible type handling.
src/widgets/study-with-us/study-with-us.test.tsx	Deleted file containing unit tests for StudyWithUs.
src/widgets/study-with-us/ui/study-with-us.module.scss	Added new SCSS module for styling StudyWithUs.
src/widgets/study-with-us/ui/study-with-us.scss	Deleted old SCSS file with styles for StudyWithUs.
src/widgets/study-with-us/ui/study-with-us.test.tsx	Introduced new test suite for StudyWithUs component.
src/widgets/study-with-us/ui/study-with-us.tsx	Refactored to use <section> instead of <div>, updated imports for SCSS modules.

Assessment against linked issues

Objective	Addressed	Explanation
Refactor study-with-us.tsx's scss to scss modules (546)	✅
Replace div with section in study-with-us.tsx (546)	✅
Remove OptionItem component (546)	✅
Rename image to something more meaningful (546)	❌	The image variable was renamed, but not to a more meaningful name.
Remove export from props type in option-item.tsx (524)	✅

Possibly related issues

• FSD: Widget OptionItem #524: The changes in the PR address the refactoring of the OptionItem component, which aligns with the objectives of this issue.

Possibly related PRs

• 375-refactor: Subtitle component refactor #401: Modifications to OptionItemProps in relation to type handling and usage in components.
• 465-refactor: Customize slider #466: Changes in type declarations and variable handling relevant to component refactoring.
• 355-refactor: Paragraph component refactor #475: Adjustments in type declarations and structure related to the Paragraph component.
• 473-fix: Fsd refactor trainers card #492: Focus on type handling and structure improvements that align with the refactoring of the Trainer entity.

Suggested reviewers

• dzmitry-varabei
• andron13
• natanchik
• Quiddlee
• SpaNb4
• KristiBo

---

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
• Mastodon
• Reddit
• LinkedIn

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

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.