XSD schema for XML mapping #1334
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Excuse the clumsiness while typing on the recording, but here is an example of autocomplete using the XSD schema on PhpStorm: https://share.cleanshot.com/wrDBOU |
garak
requested changes
Nov 30, 2022
garak
approved these changes
Dec 3, 2022
|
Just another little doubt: should we update the docs as well? |
|
sorry, I was out on holidays. I'll update the XML in the docs as well, so users know they can benefit from the schema. |
show schema in use
garak
reviewed
Dec 9, 2022
| @@ -6,7 +6,8 @@ format and comes with the following syntax to declare your uploadable fields: | |||
| ```xml | |||
| <!-- config/vich_uploader/Entity.Product.xml --> | |||
| <!-- Attributes "mapping", "name" and "filename_property" are required --> | |||
| <vich_uploader class="Acme\DemoBundle\Entity\Product"> | |||
| <vich_uploader xmlns="https://vich-uploader-bundle/schema/" | |||
There was a problem hiding this comment.
So, I know that the "xmlns" attribute is not required to be a reachable URL, but I'm wondering how can the IDE understand where it's located (and so providing autocompletion). Could you clarify that?
There was a problem hiding this comment.
At least on phpstorm, if the file is within the project directories it will be picked up automatically.
|
Thank you @yivi |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Provides an XSD schema so that creating XML mapping is easier, since IDE can use it for autocompletion
Improvement
Summary
Creating an XML document without an associated XSD schema is error prone. With the provided XSD schema, IDEs can provide autocompletion, and XML files can be validated.