Incorrect help text in CLI page

[anupama-pathirage]

Description

$subject in https://ballerina.io/learn/cli-commands/#use-the-ballerina-tool

1. There is additional command named tool which is not there in the output. @azinneera it seems this command is not displayed as Other command in help text. Is that correct? If correct, we need to update the docs.

2. EDI command is not there.

[azinneera]

2. EDI command is not there.

We moved the tool to the Other Commands section. We have missed to update the website doc.

About the EDI Command - we didn't add it to the website since it will be shown only if the user has installed it. We might have to add an additional doc to show how the help text works for a custom tool installation.

[anupama-pathirage]

@azinneera, is it correct to have the edi command listed here in the help text? All the commands listed here are the ones which comes after bal. But edi comes after bal tool. And it is a custom tool command which is downloaded from central. So is it correct to to have it here as first level of commands here? Same applies to health command.

[gayaldassanayake]

Tool being listed under core commands in the website indeed is a mistake. Will fix right away.

However listing edi in the first level was a conscious decision since once edi tool (or any other tool installed with bal tool) is installed with bal tool pull edi, the user can use the edi tool with bal edi (and not bal tool edi) similar to any natively provided CLI command.

[anupama-pathirage]

I get the empty output when issuing bal help edi. Shouldn't we have help text for edi tool in that case?

Note: I have already installed edi tool.

[gayaldassanayake]

The printLongDesc(StringBuilder out) method that is provided with BLauncherCmd interface should append the help text to the out string builder. However, the method body is empty now.
https://github.com/ballerina-platform/edi-tools/blob/60ef628b6e59efea1c4efb12f338c3bf8735b98c/edi-cli/src/main/java/io/ballerina/edi/cmd/EdiCmd.java#L87

This section of the bal tool startup guide explains this.
https://docs.google.com/document/d/19ptscl5kcmvAmzztUv8EAhsx13DUdLIJanlZt2BsZG8/edit#heading=h.r9i8aegmayof

So the method should be as below.

@Override
    public void printLongDesc(StringBuilder out) {
        stringBuilder.append("Ballerina EDI tools -\n");
        stringBuilder.append("Ballerina code generation for edi schema: bal edi codegen -s <schema json path> -o <output bal file path>\n");
        stringBuilder.append("EDI library generation: bal edi libgen -O <org name> -l <library name> -s <EDI schema folder> -o <output folder>\n");
        stringBuilder.append("ESL to Ballerina EDI schema conversion: bal edi convertESL -b <Segment definitions file path> -s <ESL schema file/folder> -o <output file/folder>\n");
        stringBuilder.append("Ballerina X12 schema conversion: bal edi codegen [-H] [-c] -i <schema input path> -o <output json file/folder path> [-d] <segment details path>\n");
    }

@niveathika

[niveathika]

@RDPerera Lets look through and fix all possible edit text.

[RDPerera]

@RDPerera Lets look through and fix all possible edit text.

Fix the issues with 0.8.6 release from tool side. In the meantime, I am working on improving the help text of the EDI tool to match standard Ballerina CLI help texts as well.

[praneesha]

Fixed via #8538.

[github-actions]

This issue is NOT closed with a proper Reason/ label. Make sure to add proper reason label before closing. Please add or leave a comment with the proper reason label now.

      - Reason/EngineeringMistake - The issue occurred due to a mistake made in the past.
      - Reason/Regression - The issue has introduced a regression.
      - Reason/MultipleComponentInteraction - Issue occured due to interactions in multiple components.
      - Reason/Complex - Issue occurred due to complex scenario.
      - Reason/Invalid - Issue is invalid.
      - Reason/Other - None of the above cases.