-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
eb26ffe
commit 65c6ff3
Showing
3 changed files
with
89 additions
and
92 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,7 @@ | ||
# 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. | ||
# bch-consumer | ||
|
||
An npm JS library for interacting with [ipfs-bch-wallet-consumer](https://github.com/Permissionless-Software-Foundation/ipfs-bch-wallet-consumer). | ||
|
||
# Licence | ||
[MIT](LICENSE.md) | ||
|
||
|
||
[MIT](LICENSE.md) |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters