ctl-scripts

ctl-scripts

Develop, maintain, and release TypeScript libraries.

Features

• 🚀 Sensible defaults.
• 🏄‍♂️ On-the-fly code formatting, linting, and testing.
• 🖋 Conventional commits.
• 📮 Automated releases.

Getting started

Create a new library

$ npx ctl-scripts init my-library

Add to the existing library

You can incrementally adopt ctl-scripts in the existing library.

Start by installing ctl-scripts as your library's dependency:

$ npm install ctl-scripts -D
# or
$ yarn add ctl-scripts -D

Once the installation is complete, run the following command to initialize workflow hooks (i.e. Git hooks):

$ ctl-scripts init-hooks

Add these basic shorthand commands to your "package.json":

{
  "scripts": {
    "dev": "ctl-scripts dev",
    "test": "ctl-scripts test",
    "build": "ctl-scripts build"
  }
}

See Commands to supercharge your development workflow.

Commands

Tip: Get the list of all available commands by running ctl-scripts --help.

ctl-scrips lint

ctl-scripts test

ctl-scripts format

Formats the source code using Prettier.

ctl-scripts build

ctl-scripts publish

Publishes the library to the registry configured in your ".npmrc".

Honorable mentions

• kcd-scripts