You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The current usage of flags in the Ballerina EDI Tool (bal edi) deviates from the standard conventions followed by other Ballerina tools. To align the EDI tool with the rest of the Ballerina tool suite and improve consistency for users, I propose updating the following flag names:
Change -s flag to -i for input path:
-s, --schema is currently used to specify the input path for various commands. To adhere to the standard convention of using -i --input for input-related flags across Ballerina tools, I suggest updating -s to -i.
Combine -O and -n flags into -p for output path and library name:
-O, --organization is used for specifying the output path in some commands, while -n, --name is used for providing the name of generated libraries in the libgen command. To streamline the usage and provide a more intuitive experience, I recommend combining these into a single flag, -p, --package for specifying both the output path and library name.
Describe your task(s)
For -s flag:
Change:
-s, --schema
to:
-i, --input
For -o and -n flags:
Combine:
-o, --organization
-n, --name
into:
-p, --package
Examples:
Before:
$ bal edi codegen -s resources/schema.json -o modules/orders/records.bal
$ bal edi libgen -O myorg -n order -s schemas/ -o lib/
After:
$ bal edi codegen -i resources/schema.json -o modules/orders/records.bal
$ bal edi libgen -p myorg/order -s schemas/ -o lib/
The text was updated successfully, but these errors were encountered:
Description:
The current usage of flags in the Ballerina EDI Tool (
bal edi
) deviates from the standard conventions followed by other Ballerina tools. To align the EDI tool with the rest of the Ballerina tool suite and improve consistency for users, I propose updating the following flag names:Change
-s
flag to-i
for input path:-s, --schema
is currently used to specify the input path for various commands. To adhere to the standard convention of using-i --input
for input-related flags across Ballerina tools, I suggest updating-s
to-i
.Combine
-O
and-n
flags into-p
for output path and library name:-O, --organization
is used for specifying the output path in some commands, while-n, --name
is used for providing the name of generated libraries in thelibgen
command. To streamline the usage and provide a more intuitive experience, I recommend combining these into a single flag,-p, --package
for specifying both the output path and library name.Describe your task(s)
For
-s
flag:Change:
to:
For
-o
and-n
flags:Combine:
into:
Examples:
Before:
After:
The text was updated successfully, but these errors were encountered: