Skip to content

ShipitSmarter/vscode-stitch-integration-templater

Repository files navigation

Stitch integration templater

This is a vscode extension to help start a new Stitch carrier integration, or update an existing one with new scenarios.

Commands

Contributes the following commands, which are available from the Command Palette (Ctrl+Shift+P):

Stitch: Create or update carrier integration

  • Dashboard for creating new or updating existing Stitch carrier integration.

    Stitch integration templater

    When updating an existing integration, it is possible to add new steps to the *.integration.json file using the dashboard:

    Add steps to existing integration

    It is possible to load an existing integration (if compatible) to the dashboard by right-clicking the associated *.integration.json file and selecting option Load file to create/update integration panel:

    Load file to create/update integration panel

    Note: to enable this button, .vscode/settings.json must have setting stich.integrationtemplater.enabled = true.

Stitch: Create Postman collection

  • Dashboard for easily generating a postman collection file from an existing scenario.

    Stitch Create Postman collection

Modular scenarios

  • Both Integration and Postman collection panels allow you to create modular scenarios using tile and package type selection:

    Modular tiles

Stitch: Get/Set parameters

  • Dashboard for mass check and update of SiS parameters, either by uploading a CSV, or by manual input.

    Get Set Parameters

    In order to load a CSV file, select Load file to 'get/set parameters' from the right-mouse-menu in the Explorer sidebar to load it directly to a new or existing instance of the panel:

    Load CSV file to get/set parameters

    Note: to enable this, .vscode/settings.json must have setting stich.parameters.enabled = true.

Right-mouse-menu button: Sort Scriban functions file

  • In order to sort functions alphabetically in a given Scriban file (using the ShipitSmarter integration automation PowerShell script), right-click on a given Scriban file and select Sort Scriban functions file:

    Sort Scriban functions file

    Note: to enable this, .vscode/settings.json must have setting stich.sortscriban.enabled = true.

Settings

Stitch: Basic Authentication String

  • In order for API calls to SiS APIs from the extension to work, one must update the setting through Ctrl + , -> Stitch: Basic Authentication String:

    Stitch Basic Authentication String

Stitch: Parameters Default Auto Trim

  • When using the parameters tool, there is a checkbox to determine whether input values should be trimmed automatically. This checkbox is by default checked. This setting allows for the user to change the default value of this checkbox:

    Stitch: Parameters Default Auto Trim

Dependencies

This dashboard is a graphical frontend for the ShipitSmarter integration automation PowerShell script, and does not function independently without it.

Change Log

See Change Log here

Issues

Submit the issues if you find any bug or have any suggestion.

Contribution

Fork the repo and submit pull requests.

Acknowledgements

  • Icon used by this extension - source