zinggAI / zingg

Scalable identity resolution, entity resolution, data mastering and deduplication using ML
GNU Affero General Public License v3.0
950 stars 119 forks source link

IntelliSense via JSONSchema #183

Open tomdavidson opened 2 years ago

tomdavidson commented 2 years ago

Is your feature request related to a problem? Please describe.

Zingg config supports more than what is explicitly documented. New users, particularly users new to Spark as well (like me), may end up with some extra stumbling getting up and running.

Describe the solution you'd like

JSONSchema for the config file. Would allow validation of the config, but it would also provide a superior DX of IntelliSense in IDEs/editors such as VS Code. Publishing the schema at https://www.schemastore.org/json/ would provide an automatic experience for users.

Describe alternatives you've considered

This is a clear path to IntelliSense. Maybe a CLI wizard could interactive gen a working config and inform the user of options. I think the JSONSchema would be easier to create and better DX.

Additional context

sonalgoyal commented 2 years ago

@navinrathore please check this.