architecture-as-code icon indicating copy to clipboard operation
architecture-as-code copied to clipboard

Unify command interfaces to use the same flags

Open willosborne opened this issue 1 year ago • 1 comments

Feature Request

Description of Problem:

Currently the different commands have some inconsistencies in their usage that may be confusing to users. For example, the validate command uses -m or --metaSchemasLocation to set a directory of schemas to load, whereas generate uses -s or --schemaDirectory.

These should be made consistent.

Potential Solutions:

Use --schemaDirectory in the case given. But we should also consider other parameters. Documentation should be updated, too.

willosborne avatar Jul 26 '24 13:07 willosborne

We should also make the -m flag on validate behave the same as -s on generate - it should recursively traverse the directory and load all schemas. Currently it only looks at the top level folder.

willosborne avatar Aug 05 '24 10:08 willosborne

I may have inadvertently resolved this with https://github.com/finos/architecture-as-code/pull/530 as I moved the params to be const strings.

rocketstack-matt avatar Oct 31 '24 16:10 rocketstack-matt

I was just looking at that the changes you made @rocketstack-matt, but I think the extracted params still have the same issue. I'll delete one and update the commands to use the same param const.

aidanm3341 avatar Oct 31 '24 16:10 aidanm3341

addressed in #571

aidanm3341 avatar Nov 13 '24 12:11 aidanm3341