Use refs in jsonschema

[karimkhaleel]

• PR Description

This turns the generated jsonschema into a flat-ter schema by using refs. This helps avoid the stack overflow described here: #4276 (comment)

As a side effect: os.editInTerminal started appearing in the generated section of Config.md. I think this is the correct behavior, and I am not sure why it wasn't in there before.

I feel like this still could use a bit of cleaning up. I might be able to get rid of the OriginalPropertiesMapping field that we added to jsonschema, but I need experiment some more when I get time.

• Please check if the PR fulfills these requirements

• Cheatsheets are up-to-date (run go generate ./...)
• Code has been formatted (see here)
• Tests have been added/updated (see here for the integration test guide)
• Text is internationalised (see here)
• If a new UserConfig entry was added, make sure it can be hot-reloaded (see here)
• Docs have been updated if necessary
• You've read through your own file changes for silly mistakes etc

[stefanhaller]

This is very nice, thanks for figuring out how to do this!

I took the liberty of dropping the commits from my branch and force-pushing, so that we can make this a stand-alone PR.

Just a few small things below, but apart from that I'm very happy with this.

[stefanhaller]

Suggestion:

		refSchema, ok := rootSchema.Definitions[key]
		if !ok {
			panic(fmt.Sprintf("Failed to find #/$defs/%s", key))
		}

[stefanhaller]

Some leftover from debugging, I suppose?

[stefanhaller]

I agree that it's good that this now shows up in the file. However, only the first line of the comment is for users, the other two are for developers and shouldn't be here.

I pushed a commit that lets us annotate such lines with a tag and filter them out: 1f3050c.

[stefanhaller]

This loop looks almost identical to the one in recurseOverSchema. Shouldn't it be possible to call recurseOverSchema on the root directly to avoid the duplication? I haven't looked very closely at this, so maybe I'm missing something.

[karimkhaleel]

You're absolutely right. I think there was a point during development where they had some differences but this loop became redundant after I wrote getSubSchema.

[stefanhaller]

Thanks for addressing my complaints, looks great now.

I had to run go mod vendor and go mod tidy to remove iancoleman/orderedmap, which is no longer used now. CI complained about this. I squashed this into the first commit.