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

chore: migrate to TS #37

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

chore: migrate to TS #37

wants to merge 6 commits into from

Conversation

dhararaghu777
Copy link

@dhararaghu777 dhararaghu777 commented Aug 21, 2024

IMPORTANT: Please create an issue before filing a pull request! Changes need to be discussed before proceeding. Please read the contribution guidelines.

Details

Please provide enough information so that others can review your pull request. Give a brief summary of the motivation. Refer to the corresponding issue/s with #XXXX for more information.

Testing

Write the appropriate unit and integration tests, if applicable. Make sure these and all other tests pass.

Documentation

Please document your changes and test cases in the appropriate places, if applicable.

Style

Make sure your changes adhere to the coding/documentation style used throughout the project.

Closing issues

If your changes fix any issue/s, put closes #XXXX in your comment to auto-close it/them.

Summary by Sourcery

Migrate the project to a new setup using React, TypeScript, and Vite, replacing the existing Krini application. Update the ESLint configuration to support TypeScript and React, and revise the README to reflect these changes. Remove obsolete components and configuration files related to the previous setup.

New Features:

  • Introduce a new React application setup using TypeScript and Vite, including configuration for ESLint with TypeScript support.

Enhancements:

  • Update the ESLint configuration to support type-aware linting rules and include plugins for React and React Hooks.

Documentation:

  • Revise the README to reflect the new project setup with React, TypeScript, and Vite, replacing previous content related to Krini.

Copy link

vercel bot commented Aug 21, 2024

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

Name Status Preview Comments Updated (UTC)
krini ❌ Failed (Inspect) Dec 6, 2024 5:22pm

Copy link

sourcery-ai bot commented Aug 21, 2024

Reviewer's Guide by Sourcery

This pull request implements a significant migration from JavaScript to TypeScript, along with a shift from Create React App to Vite as the build tool. The changes include updating the project structure, configuration files, and core application files to support TypeScript and Vite. The PR also introduces new styling approaches and removes several components, indicating a major refactoring of the application architecture.

File-Level Changes

Files Changes
tsconfig.app.json
tsconfig.node.json
tsconfig.json
src/App.tsx
src/vite-env.d.ts
Migrated the project from JavaScript to TypeScript, including the addition of TypeScript configuration files and updating existing JavaScript files to TypeScript
vite.config.ts
index.html
Switched from Create React App to Vite as the build tool, including the addition of Vite configuration
eslint.config.js Updated ESLint configuration to support TypeScript and React
src/index.css
src/App.css
Replaced Tailwind CSS with vanilla CSS, including new styles for the root element and basic components
src/components/RunWorkflow.js
src/components/Layout.js
src/components/ManageWorkflows.js
src/components/Navbar.js
src/components/Workflow.js
src/components/Footer.js
src/components/Landing.js
src/components/Content.js
src/components/CookieConsent.js
src/components/Privacy.js
src/components/About.js
src/components/Login.js
src/components/Register.js
src/components/TaskRuns.js
src/components/TaskCreate.js
src/components/Profile.js
Removed multiple React components, indicating a significant change in the application structure
README.md Updated README.md to reflect the new project setup with React, TypeScript, and Vite
.eslintrc.json
tailwind.config.js
postcss.config.js
cypress.config.js
config.js
Removed configuration files related to the previous setup (Create React App, Tailwind, etc.)

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @dhararaghu777 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • This is a significant change that removes a lot of existing functionality. Could you provide more details on your migration strategy and how you plan to reimplement the removed features in the new TypeScript environment?
  • The move to TypeScript and Vite is promising for improved developer productivity and code quality. However, please ensure that all critical features (e.g., workflow management, user authentication) are preserved or have a clear plan for reimplementation.
  • Consider a more gradual migration approach to minimize disruption to users and contributors. This could involve migrating components one by one rather than replacing the entire codebase at once.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 1 issue found

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

README.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: high High priority
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant