# typescript-package-template

> This is a template for a typical npm package written in typescript. [Create a github repo based on it](../../generate), clone the repo and run `npm start` or `. ./RUN_THIS_UPON_FIRST_CLONE.sh`

Latest version **1.1.0** (published 2019-08-13) · UNLICENSED license · 0 weekly downloads

## Install

```sh
npm install typescript-package-template
pnpm add typescript-package-template
yarn add typescript-package-template
bun add typescript-package-template
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2019-08-13 |
| First published | 2019-08-13 |
| Weekly downloads | 0 |
| License | UNLICENSED |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 21.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Alex Lapa |
| Maintainers | wrumsby |

## Links

- npm: https://www.npmjs.com/package/typescript-package-template
- Repository: https://github.com/conqa/typescript-package-template
- Homepage: https://github.com/conqa/typescript-package-template#readme
- Issues: https://github.com/conqa/typescript-package-template/issues
- npm.io page: https://npm.io/package/typescript-package-template

## Recent versions

- 1.1.0 (latest) — 2019-08-13

## README

# typescript-package-template

This is a template for a typical npm package written in typescript. [Create a github repo based on it](../../generate), clone the repo and run `. ./RUN_THIS_UPON_FIRST_CLONE.sh`

# How this works

- `RUN_THIS_UPON_FIRST_CLONE.sh` will install a set of dependencies
- than it will run [plop](https://github.com/amwmedia/plop)
- user will be prompted to answer a set of simple questions using [inquirer](https://github.com/SBoudrias/Inquirer.js)
- plop than will create the whole project from [handlebars](http://handlebarsjs.com) templates in [./plop-templates](./plop/templates).
- script will run basic checks like tests and lint to make ensure healthy initial state of the repo
- as a result of this whole operation all the template-related files will be deleted or overwritten, including this readme
- project should be fully initialised and ready for initial PR

---
_Source: https://npm.io/package/typescript-package-template · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._