Skip to content

Commit

Permalink
Customizing README and package.json
Browse files Browse the repository at this point in the history
  • Loading branch information
christroutner committed Jan 11, 2022
1 parent eb26ffe commit 65c6ff3
Show file tree
Hide file tree
Showing 3 changed files with 89 additions and 92 deletions.
19 changes: 3 additions & 16 deletions README.md
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)
146 changes: 78 additions & 68 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 8 additions & 8 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@chris.troutner/npm-lib-boilerplate",
"name": "bch-consumer",
"version": "1.0.0",
"description": "A boilerplate for creating an npm library with Semantic Release, linting, and tests.",
"description": "A npm JS library for interacting with ipfs-bch-wallet-consumer REST API",
"main": "index.js",
"scripts": {
"start": "node index.js",
Expand All @@ -28,12 +28,12 @@
"author": "Chris Troutner <chris.troutner@gmail.com>",
"license": "MIT",
"apidoc": {
"title": "npm-lib-boilerplate",
"title": "bch-consumer",
"url": "localhost:5000"
},
"repository": "christroutner/npm-lib-boilerplate",
"repository": "Permissionless-Software-Foundation/bch-consumer",
"dependencies": {
"@psf/bch-js": "4.20.21",
"@psf/bch-js": "4.21.0",
"apidoc": "0.25.0"
},
"devDependencies": {
Expand All @@ -45,13 +45,13 @@
"eslint-plugin-node": "11.1.0",
"eslint-plugin-prettier": "3.3.1",
"eslint-plugin-standard": "4.0.0",
"husky": "^4.3.8",
"husky": "4.3.8",
"lodash.clonedeep": "4.5.0",
"mocha": "^8.4.0",
"mocha": "8.4.0",
"nyc": "15.1.0",
"semantic-release": "17.4.2",
"sinon": "9.2.2",
"standard": "^16.0.4"
"standard": "16.0.4"
},
"release": {
"publish": [
Expand Down

0 comments on commit 65c6ff3

Please sign in to comment.