Use JSON Schema to make IDE support yaml lint and hint.

[Mini256]

Feature Request

• I have searched the issues of this repository and believe that this is not a duplicate.

Describe the feature you'd like:

We can use JSON Schema to make IDE support yaml lint and hint, which can help us avoid some errors on IDE prompts.

Do you have any ideas on how to implement it?(Optional)

We can use jsonschema to automatically generate JSON Schema according to the Go language type definition, and then import the json file into the configuration in the IDE (Such as Goland).

config

type Configuration struct {
	TichiWebURL     string `json:"tichi_web_url,omitempty" jsonschema:"required"`
	PRProcessLink   string `json:"pr_process_link,omitempty" jsonschema:"required"`
	CommandHelpLink string `json:"command_help_link,omitempty" jsonschema:"required"`
}

json generated

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "required": [
    "tichi_web_url",
    "pr_process_link",
    "command_help_link"
  ],
  "properties": {
    "tichi_web_url": {
      "type": "string"
    },
    "pr_process_link": {
      "type": "string"
    },
    "command_help_link": {
      "type": "string"
    },
  },
  "additionalProperties": false,
  "type": "object",
  "definitions": {}
}

preview

[Rustin170506]

Cool!

[ti-chi-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
If this issue is safe to close now please do so with /close.
Send feedback to sig-community-infra or Mini256.
/lifecycle stale

[Rustin170506]

/remove-lifecycle stale

[ti-chi-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
If this issue is safe to close now please do so with /close.
Send feedback to sig-community-infra or Mini256.
/lifecycle stale

[ti-chi-bot]

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
If this issue is safe to close now please do so with /close.
Send feedback to sig-community-infra or Mini256.
/lifecycle rotten