Thanks to visit codestin.com
Credit goes to github.com

Skip to content

feat: add command to generate json schema for yamlls to allow for autocompletion #332

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.

Sign up for GitHub

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

Jump to bottom
Closed
harryvince wants to merge 3 commits into from
Closed

feat: add command to generate json schema for yamlls to allow for autocompletion #332

harryvince wants to merge 3 commits into from

Conversation

@harryvince
Copy link
Contributor

@harryvince harryvince commented Apr 22, 2025 •
edited
Loading

Adds support for autocompletion by yaml-language-server.

Added a new schema command under the docs section that will auto generate a json schema that can be used to validate keys within the yaml.

Users can then either add the schema validation to their file by doing the following:

Adding this comment at the top of their file:

# yaml-language-server: $schema=https://raw.githubusercontent.com/F1bonacc1/process-compose/main/schemas/process-compose-schema.json

or by adding the schema url to their respective config vscode or neovim

For testing this pr please use the following schema url: https://raw.githubusercontent.com/harryvince/process-compose/refs/heads/main/schemas/process-compose-schema.json

@harryvince harryvince changed the title feat: add script to generate json schema for yamlls to allow for autocompletion feat: add command to generate json schema for yamlls to allow for autocompletion Apr 22, 2025
@joeblew999
Copy link

joeblew999 commented Apr 27, 2025

nice !!

F1bonacc1
F1bonacc1 reviewed Apr 30, 2025
View reviewed changes
Copy link
Owner

@F1bonacc1 F1bonacc1 left a comment

Choose a reason for hiding this comment

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

Hey @harryvince,

Thanks for the PR!
This is a great idea!

I left you a few minor comments.

@harryvince harryvince force-pushed the main branch 2 times, most recently from e3f56e9 to 2a3e11d Compare April 30, 2025 21:03
@sonarqubecloud
Copy link

sonarqubecloud bot commented Apr 30, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@harryvince
Copy link
Contributor Author

harryvince commented Apr 30, 2025

@F1bonacc1 addressed those comments and updated the PR accordingly

@F1bonacc1
Copy link
Owner

F1bonacc1 commented May 2, 2025

Thanks, @harryvince, for addressing those so quickly.
One more request, since it's a new command, with new documentation.
Please add to the PR the result of make docs command, it should generate a new schema.md file.

@harryvince
Copy link
Contributor Author

harryvince commented May 2, 2025

Hey, so ran that command and it didn't output a schema.md file. Do I need to write a new doc file manually? Happy to do so, just checking

@joeblew999
Copy link

joeblew999 commented May 3, 2025

Btw I was planning to add a golang based tab auto completion system.

works at cli and web level . Not sure if I can make it work in vscode yet .

@F1bonacc1
Copy link
Owner

F1bonacc1 commented May 3, 2025

Hey, so ran that command and it didn't output a schema.md file. Do I need to write a new doc file manually? Happy to do so, just checking

Oh, I see that it is specified as hidden:

process-compose/src/cmd/docs.go

Line 52 in 2a3e11d

Hidden: true,

Then we are good to go.
I will pull it and merge it, I will have to fix nix vendorHash before merging. That's on me :)

F1bonacc1 added a commit that referenced this pull request May 5, 2025
@F1bonacc1
feat #332: update nix vendorHash
8bdaec0
@F1bonacc1
Copy link
Owner

F1bonacc1 commented May 5, 2025

Hey @harryvince,

The schema complains that the following hidden fields are required:

    name:
    original_config:
    replica_num:
    replica_name:
    executable:
    args

Is there a way to make the language server ignore those?
I can always make them private, but that will require some refactoring.

adasauce pushed a commit to adasauce/process-compose that referenced this pull request Jun 25, 2025
fix: add process struct tags to help yamlls recognize required fields
588f362 
addresses comments in F1bonacc1#332
@adasauce adasauce mentioned this pull request Jun 25, 2025
Merged
adasauce pushed a commit to adasauce/process-compose that referenced this pull request Jun 25, 2025
fix: add process struct tags to help yamlls recognize required fields
14e471d 
addresses comments in F1bonacc1#332
adasauce pushed a commit to adasauce/process-compose that referenced this pull request Jun 25, 2025
fix: add process struct tags to help yamlls recognize required fields
243cce0 
addresses comments in F1bonacc1#332
adasauce pushed a commit to adasauce/process-compose that referenced this pull request Jul 16, 2025
fix: add process struct tags to help yamlls recognize required fields
ca0e86d 
addresses comments in F1bonacc1#332
F1bonacc1 pushed a commit that referenced this pull request Jul 16, 2025
@F1bonacc1
fix: add process struct tags to help yamlls recognize required fields
78f704a 
addresses comments in #332
@dzmitry-lahoda
Copy link
Contributor

dzmitry-lahoda commented Aug 24, 2025

This branch has conflicts that must be resolved

@harryvince is any of your time available for that? thank you

@sonarqubecloud
Copy link

sonarqubecloud bot commented Aug 25, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@harryvince
Copy link
Contributor Author

harryvince commented Aug 25, 2025

@dzmitry-lahoda looks like after rebase there's no changes! appreciate someone else picking this up :) going to close down this pr now.

@harryvince harryvince closed this Aug 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@F1bonacc1 F1bonacc1 F1bonacc1 left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@harryvince @joeblew999 @F1bonacc1 @dzmitry-lahoda