emmanuelnk / github-actions-workflow-ts Goto Github PK

It would be good to expose configuration options for the underlying YAML generator, in particular the line width parameter. By default js-yaml sets the line width to 80, which uses a folded style for yaml via >- character. This impedes readability for strings (e.g. both expressions and multilineString). It would be good to be able to configure line width folding, or even disable (e.g. by setting line width to -1).

Expected Behavior

Long strings are written as-is in a single/multi line, or folded at larger line width limit.

Actual Behavior

Long strings are folded at 80 characters.

Steps to Reproduce the Problem

1. Use long string in e.g. an if expression or run multilineString.
2. Generate workflow YAML

Specifications

• Version: 0.2.0
• Platform: Mac

Very nice tool by the way!

This looks awesome! I really like the API surface.

I think the current setup is great as a standalone tool, but not ideal for use in other packages.
For example in https://github.com/projen/projen we already have everything set up to generate YAML files from a JS object.
A zero-dependency library version of this package would make it easier to include in other tools.

Current Behavior

The package is a CLI and library all-in-one tool.

As far as I can tell all its dependencies are used for the CLI only:

    "fast-glob": "^3.2.11",
    "js-yaml": "^4.1.0",
    "ts-node": "^10.8.1",
    "yargs": "^17.4.0"

Expected Behavior

Publish a zero-dependency library version of this package that can be included in other projects.

Everything would work as before, but no files are created. Calling Workflow.asObject() will return the Workflow as an object that can than be manipulated further, and passed to any YAML tool and/or written to disk as desired.

 const exampleWorkflow = new Workflow('example-filename', { /***/ })
 exampleWorkflow.asObject();