-
Notifications
You must be signed in to change notification settings - Fork 1
feat: by default, single-line comments are not converted #7
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
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 @gimjin, 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!
I've undertaken a significant refactoring of the extension, migrating the codebase from JavaScript to TypeScript. This update introduces new configuration options, notably allowing users to control whether single-line comments are converted, and enhances the development environment with modern tooling for improved code quality and maintainability.
Highlights
- Core Logic Rewritten in TypeScript: The entire extension logic has been migrated from JavaScript to TypeScript, improving type safety, code readability, and maintainability.
- Granular Comment Conversion Control: A new setting,
banjiao.enableInComments
, has been added, allowing users to explicitly enable or disable symbol conversion within single-line comments, providing more granular control. - Enhanced Development Tooling: The project now leverages modern development tools including a new ESLint setup for TypeScript, Prettier for consistent code formatting, Husky for Git hooks, and pnpm for efficient package management.
- File Type Exclusion: Introduced
banjiao.excludeExtensions
to allow users to specify file types (e.g., markdown, text files) where symbol conversion should be ignored, preventing unintended modifications. - Improved Code Structure: Core utility functions, such as
shouldExcludeFile
,isInString
, andisInComment
, have been extracted into a dedicatedsrc/utils.ts
file for better code organization and reusability.
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 or fill out our survey to provide feedback.
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 is a significant and positive overhaul, migrating the extension to TypeScript and modernizing the development setup with tools like ESLint, Prettier, and pnpm. The new feature to disable symbol conversion in comments is a great addition.
However, there is a critical regression: all tests have been removed. While the codebase has been refactored, the lack of tests makes it difficult to verify existing functionality and prevent future bugs. It is highly recommended to re-introduce tests for the new TypeScript codebase.
My review includes a few suggestions to improve code quality and fix a bug in the new comment-checking logic.
No description provided.