-
Notifications
You must be signed in to change notification settings - Fork 6
fix(sdk/typescript): lint & disable @masknet/unicode-specific-set #32
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 @nekomeowww, 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 made a series of changes focused on linting and code organization within the TypeScript SDK. The primary intent is to disable a specific lint rule that was causing issues and to improve code consistency and readability across several backend integration files.
Highlights
- ESLint Configuration Update: I've disabled the @masknet/unicode-specific-set rule in the ESLint configuration to resolve a linting issue.
- Code Reordering and Consistency: I've reordered properties within interfaces and destructuring assignments in alibabacloud.ts and volcengine.ts, and reordered export statements and type definitions in index.ts to maintain consistent code style.
- Stylistic Refinements: Minor stylistic changes were applied, such as converting template literals to string literals in elevenlabs.ts and volcengine.ts for simple string values.
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 primarily focuses on code linting and style consistency across the TypeScript SDK. It disables the @masknet/unicode-specific-set
ESLint rule and applies numerous formatting changes, such as alphabetizing properties in interfaces and objects, reordering exports, and using type-only imports. A notable change is the refactoring of the createUnVolcengine
function, which now expects the appId
within the options object instead of as a direct parameter. My feedback includes a suggestion to improve the JSDoc for this function to better communicate this breaking change to users.
* as ElevenLabs, Azure TTS, Google TTS, etc. | ||
* | ||
* @param apiKey - Volcano Engine Speech Service Token | ||
* @param appId - Volcano Engine Speech Service App ID |
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.
Since appId
is no longer a direct parameter, this is a breaking change for the createUnVolcengine
function. To help users adapt, I suggest updating the JSDoc to explain how to provide the appId
now.
For example, you could add a note to the function's description:
/**
* ...
*
* Note: The `appId` for Volcano Engine must be provided in the `options` object for each API call, under `app.appId`.
*
* @param apiKey - Volcano Engine Speech Service Token
* @param baseURL - UnSpeech Instance URL
* @returns SpeechProviderWithExtraOptions
*/
This will make the new usage clear to developers.
No description provided.