@doist/integrations-common

integrations-common

Common utilities for integrations written with Typescript.

Installation

npm install @doist/integrations-common

Development + Testing

Instead of having an example app in the repository to assist development and testing, we have included ts-node as a dev dependency. This allows us to have a scratch file locally that can import and utilize the modules in the project while developing or reviewing pull requests without having to manage a separate app project.

• Add a file named scratch.ts in the src folder.
• Configure your IDE to run the scratch file with ts-node (instructions for VSCode, WebStorm), or you can optionally run ts-node in a terminal using instructions here.
• Import and call the relevant modules and run the scratch file.

Example scratch.ts file:

import { truncate } from './utils/stringUtils'

const truncatedString = truncate('This string is too long', 10)
console.log(truncatedString)

Publishing

This project uses semantic versioning. A new version will be published to GitHub Package Registry when a new tag is pushed.

npm version <major|minor|patch>
git push --follow-tags