ieee754-buffer - npm Package Compare versions

Comparing version 0.2.1 to 1.0.0

CHANGELOG.md

 # CHANGELOG
 
+## 1.0.0 - 2019-12-30
+- New package structure:
+	* dist file is "./dist/ieee754-buffer.js", a UMD served as "main"
+	* ES6 source is "./index.js", served as "module"
+
 ## 0.2.1 (2018-08-06)
@@ -13,2 +18,2 @@ - Fix docstring in packFloatBits_()
 ## 0.0.2 (2018-08-04)
-- UMD compatible with IE6+
+- UMD compatible with IE6+

package.json

 {
   "name": "ieee754-buffer",
-  "version": "0.2.1",
-  "description": "A class to encode and decode IEEE 754 floating point numbers.",
+  "version": "1.0.0",
+  "description": "A module to encode and decode IEEE 754 floating point numbers.",
   "homepage": "https://github.com/rochars/ieee754-buffer",
   "author": "Rafael da Silva Rocha <[e-mail]>",
   "license": "MIT",
-  "module": "./ieee754-buffer.js",
-  "types": "./ieee754-buffer.d.ts",
-  "main": "./ieee754-buffer.umd.js",
+  "main": "./dist/ieee754-buffer.js",
+  "module": "./index.js",
+  "types": "./index.d.ts",
   "engines": {
@@ -43,7 +43,9 @@ "node": ">=8"
   },
-  "directories": {},
+  "directories": {
+    "dist": "dist"
+  },
   "files": [
-    "ieee754-buffer.js",
-    "ieee754-buffer.d.ts",
-    "ieee754-buffer.umd.js",
+    "dist",
+    "index.js",
+    "index.d.ts",
     "LICENSE",
@@ -54,3 +56,3 @@ "CHANGELOG.md",
   "scripts": {
-    "lint": "jshint ieee754-buffer.js test/src",
+    "lint": "jshint index.js test/src",
     "test": "nyc ./node_modules/mocha/bin/_mocha test/src --recursive -R dot",
@@ -61,3 +63,3 @@ "test-umd": "node ./node_modules/mocha/bin/_mocha test/src --umd --recursive -R dot",
     "pack": "npm run test && rollup -c && npm run test-dist",
-    "doc": "./node_modules/.bin/jsdoc ieee754-buffer.js -d docs -r README.md -t node_modules/docdash",
+    "doc": "./node_modules/.bin/jsdoc -c .jsdocrc index.js -d docs -r README.md -t node_modules/docdash",
     "build": "npm run lint && npm run pack && npm run doc",
@@ -67,18 +69,15 @@ "coverage": "nyc report --reporter=lcov > coverage.lcov && codecov"
   "devDependencies": {
-    "babel-core": "^6.26.3",
-    "babel-plugin-external-helpers": "^6.22.0",
-    "babel-preset-env": "^1.7.0",
-    "codecov": "^3.0.2",
-    "docdash": "^0.4.0",
-    "esm": "^3.0.51",
-    "jsdoc": "^3.5.5",
-    "jshint": "^2.9.5",
-    "mocha": "^5.2.0",
+    "@ampproject/rollup-plugin-closure-compiler": "^0.13.0",
+    "codecov": "^3.6.1",
+    "docdash": "^1.1.1",
+    "esm": "^3.2.25",
+    "jsdoc": "^3.6.3",
+    "jshint": "^2.10.3",
+    "mocha": "^6.2.2",
     "mocha-lcov-reporter": "^1.3.0",
-    "nyc": "^12.0.2",
-    "rollup": "^0.61.2",
-    "rollup-plugin-babel": "^3.0.7",
-    "typescript": "^2.9.2"
+    "nyc": "^14.1.1",
+    "rollup": "^1.27.14",
+    "typescript": "^3.7.4"
   },
   "dependencies": {}
 }

README.md

 # ieee754-buffer
-Copyright (c) 2018 Rafael da Silva Rocha.  
+Copyright (c) 2018-2019 Rafael da Silva Rocha.  
 Copyright (c) 2013 DeNA Co., Ltd.  
@@ -10,11 +10,7 @@ Copyright (c) 2010, Linden Research, Inc
 
-**ieee754-buffer** is a ES module to encode and decode IEEE 754 floats without typed arrays.
+**ieee754-buffer** is a module to encode and decode IEEE 754 floating point numbers.
 
 - **MIT licensed**
-- **Use it out of the box in the browser**
-- **Use it out of the box in Node.js**
-- **Use it out of the box with [TypeScript](https://www.typescriptlang.org/)**
-- **UMD compatible with IE6+ and browsers that support ES3/ES5/ES6+**
-- **Tested with 16-bit, 32-bit and 64-bit floats**
-- **Tested against Python's struct module**
+- **Can be used where typed arrays can't**
+- **Parse 16-bit, 32-bit and 64-bit floats**
 
@@ -29,5 +25,5 @@ ## Install
 ### Browser
-Use **ieee754-buffer.umd.js**:
+Use the **ieee754-buffer.js** file in the **/dist** folder:
 ```html
-<script src="ieee754-buffer.umd.js"></script>
+<script src="ieee754-buffer.js"></script>
 <script>
@@ -51,12 +47,5 @@ let packer = new IEEE754Buffer.IEEE754Buffer(8, 23);
 
-#### Browser compatibility
-**ieee754-buffer.umd.js** is compatible with IE6+. Should work in all modern browsers that support ES3/ES5/ES6+.
-
-Cross-browser tests powered by  
-<a href="https://www.browserstack.com"><img src="https://rochars.github.io/endianness/docs/[e-mail]" width="150px"/></a>
-
 ### Node
-**Import IEEE754Buffer from ieee754-buffer**:
 ```javascript
-import {IEEE754Buffer} from 'ieee754-buffer';
+const IEEE754Buffer = require('ieee754-buffer').IEEE754Buffer;
 let packer = new IEEE754Buffer(8, 23);
@@ -68,7 +57,2 @@ let buffer = Uint8Array(4);
 
-Or **require**:
-```javascript
-const IEEE754Buffer = require('ieee754-buffer').IEEE754Buffer;
-```
-
 ## About
@@ -127,3 +111,3 @@ - **Overflows** are rounded towards **Infinity** and **-Infinity**.
 ## LICENSE
-Copyright (c) 2018 Rafael da Silva Rocha.  
+Copyright (c) 2018-2019 Rafael da Silva Rocha.  
 Copyright (c) 2013 DeNA Co., Ltd.  
@@ -130,0 +114,0 @@ Copyright (c) 2010, Linden Research, Inc

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

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

Fixed alerts

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

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

Dev dependency count

11

decreased by-21.43%

Number of low quality alerts

1

decreased by-50%

Worsened metrics

Total package byte prevSize

19519

decreased by-27.31%

Lines of code

253

decreased by-44.88%

Number of lines in readme file

129

decreased by-11.03%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes