# @gargrave/ts-module-starter

> A basic setup for an NPM package built with TypeScript

Latest version **0.1.0** (published 2019-09-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install @gargrave/ts-module-starter
pnpm add @gargrave/ts-module-starter
yarn add @gargrave/ts-module-starter
bun add @gargrave/ts-module-starter
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2019-09-17 |
| First published | 2019-09-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 8.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Gabe Hargrave |
| Maintainers | gargrave |

## Links

- npm: https://www.npmjs.com/package/@gargrave/ts-module-starter
- npm.io page: https://npm.io/package/@gargrave/ts-module-starter

## Recent versions

- 0.1.0 (latest) — 2019-09-17
- 0.0.1 — 2019-09-14

## README

# TS Module Starter

A basic setup for a publish-ready package built in TypeScript. You can use it
either as a blueprint/outline, or just clone it, remove what you don't need, and
use it as a template.

## Overview

This is not intended to be a useful lib in itself, but rather provide a template
for building NPM packages that are ready to publish with TypeScript/React/etc.

This is about half-and-half on the opinionated front. Some of it is just basic
setup, but some other things (ESLint, Prettier, etc.) are set up for my own
preferences (but of course they can be tweaked as necessary).

Some of the features currently wired up are:

- Building/bundling for multiple targets (CommonJS, ES Modules, UMD) with `rollup`
- TypeScript/React compilation with `babel`
- Easy release management with `np`
- Testing with `jest`
- Linting with `eslint`
- Pre-commit hook for running `prettier` on staged files

## Improvements (TODO)

- Internal handling for styling (i.e. if you need to build a component lib
  with its own styles baked in)
- Add `react-styleguidist` (may require an additional Webpack setup if it
  cannot support Rollup)

---
_Source: https://npm.io/package/@gargrave/ts-module-starter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._