Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update flag names #30

Merged
merged 2 commits into from
Feb 19, 2024
Merged

Update flag names #30

merged 2 commits into from
Feb 19, 2024

Conversation

RDPerera
Copy link
Member

Purpose

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, This PR will update the following flag names:

  1. 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 updated -s to -i.
  2. 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, both flags are combined into a single flag, -p, --package for specifying both the output path and library name.

Fixes ballerina-platform/ballerina-library#6045

@RDPerera RDPerera requested a review from chathurace as a code owner February 15, 2024 06:09
niveathika
niveathika previously approved these changes Feb 19, 2024
Copy link
Contributor

@niveathika niveathika left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

But since this is a breaking change, lets update to next major version.

@RDPerera
Copy link
Member Author

LGTM

But since this is a breaking change, lets update to next major version.

Sure, updated to the next major version.

@RDPerera RDPerera requested a review from niveathika February 19, 2024 05:39
@niveathika niveathika merged commit cc2fce3 into ballerina-platform:main Feb 19, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update flag names for consistency in Ballerina EDI tool
2 participants