Name suggestion for patternProperties

[fkorotkov]

It will be nice to have a way to list some possible options for a pattern property so an IDE can suggest these options for completion.

[handrews]

@fkorotkov could you provide some examples of what you mean?

[fkorotkov]

Sure! For example in my case, I was working on a schema for Cirrus CI: SchemaStore/schemastore#488

There I have such pattern property:

"patternProperties": {
  "(.*)task": {
    ...
  }
}

Which means there can be multiple tasks defined. Tasks like build_task, test_task, lint_task, deploy_tasks. And 99.9% of the users would use only these 4 names.

I would love to add such suggestions within a schema so editors can use them and do suggestions.

"patternPropertyExamples": ["build_task", "test_task", "lint_task", "deploy_task"],
"patternProperties": {
  "(.*)task": {
    ...
  }
}

I created this issue just for a record of my use case. Maybe some other people will find it useful too. It's not something very important, but can definitely be useful for schemas that use patternProperties.

[gregsdennis]

This sounds like a good candidate for a schema extension keyword, a concept that @handrews, myself, and a few others have been discussing over several issues.

In short, you would be able to define your own keywords, what they mean, and how they interact with the rest of the schema.

Personally, this feels like an application-level feature (live value suggestion as the user types) rather than something that would produce an output during validation or annotation collection.

[fkorotkov]

Is there an issue to support keywords? Didn't find with a quick search. I'll close this issues and link to the keywords one.

[gregsdennis]

The primary one would probably be #602 right now. It links to a bunch of other issues that relate to it.

[fkorotkov]

Thank you, all! Closing this issue. Will watch #602