# @patomation/nps

> TypeScript NPM Package Starter

Latest version **1.0.2** (published 2023-01-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install @patomation/nps
pnpm add @patomation/nps
yarn add @patomation/nps
bun add @patomation/nps
```

Provides the command `nps`.

## Health

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

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

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2023-01-22 |
| First published | 2023-01-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 12.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Patrick Kelly |
| Maintainers | patomation |
| Keywords | typescript |

## Links

- npm: https://www.npmjs.com/package/@patomation/nps
- Repository: https://github.com/USER/REPO_NAME
- Homepage: https://github.com/USER/REPO_NAME#readme
- Issues: https://github.com/USER/REPO_NAME/issues
- npm.io page: https://npm.io/package/@patomation/nps

## Dependencies (1)

- [clunk](https://npm.io/package/clunk.md) 1.1.0

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2023-01-22
- 1.0.1 — 2023-01-22

## README

# NPM Package Starter

```
NNNNNNNN        NNNNNNNN PPPPPPPPPPPPPPPPP       SSSSSSSSSSSSSSS
N:::::::N       N::::::N P::::::::::::::::P    SS:::::::::::::::S
N::::::::N      N::::::N P::::::PPPPPP:::::P  S:::::SSSSSS::::::S
N:::::::::N     N::::::N PP:::::P     P:::::P S:::::S     SSSSSSS
N::::::::::N    N::::::N   P::::P     P:::::P S:::::S
N:::::::::::N   N::::::N   P::::P     P:::::P S:::::S
N:::::::N::::N  N::::::N   P::::PPPPPP:::::P   S::::SSSS
N::::::N N::::N N::::::N   P:::::::::::::PP     SS::::::SSSSS
N::::::N  N::::N:::::::N   P::::PPPPPPPPP         SSS::::::::SS
N::::::N   N:::::::::::N   P::::P                    SSSSSS::::S
N::::::N    N::::::::::N   P::::P                         S:::::S
N::::::N     N:::::::::N   P::::P                         S:::::S
N::::::N      N::::::::N PP::::::PP           SSSSSSS     S:::::S
N::::::N       N:::::::N P::::::::P           S::::::SSSSSS:::::S
N::::::N        N::::::N P::::::::P           S:::::::::::::::SS
NODE___N         N_____N PACKAGE_P            STARTER_________S
```

The goal here is to have a vanilla project starter that includes TypeScript. In addition it has commit lint and ava for testing. So not so vanilla. More of a minimal preset. You get to chose your preferred front end framework. Enjoy making things.

### Features

- TypeScript
- [ava](https://github.com/avajs/ava) test framework
- nyc test coverage reporter
- standard-version
- commit-lint
- husky
- prettier
- pretty-quick staged formatting
- [clunk 4kb cli arg parser](https://www.npmjs.com/package/clunk)

![flavorite](https://raw.githubusercontent.com/patomation/vanilla-starter/master/public/favicon.ico)

# Install

```
npm i -G @patomation/nps
```

# Starting a new project

```
nps new my-new-ts-npm-package
cd my-new-ts-npm-package
npm i
```

# Updating an existing project

```
cd my-new-ts-npm-package
nps update
npm i
```

# Development

## Install

```
npm install
```

## Test

```
npm run test
# or
npm run watch:test
```

## Available NPM Scripts:

`npm run ...`

| Script          | Notes                                   |
| --------------- | --------------------------------------- |
|                 |                                         |
| compile:tests   |                                         |
| compile:package |                                         |
| compile         | both test and package                   |
| build           | transpile TyScript to JS /build dir     |
| unit            | run ava on /build                       |
| unit:coverage   | run coverage on /build                  |
| test            | compile /build and run unit tests       |
| coverage        | compile /build and test coverage report |
| watch:compile   | watch for change in src                 |
| watch:test      | run tests when src changes              |
| release         | trigger standard-version                |
| publish         | hook to push tags on npm publish        |
| prepare         | hook to install huksy on npm i          |
| prettier        | format all files with prettier          |

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