https://github.com/amir-arad/typescript-boilerplate-cli

Generic project boilerplate for TypeScript CLI app
https://github.com/amir-arad/typescript-boilerplate-cli

Last synced: 4 days ago
JSON representation

Generic project boilerplate for TypeScript CLI app

• Host: GitHub
• URL: https://github.com/amir-arad/typescript-boilerplate-cli
• Owner: amir-arad
• License: mit
• Created: 2020-08-06T12:15:07.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-07-18T23:09:32.000Z (over 1 year ago)
• Last Synced: 2024-10-20T07:44:31.861Z (29 days ago)
• Language: TypeScript
• Size: 666 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Template Typescript CLI

A CLI application template project

## what's inside

 - code written in typescript

 - testing done with [Tape](https://www.npmjs.com/package/tape). consider switching to [tape-promise](https://www.npmjs.com/package/tape-promise) for async tests.

 - test files are inside the src library

 - prettier and eslint 

 - circleci setup for automatic testing

 - react + ink for console rendering

 - mew for command-line argument parsing

## Developer instructions

### Installing workspace

to install a development environment, you need to have node.js git installd.

Then, `git clone` this repo locally and run:

```

$ npm install

$ npm test

```

and that's it, you've just installed the development environment!

This project is written with [VSCode](https://code.visualstudio.com/) in mind. specifically configured for these extensions: [dbaeumer.vscode-eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint), [esbenp.prettier-vscode](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode). also recommended [CircleCI](https://marketplace.visualstudio.com/items?itemName=jvandyke.vscode-circleci)

### test

`npm run test`

execute all tests.

### clean

`npm run clean`

Removes any built code and any built executables.

### build

`npm run build`

Cleans, then builds the library.

Your built code will be in the `./dist/` directory.

### debug

read [how to debug an Ink application using react-dev-tools](https://github.com/vadimdemedes/ink#using-react-devtools)