Skip to content
This repository has been archived by the owner on Jan 10, 2024. It is now read-only.

Trigger an error on unrecognized properties #173

Closed
dgutson opened this issue Nov 7, 2022 · 4 comments
Closed

Trigger an error on unrecognized properties #173

dgutson opened this issue Nov 7, 2022 · 4 comments

Comments

@dgutson
Copy link

dgutson commented Nov 7, 2022

I spent a long time trying to find the reason why sequence diagrams were not shown.
It turned out that there was this line in the changelog that I missed:

Renamed plantuml.sequenceDiagrams to plantuml.sequenceDiagram

I propose to throw an error on unrecognized properties. This would had help me to avoid wasting so much time. Likewise for typos.

@simonbrowndotje
Copy link
Contributor

Unfortunately this isn't really viable, given that people might be using their own properties (example).

@dgutson
Copy link
Author

dgutson commented Nov 7, 2022

In that case, what about "declaring" non-standard properties?

declare {
    property name "description"
}

This would also help documentation for users and prevent typos, help to detect breaking changes such as sequenceDiagram/s.

@dgutson
Copy link
Author

dgutson commented Nov 7, 2022

Moreover, there could be a property force.declare.properties to control this behavior.

@simonbrowndotje
Copy link
Contributor

If you'd like to perform further validation on your workspace, I'd recommend writing a DSL plugin to do this.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants