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

Migrated from CRA to vite and updated typescript to latest #2268

Merged

Conversation

adithyanotfound
Copy link

@adithyanotfound adithyanotfound commented Sep 14, 2024

Issue Number:

Fixes #1864
Fixes #2016

I am not assigned to the following issue but this PR automatically fixed it
Fixes #1921
Fixes #2255

Did you add tests for your changes?

Yes

Snapshots/Videos:

#1921 fixes depreciation warnings

Screenshot 2024-09-14 at 10 56 39 PM

If relevant, did you update the documentation?

Not required

Does this PR introduce a breaking change?

Yes

Other information

  1. I have only checked the development side. Please test deployment before merging @palisadoes.
  2. scripts/config-overrides and scripts/test.js can be deleted after this PR since they are no longer required.

Have you read the contributing guide?

Yes

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Introduced Vite as the new build tool for improved performance and development experience.
    • Added support for modern JavaScript, TypeScript, and React JSX syntax.
    • Enhanced TypeScript configuration for better type safety and autocompletion.
    • Configured Vite with essential plugins for React support and environment management.
    • Added a new script tag in HTML for executing TypeScript code.
  • Bug Fixes

    • Improved test reliability by refining text assertions in component tests.
  • Chores

    • Updated various dependencies to their latest versions, including TypeScript and Babel presets.
    • Removed legacy configurations and dependencies related to Create React App.
    • Updated HTML structure for better resource linking and clarity.
  • Documentation

    • Added TypeScript declaration files for Vite to enhance development tooling.

Copy link

coderabbitai bot commented Sep 14, 2024

Walkthrough

The pull request introduces significant updates to the project's configuration and dependencies, transitioning from Create React App to Vite as the primary build tool. Key changes include the addition of Babel configuration for modern JavaScript, TypeScript, and React support, updates to Jest testing configurations, and the restructuring of the package.json to reflect the new dependencies and scripts. The changes enhance the project's compatibility with modern development practices and improve the overall development experience.

Changes

File(s) Change Summary
babel.config.cjs Added configuration for Babel to support modern JavaScript, TypeScript, and React JSX syntax with necessary presets and plugins.
index.html Updated HTML structure, modified resource links to absolute paths, and added a script tag for TypeScript module execution.
jest.config.js Modified Jest configuration by updating setup files, changing transformation methods to use babel-jest, and commenting out watchPlugins.
package.json Updated dependencies to include Vite and Babel-related packages, removed react-scripts, and adjusted scripts for Vite commands.
scripts/config-overrides/custom_build.js Minor formatting change with no functional impact.
scripts/config-overrides/custom_start.js Minor formatting change with no functional impact.
src/components/LeftDrawerOrg/LeftDrawerOrg.test.tsx Changed text assertions in tests to use getAllByText for more robust checks.
src/components/UserPortal/UserSidebarOrg/UserSidebarOrg.test.tsx Updated text assertions in tests to ensure the correct instance of the text is validated.
src/react-app-env.d.ts Removed reference to react-scripts types, potentially impacting type definitions.
src/vite-env.d.ts Introduced a new file to reference types for the Vite client.
vite.config.ts Added a new Vite configuration file with settings for a React application, including plugins and server configuration.

Assessment against linked issues

Objective Addressed Explanation
Migrate to Vite for improved build times and practices (#1864)
Ensure compatibility of existing packages with Vite (#1864)
Avoid unintentional configuration changes during migration (#1864)
Fix deprecation messages related to middleware (#1921) The changes do not address the specific deprecation messages mentioned.
Upgrade TypeScript and resolve dependency issues (#2016) TypeScript was upgraded to a newer version, addressing the upgrade objective.

Possibly related PRs

  • Upgrade web vitals #2101: The changes in package.json regarding the addition of Babel presets and plugins are related to the upgrade of the web-vitals package, as both involve modifications to the project's configuration and dependencies.
  • feat: Timezone #2234: The introduction of middleware for handling time conversions in the Apollo Client setup in src/index.tsx aligns with the changes made in the main PR, which also involves updates to the configuration and functionality of the project, particularly in relation to TypeScript and modern JavaScript features.

Poem

🐰 In a world of code, so bright and new,
Vite hops in with a joyful view.
Babel spins yarns of modern delight,
Testing with Jest, everything feels right.
With each little change, our project takes flight,
A rabbit's cheer for a future so bright! 🌟


Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9ecbb11 and 12a4a00.

Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
Files selected for processing (1)
  • package.json (5 hunks)
Files skipped from review as they are similar to previous changes (1)
  • package.json

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 generate interesting stats about this repository and render them as a table.
    -- @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.

Copy link

Our Pull Request Approval Process

We have these basic policies to make the approval process smoother for our volunteer team.

Testing Your Code

Please make sure your code passes all tests. Our test code coverage system will fail if these conditions occur:

  1. The overall code coverage drops below the target threshold of the repository
  2. Any file in the pull request has code coverage levels below the repository threshold
  3. Merge conflicts

The process helps maintain the overall reliability of the code base and is a prerequisite for getting your PR approved. Assigned reviewers regularly review the PR queue and tend to focus on PRs that are passing.

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

codecov bot commented Sep 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.54%. Comparing base (e143243) to head (12a4a00).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #2268   +/-   ##
========================================
  Coverage    97.54%   97.54%           
========================================
  Files          241      241           
  Lines         6887     6887           
  Branches      2016     2016           
========================================
  Hits          6718     6718           
  Misses         157      157           
  Partials        12       12           

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

coderabbitai[bot]
coderabbitai bot previously approved these changes Sep 14, 2024
@palisadoes
Copy link
Contributor

  1. Please fix the conflicting files
  2. The PR looks OK otherwise so we'll be able to merge

coderabbitai[bot]
coderabbitai bot previously approved these changes Sep 15, 2024
Copy link
Contributor

@palisadoes palisadoes left a comment

Choose a reason for hiding this comment

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

Thanks. This is a necessary change.
Some minor questions to create an ideal outcome.

babel.config.cjs Outdated
presets: [
'@babel/preset-env', // Transforms modern JavaScript
'@babel/preset-typescript', // Transforms TypeScript
'@babel/preset-react', // Transforms JSX
Copy link
Contributor

Choose a reason for hiding this comment

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

  1. Can this file be placed in a .config or config directory like we have done with the API?
  2. It'll reduce the clutter in the root directory

vite.config.ts Outdated
import react from '@vitejs/plugin-react';
import viteTsconfigPaths from 'vite-tsconfig-paths';
import svgrPlugin from 'vite-plugin-svgr';
import EnvironmentPlugin from 'vite-plugin-environment';
Copy link
Contributor

Choose a reason for hiding this comment

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

  1. Can this file be placed in a .config or config directory like we have done with the API?
  2. It'll reduce the clutter in the root directory

@adithyanotfound
Copy link
Author

adithyanotfound commented Sep 15, 2024

Thanks. This is a necessary change. Some minor questions to create an ideal outcome.

I'll try to make the required changes. Please ignore the request for review. I clicked it by mistake.

@adithyanotfound
Copy link
Author

@palisadoes I have made the changes.

coderabbitai[bot]
coderabbitai bot previously approved these changes Sep 16, 2024
palisadoes
palisadoes previously approved these changes Sep 17, 2024
@palisadoes
Copy link
Contributor

Please fix the conflicting files

@palisadoes palisadoes merged commit 01ef5c6 into PalisadoesFoundation:develop Sep 17, 2024
11 of 12 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