https://github.com/gabro/cli-typescript-boilerplate

A boilerplate for writing CLI tools in TypeScript
https://github.com/gabro/cli-typescript-boilerplate

boilerplate cli typescript

Last synced: 2 months ago
JSON representation

A boilerplate for writing CLI tools in TypeScript

• Host: GitHub
• URL: https://github.com/gabro/cli-typescript-boilerplate
• Owner: gabro
• License: mit
• Created: 2017-07-24T12:24:18.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2017-07-26T09:47:12.000Z (about 7 years ago)
• Last Synced: 2024-06-18T08:34:05.196Z (4 months ago)
• Topics: boilerplate, cli, typescript
• Language: TypeScript
• Homepage:
• Size: 134 KB
• Stars: 43
• Watchers: 3
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# cli-typescript-boilerplate

A boilerplate for writing CLI tools in TypeScript.

## Motivation

I write short self-contained CLI tools quite often, and they all follow a basic structure that I decided to "formalize" in this boilerplate, and minimize the time of setting this up.

TypeScript is also a great workflow improvement (type-safety and autocompletion in the editor are awesome!) but it takes a while to configure if you start from scratch.

Another thing that's not straightforward is how to **test** interactive CLI. In this boilerplate I give an example of how to test a CLI command using [Jest's Snapshot Testing](https://facebook.github.io/jest/docs/snapshot-testing.html).

## Technology (opinionated) choices

The CLI "interface" uses [yargs](https://github.com/yargs/yargs), which provides arguments/options parsing and validation, as well as a convenient separation in sub-commands.

Another library that's showcased (and that I heavily use in real projects) is [Inquirer.js](https://github.com/SBoudrias/Inquirer.js/), that provides a delightful experience to the users, with rich and interactive prompts that are a pleasure to use.

As mentioned, [TypeScript](typescriptlang.org) is awesome for speeding up the workflow and catching errors early on in the development phase, especially in the starting phase where many refactors occur. Even if you don't explicitly annotate your functions, you will still get benefits from TS.

[Jest](https://facebook.github.io/jest/) is also an amazing tool, which provides a very pleasant testing experience, with almost no configuration. It's snapshot feature has become known for React components, but it's also very appropriate for testing the output of a CLI program.

Finally, linting is done via [ESLint](eslint.org) (with [typescript-eslint-parser](https://github.com/eslint/typescript-eslint-parser) for TypeScript support) and [prettier](https://prettier.io/) runs automatically on git commits, leaving no room for mis-formatted code and bad code practices.