PRONTO

This package is a CLI tool to manage our internal workflows in Kindly organization.

Installation

Locally:

npm install -D @kindly/pronto

Globally:

npm install -g @kindly/pronto

If you have npm installed globally, you can also use pronto without installing:

npx @kindly/pronto@latest [command] [options]

Pronto make use of the following environment variables:

• PRONTO_SLACK_BOT_TOKEN: Required. The Slack bot token. Ask a colleague to give it to you.
• PRONTO_SLACK_USER_ID: Required. Your Slack user ID.
• PRONTO_CUSTOM_SLACK_CHANNEL_ID: Optional. The Slack channel ID Pronto will post messages to. If not provided, messages will be posted to the Product Tech Team channel.
• PRONTO_DEBUG: Optional. Either 0/undefined or 1. If 1, Pronto will follow some debug configurations, like posting messages to the Pronto debug channel instead of Product Tech Team channel.

Usage

$ pronto [command] [options]

Commands supported:

release

Create a new release by creating and pushing a new tag, then notify on Slack tech channel.

# Example
$ pronto release

Options supported:

• -n, --npm

  Make a release for an NPM package (it modifies the package.json).

• -w, --workspaces

  Pass --workspaces npm flag when making a release for an NPM package (only working with --npm flag).

dev

Merges your local current branch on top of the remote development branch, then notify on Slack tech channel. If there are conflicts, the command aborts and suggests using --replace.

# Example
$ pronto dev
$ pronto dev --ask
$ pronto dev --silent
$ pronto dev -as
$ pronto dev --yes
$ pronto dev -ys
$ pronto dev --replace

Options supported:

• -a, --ask

  Ask permission on Slack from the last person who committed to the development branch before taking over.

• -s, --silent

  Do not notify on Slack, instead post on the CLI.

• -r, --replace

  Replace the remote development branch with your local branch (force push). Default behavior is to merge your branch on top of the remote development branch.

• -y, --yes

  Skip all confirmations and prompts.

Global options supported:

• --help

  Show help messages about the package or specific commands.

• -v, --version

  Show the version of the installed package.

# Examples
$ pronto --help
$ pronto release --help
$ pronto -v

Development

Build

• Run npm run build to build the package in dist folder.

Lint

• Run npm run lint to run the linter.

pronto uses Biome for linting and formatting.

Release

• Merge your code changes into main branch (e.g. from a PR).
• Switch to the main branch.
• Run npm run release.

pronto will use itself to do its own release! 🎉