@relocke/base58 - npm Package Compare versions

Comparing version 0.0.1 to 1.0.0

changelog.md

@@ -1,3 +0,11 @@
-# base58 changelog
+# @relocke/base58 changelog
 
+## 1.0.0
+### Major
+
+- Added [size-limit](https://github.com/ai/size-limit).
+- Testing in ems (.mjs).
+- Update configuration.
+- updated dev dependencies
+
 ## 0.0.1
@@ -4,0 +12,0 @@

package.json

 {
   "name": "@relocke/base58",
-  "version": "0.0.1",
-  "private": false,
-  "description": "A simple base58 encode / decode",
-  "main": "index.js",
+  "version": "1.0.0",
+  "description": "A ultra light weight (566 byte) base58 encode / decode",
+  "author": "ReLocke",
+  "license": "MIT",
+  "main": "src/index.js",
   "engines": {
-    "node": "14.x"
+    "node": ">= 8"
   },
+  "browserslist": ["defaults","not IE 11"],
+  "files": [
+    "src"
+  ],
   "repository": {
@@ -17,14 +22,21 @@ "type": "git",
     "decode",
-    "encode"
+    "encode",
+    "bitcoin",
+    "blockchain"
   ],
   "scripts": {
-    "test": "coverage-node -r hard-rejection/register tests",
-    "jsdoc": "jsdoc-md"
+    "test:eslint": "eslint --ext mjs,js .",
+    "test:size": "size-limit",
+    "test:api": "coverage-node -r hard-rejection/register tests/index.test.mjs",
+    "test": "npm run test:size && npm run test:api && npm run test:eslint",
+    "jsdoc": "jsdoc-md",
+    "prepublishOnly": "npm test"
   },
-  "author": "H",
-  "license": "MIT",
   "devDependencies": {
+    "@babel/core": "^7.12.10",
+    "@babel/preset-env": "^7.12.10",
+    "@size-limit/preset-small-lib": "^4.9.1",
     "babel-eslint": "^10.1.0",
     "coverage-node": "^3.0.0",
-    "eslint": "^7.14.0",
+    "eslint": "^7.15.0",
     "eslint-config-env": "^15.0.1",
@@ -36,3 +48,3 @@ "eslint-config-prettier": "^6.15.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^3.1.4",
+    "eslint-plugin-prettier": "^3.2.0",
     "eslint-plugin-react": "^7.21.5",
@@ -43,4 +55,5 @@ "eslint-plugin-react-hooks": "^4.2.0",
     "prettier": "^2.2.1",
+    "size-limit": "^4.9.1",
     "test-director": "^4.0.1"
   }
 }

README.md

 # @ReLocke/base58
 
-A simple stand alone JS implementation for base58 encoding & decoding
+A ultra light weight stand alone JS implementation for base58 encoding & decoding.
 
+- zero dependencies 🙅
+- Only ~500 Bytes 🤏
+
+size guaranteed with [size-limit](https://github.com/ai/size-limit)
+
+[![npm version](https://badgen.net/npm/v/@relocke/base58)](https://www.npmjs.com/package/@relocke/base58)
+
+
+## support
+
+- Node.js >= 8
+- Browser support for [spread destructuring](https://caniuse.com/?search=spread) and [Uint8Array](https://caniuse.com/?search=Uint8Array)
+
+
+## setup
+```shell
+npm i --save @relocke/base58
+```
+
+#### esm import
+```js
+import { base58_to_binary, binary_to_base58 } from '@relocke/base58'
+```
+```js
+import base58_to_binary from '@relocke/base58/base58_to_binary.js'
+```
+#### cjs require
+```js
+const {
+  base58_to_binary,
+  binary_to_base58
+} = require('@relocke/base58/base58_to_binary.js')
+```
+```js
+const base58_to_binary = require('@relocke/base58/base58_to_binary.js')
+```
+
 ### Reference
@@ -6,0 +43,0 @@

src/base58_chars.js

@@ -10,4 +10,2 @@ /**
 
-module.exports = {
-  base58_chars
-}
+module.exports = base58_chars

src/base58_to_binary.js

@@ -1,2 +0,2 @@
-const { base58_chars } = require('./base58_chars.js')
+const base58_chars = require('./base58_chars.js')
 
@@ -48,4 +48,2 @@ /**
 
-module.exports = {
-  base58_to_binary
-}
+module.exports = base58_to_binary

src/binary_to_base58.js

@@ -1,2 +0,2 @@
-const { base58_chars } = require('./base58_chars.js')
+const base58_chars = require('./base58_chars.js')
 
@@ -51,4 +51,2 @@ const create_base58_map = () => {
 
-module.exports = {
-  binary_to_base58
-}
+module.exports = binary_to_base58

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

106

increased by53.62%

Worsened metrics

Total package byte prevSize

9136

decreased by-10.15%

Dev dependency count

20

increased by25%

Number of package files

8

decreased by-50%

Lines of code

103

decreased by-45.21%

No dependency changes