Add a JSON schema

[UnderKoen]

Description

I would like to have the benefits of #130 without using js.

Justification (Why)

#146

How Can This Be Tested?

• Create a JSON file
• Define field $schema with value https://raw.githubusercontent.com/UnderKoen/syncpack/main/schema.json
• Make a valid / invalid config and test
• Alternatively you can use https://www.jsonschemavalidator.net/ for testing, here you need to paste the content of schema.json

[JamieMason]

Thanks a lot for this @UnderKoen, I can pick up most of this from here but I did leave some questions about things I didn't understand if you could help me out please.

[JamieMason]

What was happening when you made this change? Maybe I can help. This doesn't seem right as Ignored and WithRange are mutually exclusive but this change makes them a combination of both types added together.

This comment also apples to the same change made below.

[UnderKoen]

What was happening when you made this change?

ts-json-schema-generator doesn't understand the union type.

This doesn't seem right as Ignored and WithRange are mutually exclusive but this change makes them a combination of both types added together.

Maybe I don't understand the union correctly. It is a combination of the types right?
The Union.Strict makes sure when type is Ignored all other fields of Ignored are also required.

What you want would be:

Suggested change

	export type Any = GroupConfig & Partial<Ignored & WithRange>;
	export type Any = Ignored | WithRange;

Here it is not possible to define Ignored and WithRange

[JamieMason]

Hopefully this makes sense, what Union.Strict<Ignored | WithRange> is describing is:

// Accept exactly one or the other of the types inside <here>
// - do not allow an Ignored with additional properties
// - do not allow a WithRange with additional properties
// - do not allow an Ignored with a WithRange on top of it
Union.Strict<
  // Accept either one or the other, but not both at the same time
  Ignored | WithRange
>

In contrast Ignored & WithRange is creating one new type, which is Ignored with all the properties of WithRange merged together on top into one object.

Maybe give it a try by going back to how it was but remove every usage of Union.Strict and see if everything still works. It may be fine, but I think possibly there may be some cases where the problems linked here may come up.

[JamieMason]

What was happening when Union.Strict was still there please?

[UnderKoen]

Union.Strict was doing nothing here, because all of these types have the same fields.

[JamieMason]

Released in 11.2.1