-
Notifications
You must be signed in to change notification settings - Fork 1
Refactor/eslint operations #2
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
Conversation
✅ Deploy Preview for virtual-react-json-diff ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @utkuakyuz, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request significantly refactors the project's development environment by introducing a new ESLint configuration based on Antfu's setup. The primary goal is to establish a consistent code formatting and quality standard. This involves removing obsolete files, adding new configuration for VS Code, and integrating pre-commit hooks to automatically fix linting issues. These changes aim to enhance developer experience, improve code maintainability, and ensure a higher level of code quality across the project.
Highlights
- New ESLint Configuration: The project now uses Antfu ESLint for a standardized and opinionated linting setup, ensuring consistent code style and quality across the codebase.
- Automated Code Formatting: A comprehensive code formatting strategy has been implemented, with all files being auto-fixed to align with the new linting rules, significantly improving code readability and maintainability.
- File Cleanup and IDE Integration: Unused files, including
.storybook/document.tsx, have been removed, and.vscode/settings.jsonwas added to configure VS Code for the new ESLint setup, streamlining the project structure. - Pre-commit Linting Enforcement: Pre-commit checks have been introduced using
lint-stagedandsimple-git-hooks, which automatically run ESLint fixes on staged files, preventing linting errors from being committed. - Configuration File Updates: Various configuration files (
package.json,rollup.config.js,tsconfig.json, Storybook configurations) have been updated to support the new linting and module setup, including reordering properties and updating import/export syntax.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces ESLint with @antfu/eslint-config to enforce a common code style, which is a great step towards improving code quality and consistency. The changes include auto-formatting across the codebase, updating dependencies, and adding pre-commit hooks with lint-staged to ensure new code adheres to the style guide. My review focuses on a few areas for improvement: a potential bug in a useMemo hook where dependencies are missing, a suggestion to refactor a DOM query to use React refs for better robustness, and a couple of minor points regarding ESLint configuration and dependencies. Overall, this is a solid refactoring effort that sets up the project for better maintainability.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request effectively refactors the project to use @antfu/eslint-config for consistent code style and formatting, and introduces pre-commit hooks with lint-staged to enforce it. The changes are well-aligned with the goal of standardizing the codebase. I've provided a few suggestions to improve the ESLint and lint-staged configurations for better robustness and to update the documentation for consistency with the new pnpm setup.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
This commit mainly includes eslint operations. Antfu eslint is created and code format strategy is managed commonly.
Some unused files are removed and one file renamed.
All files linted through auto fix.
Lint-stage method added for pre commit checks.