# @chris.troutner/npm-lib-boilerplate

> A boilerplate for creating an npm library with Semantic Release, linting, and tests.

Latest version **1.0.13** (published 2022-10-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install @chris.troutner/npm-lib-boilerplate
pnpm add @chris.troutner/npm-lib-boilerplate
yarn add @chris.troutner/npm-lib-boilerplate
bun add @chris.troutner/npm-lib-boilerplate
```

## 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.0.13 |
| Published | 2022-10-04 |
| First published | 2020-08-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 14.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Chris Troutner |
| Maintainers | chris.troutner |
| Keywords | bitcoin, bitcoin cash, wallet, javascript, cryptocurrency, react, front end, client, apidoc, slp, tokens |

## Links

- npm: https://www.npmjs.com/package/@chris.troutner/npm-lib-boilerplate
- Repository: https://github.com/christroutner/npm-lib-boilerplate
- Homepage: https://github.com/christroutner/npm-lib-boilerplate#readme
- Issues: https://github.com/christroutner/npm-lib-boilerplate/issues
- npm.io page: https://npm.io/package/@chris.troutner/npm-lib-boilerplate

## Dependencies (1)

- [@psf/bch-js](https://npm.io/package/@psf/bch-js.md) 6.4.5

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.13 (latest) — 2022-10-04
- 1.0.12 — 2022-08-29
- 1.0.11 — 2021-10-31
- 1.0.10 — 2021-10-16
- 1.0.9 — 2021-08-25
- 1.0.8 — 2021-03-24
- 1.0.7 — 2021-02-03
- 1.0.6 — 2021-01-26
- 1.0.5 — 2021-01-26
- 1.0.4 — 2021-01-04
- 1.0.3 — 2020-11-14
- 1.0.2 — 2020-08-10
- 1.0.1 — 2020-08-10
- 1.0.0 — 2020-08-10

## README

# npm-lib-boilerplate

This repository is a code 'boilerplate' for starting a new npm library. It
contains the following features:

- [Semantic Release](https://github.com/semantic-release/semantic-release) configured to work with [Travis CI](https://travis-ci.org/).
- Automatic linting using [Standard](https://www.npmjs.com/package/standard) JavaScript.
- Unit and integration tests using Mocha and Chai, following the best practices and design patterns in [this YouTube video](https://www.youtube.com/watch?v=lE3RYnchHps):
  - Uses ECMAScript 2015 `Class` for business logic and utility libraries.
  - Follows [TDD](https://builttoadapt.io/why-tdd-489fdcdda05e) best practices.
  - Uses `_this` to maintain context to the instance of the class.
  - Uses [Sinon stubs](https://sinonjs.org/releases/latest/stubs/) to mock external dependencies for unit tests.
  - Each function is wrapped in try/catch statements, allowing thrown errors to 'bubble up' to the top-level function, and give every function along the way an opportunity to handle exceptions.
  - Testing assertions focus on properties and structure, not values.


# Licence
[MIT](LICENSE.md)

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