Skip to content

[FEATURE] wrap output of action-io-generator if line exceeds a threshold #61

Open
@dkwon17

Description

@dkwon17

Is your feature request related to a problem? Please describe.

If I have this action.yml with a long input description:

inputs:
  foo:
    required: true
    description: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
    default: foo-default

and use the action-io-generator to generate inputs-outputs.ts using npx action-io-generator --actionYml ./action.yml --outFile ./src/generated/inputs-outputs.ts, the result becomes:

export enum Inputs {
    /**
     * Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
     * Required: true
     * Default: "foo-default"
     */
    FOO = "foo",
}

Describe the solution you'd like

It would be nice if there was an option (ex, --line-wrap [# of characters])to wrap the long description into multiple lines:

export enum Inputs {
    /**
     * Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore
     * et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut
     * aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum
     * dolore eu fugiat nulla pariatur.
     * Required: true
     * Default: "foo-default"
     */
    FOO = "foo",
}

This would be great for readability, and it would also work well with alongside eslint's max-len if that's configured.
image

Describe alternatives you've considered

Additional context

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions