@thomaschaplin/cusip-generator - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

package.json

 {
-  "name": "@thomaschaplin/cusip-generator",
-  "version": "1.0.2",
-  "description": "Generate a valid CUSIP",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/thomaschaplin/cusip-generator.git"
-  },
-  "keywords": [
-    "cusip",
-    "generator",
-    "cusip-generator",
-    "thomaschaplin"
-  ],
-  "author": "Thomas Chaplin",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/thomaschaplin/cusip-generator/issues"
-  },
-  "homepage": "https://github.com/thomaschaplin/cusip-generator#readme"
+    "name": "@thomaschaplin/cusip-generator",
+    "version": "1.0.3",
+    "description": "Generate a valid CUSIPn",
+    "main": "build/index.js",
+    "files": [
+        "build",
+        "LICENSE",
+        "readme.md",
+        "assets/logo.png"
+    ],
+    "scripts": {
+        "test": "jest",
+        "test:coverage": "jest --coverage",
+        "build": "rimraf ./build && tsc",
+        "watch": "rimraf ./build && tsc --watch",
+        "start": "node build/index.js"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/thomaschaplin/cusip-generator"
+    },
+    "bugs": {
+        "url": "https://github.com/thomaschaplin/cusip-generator/issues"
+    },
+    "homepage": "https://github.com/thomaschaplin/cusip-generator#readme",
+    "keywords": [
+        "cusip",
+        "generator",
+        "cusip-generator",
+        "thomaschaplin"
+    ],
+    "author": "Thomas Chaplin <[e-mail]>",
+    "license": "MIT",
+    "devDependencies": {
+        "@types/node": "^13.9.2",
+        "husky": "^4.2.3",
+        "rimraf": "^3.0.2",
+        "typescript": "^3.8.3",
+        "@types/jest": "^26.0.0",
+        "jest": "^26.0.1"
+    }
 }

readme.md

@@ -0,22 +1,24 @@
+<img src="assets/logo.png" alt="logo" width="201" height="245" />
+
 # cusip-generator
-![npm (scoped)](https://img.shields.io/npm/v/@thomaschaplin/cusip-generator)
-[![GitHub issues](https://img.shields.io/github/issues/thomaschaplin/cusip-generator)](https://github.com/thomaschaplin/cusip-generator/issues)
-[![GitHub forks](https://img.shields.io/github/forks/thomaschaplin/cusip-generator)](https://github.com/thomaschaplin/cusip-generator/network)
-[![GitHub stars](https://img.shields.io/github/stars/thomaschaplin/cusip-generator)](https://github.com/thomaschaplin/cusip-generator/stargazers)
-[![GitHub license](https://img.shields.io/github/license/thomaschaplin/cusip-generator)](https://github.com/thomaschaplin/cusip-generator/blob/master/LICENSE)
 
-Generate a random CUSIP
+cusip-generator is a [Node.js](https://nodejs.org/en/) library to generate
+random CUSIP with a single API.
 
-CUSIP stands for Committee on Uniform Securities Identification Procedures. A CUSIP number identifies most financial instruments, including: stocks of all registered U.S. and Canadian companies, commercial paper, and U.S. government and municipal bonds.
+CUSIP stands for Committee on Uniform Securities Identification Procedures. A
+CUSIP number identifies most financial instruments, including: stocks of all
+registered U.S. and Canadian companies, commercial paper, and U.S. government
+and municipal bonds.
 
-## Install
+## Usage
 
 `npm i @thomaschaplin/cusip-generator`
 
-## Usage
+### Example Usage
 
-### ES5
+#### ES5
+
 ```js
-const generateCusip = require('@thomaschaplin/cusip-generator')
-console.log(generateCusip.generateCusip()) // 327492T38
+const generateCusip = require("@thomaschaplin/cusip-generator");
+console.log(generateCusip.generateCusip()); // 327492T38
 ```
@@ -27,7 +29,7 @@
 ```js
-const { generateCusip } = require('@thomaschaplin/cusip-generator')
-console.log(generateCusip()) // 5519069J1
+const { generateCusip } = require("@thomaschaplin/cusip-generator");
+console.log(generateCusip()); // 5519069J1
 ```
 
-### ES6
+#### ES6
 
@@ -39,3 +41,27 @@ ```js
 
-## License 
-[MIT](./LICENSE)
+## Setup
+
+Make sure you have [Node.js](https://nodejs.org/en/) installed on your machine
+
+### Development
+
+#### Installation
+
+- Clone this repository
+  `git clone [e-mail]:thomaschaplin/cusip-generator.git`
+- Change directory `cd cusip-generator`
+- Install the dependencies `npm install`
+- Transpile the code `npm run build` or `npm run watch`
+
+#### Tests
+
+- Run the tests `npm test`
+- Run the tests with coverage `npm test:coverage`
+
+## License
+
+[MIT](./LICENSE)
+
+---
+
+[Logo](https://www.clipartkey.com/view/iwiixw_yes-we-offer-both-short-term-interest-free/) graphic by <a href="https://www.clipartkey.com/upic/1115/">Perlenfuerdiehunde</a> from ClipArtKey.

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

40138

increased by854.76%

Number of package files

40

increased by900%

Lines of code

154

increased by541.67%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

66

increased by69.23%

Worsened metrics

Dev dependency count

6

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes