Skip to content

fix(config): make endpoints optional and use relative schema path#175

Merged
AnnatarHe merged 1 commit intomainfrom
fix/config-optional-endpoints-schema-path
Dec 28, 2025
Merged

fix(config): make endpoints optional and use relative schema path#175
AnnatarHe merged 1 commit intomainfrom
fix/config-optional-endpoints-schema-path

Conversation

@AnnatarHe
Copy link
Copy Markdown
Contributor

Summary

  • Add omitempty tag to Endpoints field in config struct for proper optional serialization
  • Change YAML schema reference from absolute path to relative ./config-schema.json

Test plan

  • Verify config serialization omits empty endpoints field
  • Verify new config files reference schema with relative path

🤖 Generated with Claude Code

- Add omitempty tag to Endpoints field for proper optional serialization
- Change YAML schema reference to relative path ./config-schema.json

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @AnnatarHe, 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 enhances the configuration system by making the Endpoints field optional during serialization and by switching the YAML schema reference to a relative path. These changes improve the flexibility of configuration files and ensure better portability across different environments, particularly for IDE autocompletion.

Highlights

  • Optional Endpoints: The Endpoints field in the ShellTimeConfig struct now includes omitempty tags for TOML, YAML, and JSON, allowing it to be omitted during serialization if empty.
  • Relative Schema Path: The YAML schema reference has been updated from an absolute path to a relative path (./config-schema.json), improving portability and consistency for IDE autocompletion.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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

  1. 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.

@AnnatarHe AnnatarHe merged commit 31f2565 into main Dec 28, 2025
2 checks passed
@AnnatarHe AnnatarHe deleted the fix/config-optional-endpoints-schema-path branch December 28, 2025 07:13
@codecov
Copy link
Copy Markdown

codecov Bot commented Dec 28, 2025

Codecov Report

❌ Patch coverage is 0% with 2 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
commands/auth.go 0.00% 2 Missing ⚠️
Flag Coverage Δ
unittests 20.31% <0.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
commands/auth.go 0.00% <0.00%> (ø)

... and 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a 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 makes the Endpoints field optional in the configuration and updates the YAML schema path to be relative. My review focuses on improving path handling for cross-platform compatibility, reducing code duplication, and ensuring consistency between your configuration struct tags and your documentation. I've suggested using filepath.Join for constructing paths, deriving the schema filename dynamically to avoid hardcoding it twice, and correcting an inconsistent TOML tag to match your documentation.

Comment thread commands/auth.go

// Generate JSON schema for IDE autocompletion
schemaFile := configDir + "/config.schema.json"
schemaFile := configDir + "/config-schema.json"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

high

To ensure platform-independent path construction, you should use filepath.Join instead of string concatenation with /. This will prevent potential issues on operating systems like Windows that use a different path separator. This follows the repository's general rule for path handling.

You'll need to add "path/filepath" to your imports.

Suggested change
schemaFile := configDir + "/config-schema.json"
schemaFile := filepath.Join(configDir, "config-schema.json")
References
  1. Use filepath.Join to combine path segments for platform independence, rather than hardcoding path separators.

Comment thread commands/auth.go
}
// Prepend $schema for IDE autocompletion support
schemaHeader := "# yaml-language-server: $schema=" + schemaFile + "\n"
schemaHeader := "# yaml-language-server: $schema=./config-schema.json\n"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The schema filename config-schema.json is hardcoded here, but it's already used to construct schemaFile on line 48. To avoid this duplication and improve maintainability, you can dynamically get the filename from the schemaFile path using filepath.Base().

This will require importing the path/filepath package.

Suggested change
schemaHeader := "# yaml-language-server: $schema=./config-schema.json\n"
schemaHeader := fmt.Sprintf("# yaml-language-server: $schema=./%s\n", filepath.Base(schemaFile))

Comment thread model/types.go

// for debug purpose
Endpoints []Endpoint `toml:"ENDPOINTS" yaml:"endpoints" json:"endpoints"`
Endpoints []Endpoint `toml:"ENDPOINTS,omitempty" yaml:"endpoints,omitempty" json:"endpoints,omitempty"`
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The TOML tag ENDPOINTS is in uppercase, which is inconsistent with the YAML and JSON tags (endpoints). More importantly, it contradicts your own documentation in docs/CONFIG.md (line 308) which uses [[endpoints]] (lowercase). To ensure consistency and align with your documentation, you should use a lowercase tag for TOML as well.

Suggested change
Endpoints []Endpoint `toml:"ENDPOINTS,omitempty" yaml:"endpoints,omitempty" json:"endpoints,omitempty"`
Endpoints []Endpoint `toml:"endpoints,omitempty" yaml:"endpoints,omitempty" json:"endpoints,omitempty"`

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.

1 participant