Skip to content

Missing description for enums in config.json (JB) #2720

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

Closed
3 tasks
Patrick-Erichsen opened this issue Oct 28, 2024 · 5 comments
Closed
3 tasks

Missing description for enums in config.json (JB) #2720

Patrick-Erichsen opened this issue Oct 28, 2024 · 5 comments
Assignees
Labels
area:configuration Relates to configuration options good-first-issue Suggested issue for new contributors ide:jetbrains Relates specifically to JetBrains extension priority:medium Indicates medium priority stale

Comments

@Patrick-Erichsen
Copy link
Collaborator

Patrick-Erichsen commented Oct 28, 2024

Before submitting your bug report

Relevant environment info

- OS:
- Continue version:
- IDE version:
- Model:
- config.json:

Description

We use the markdownEnumDesccription property in https://github.com/continuedev/continue/blob/main/extensions/intellij/src/main/resources/config_schema.json, but this is a VS Code specific extension of JSON Schema that is not respected in JetBrains. As a result, the enums for things like contextProviders don't have descriptions.

Based on this thread, I believe we want something like this:

"properties": {
    "businessId": {
      "oneOf": [
        {"const": "001", "description": "first"},
        {"const": "002", "description": "second"},
        {"const": "003", "description": "third"}
      ]
    }
  }

However, I tried this schema and it didn't seem to work.

Ideally we could also preserve the markup by using x-intellij-html-description property if possible

Screenshot 2024-10-28 at 2 32 41 PM

To reproduce

No response

Log output

No response

@Patrick-Erichsen Patrick-Erichsen added the good-first-issue Suggested issue for new contributors label Oct 28, 2024
@dosubot dosubot bot added area:configuration Relates to configuration options ide:jetbrains Relates specifically to JetBrains extension priority:medium Indicates medium priority labels Oct 28, 2024
@RomneyDa
Copy link
Collaborator

RomneyDa commented Nov 1, 2024

@Patrick-Erichsen looks like this has been added at some point?
Found one missing for the config_rc_schema generation, quick add here
#2779

@Patrick-Erichsen
Copy link
Collaborator Author

@RomneyDa bit of a typo in the original description ( just updated it). This is specifically in regards to the 'markdownEnumDescriptions'.

See this line: https://github.com/continuedev/continue/blob/main/extensions%2Fintellij%2Fsrc%2Fmain%2Fresources%2Fconfig_schema.json#L203

@RomneyDa
Copy link
Collaborator

RomneyDa commented Nov 3, 2024

Ah great, I'll just merge that one change and then leave the markdownEnumDescriptions as good first issue!

Copy link

github-actions bot commented Mar 3, 2025

This issue hasn't been updated in 90 days and will be closed after an additional 10 days without activity. If it's still important, please leave a comment and share any new information that would help us address the issue.

@github-actions github-actions bot added the stale label Mar 3, 2025
Copy link

This issue was closed because it wasn't updated for 10 days after being marked stale. If it's still important, please reopen + comment and we'll gladly take another look!

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Mar 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:configuration Relates to configuration options good-first-issue Suggested issue for new contributors ide:jetbrains Relates specifically to JetBrains extension priority:medium Indicates medium priority stale
Projects
None yet
Development

No branches or pull requests

2 participants