gifken - npm Package Compare versions

Comparing version 0.5.3 to 1.0.0

CHANGELOG.md

 # Change Log
 
+## [1.0.0] - 2019-04-02
+
+## Changed
+
+- change file path
+- target ES2015
+
 ## [0.5.3] - 2019-03-24
@@ -25,4 +32,5 @@
 
+[1.0.0]: https://github.com/aaharu/gifken/compare/v0.5.3...v1.0.0
 [0.5.3]: https://github.com/aaharu/gifken/compare/v0.5.2...v0.5.3
 [0.5.2]: https://github.com/aaharu/gifken/compare/0.5.1...v0.5.2
 [0.5.1]: https://github.com/aaharu/gifken/compare/0.5.0...0.5.1

package.json

 {
   "name": "gifken",
-  "version": "0.5.3",
+  "version": "1.0.0",
   "description": "TypeScript / JavaScript GIF parser and maker",
-  "main": "build/src/gifken.js",
-  "homepage": "http://aaharu.github.io/gifken/",
+  "main": "lib/gifken.js",
+  "types": "lib/gifken.d.ts",
+  "homepage": "https://aaharu.github.io/gifken/",
   "scripts": {
-    "build": "tsc && browserify build/src/gifken-client.js --outfile build/gifken-client.js",
+    "build": "tsc && browserify lib/gifken.js -t [ babelify --presets [ @babel/preset-env ] ] --outfile gifken.js --require ./lib/gifken.js:gifken",
     "test": "rimraf coverage && jest",
-    "clean": "rimraf build coverage docs",
-    "doc": "typedoc --target ES2016 --module commonjs --out docs --readme README.md src && node d.js"
+    "clean": "rimraf lib coverage docs gifken.js",
+    "doc": "typedoc --target es2015 --module commonjs --out docs --readme README.md src && node d.js"
   },
   "repository": {
     "type": "git",
-    "url": "git://github.com/aaharu/gifken.git"
+    "url": "https://github.com/aaharu/gifken.git"
   },
@@ -26,20 +27,23 @@ "author": "aaharu",
   "devDependencies": {
+    "@babel/preset-env": "^7.4.2",
     "@types/jest": "^24.0.9",
     "@types/node": "^10.3.3",
-    "@typescript-eslint/eslint-plugin": "^1.4.2",
+    "@typescript-eslint/eslint-plugin": "^1.5.0",
+    "babelify": "^10.0.0",
     "browserify": "^16.2.3",
     "codecov": "^3.2.0",
-    "eslint": "^5.14.1",
+    "eslint": "^5.16.0",
     "eslint-config-prettier": "^4.1.0",
     "eslint-plugin-prettier": "^3.0.1",
-    "jest": "^24.1.0",
+    "jest": "^24.5.0",
     "jsdoc": "^3.5.5",
     "prettier": "^1.16.4",
     "rimraf": "^2.6.3",
-    "ts-jest": "^24.0.0",
+    "ts-jest": "^24.0.1",
     "typedoc": "^0.14.2",
-    "typescript": "^3.3.3333"
+    "typescript": "^3.4.1"
   },
   "files": [
-    "build/src"
+    "lib",
+    "gifken.js"
   ],
@@ -51,2 +55,11 @@ "keywords": [
   "jest": {
+    "globals": {
+      "ts-jest": {
+        "tsConfig": {
+          "typeRoots": [
+            "node_modules/@types"
+          ]
+        }
+      }
+    },
     "moduleFileExtensions": [
@@ -67,3 +80,32 @@ "ts",
     ]
-  }
+  },
+  "eslintConfig": {
+    "extends": [
+      "eslint:recommended",
+      "plugin:prettier/recommended"
+    ],
+    "plugins": [
+      "@typescript-eslint"
+    ],
+    "env": {
+      "node": true,
+      "mocha": true,
+      "browser": true,
+      "es6": true
+    },
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+      "sourceType": "module",
+      "project": "./tsconfig.json"
+    },
+    "rules": {
+      "no-unused-vars": "off",
+      "no-constant-condition": "off",
+      "@typescript-eslint/adjacent-overload-signatures": "error"
+    }
+  },
+  "eslintIgnore": [
+    "lib",
+    "gifken.js"
+  ]
 }

README.md

@@ -11,5 +11,7 @@ # gifken
 <div id="content"></div>
-<script src="gifken-client.js"></script>
-<script type="text/javascript">
-window.onload = function () {
+<script src="https://unpkg.com/gifken/gifken.js"></script>
+<script type="application/javascript">
+const gifken = require("gifken");
+
+window.onload = () => {
     var newgif = new gifken.Gif();
@@ -78,32 +80,37 @@ newgif.width = 100;
 ```javascript
-var fs = require("fs"),
-    path = require("path"),
-    gifken = require("gifken");
+const gifken = require("gifken"),
+  fs = require("fs"),
+  path = require("path");
 
-var newgif = new gifken.Gif();
+const newgif = new gifken.Gif();
 newgif.width = 100;
 newgif.height = 100;
 newgif.globalColorTable = gifken.GifColor.createColorTable([
-    new gifken.GifColor(0, 0, 0),
-    new gifken.GifColor(255, 0, 0),
-    new gifken.GifColor(0, 255, 0),
-    new gifken.GifColor(0, 0, 255),
-    new gifken.GifColor(100, 100, 255),
-    new gifken.GifColor(100, 255, 100),
-    new gifken.GifColor(255, 100, 100),
-    new gifken.GifColor(0, 255, 255),
-    new gifken.GifColor(255, 0, 255),
-    new gifken.GifColor(255, 255, 0),
-    new gifken.GifColor(255, 255, 255)
+  new gifken.GifColor(0, 0, 0),
+  new gifken.GifColor(255, 0, 0),
+  new gifken.GifColor(0, 255, 0),
+  new gifken.GifColor(0, 0, 255),
+  new gifken.GifColor(100, 100, 255),
+  new gifken.GifColor(100, 255, 100),
+  new gifken.GifColor(255, 100, 100),
+  new gifken.GifColor(0, 255, 255),
+  new gifken.GifColor(255, 0, 255),
+  new gifken.GifColor(255, 255, 0),
+  new gifken.GifColor(255, 255, 255)
 ]);
 newgif.frames = [gifken.GifFrame.init(newgif.width, newgif.height)];
-for (var i = 0; i < newgif.frames[0].pixelData.length; ++i) {
-    newgif.frames[0].pixelData[i] = i % 11;
+for (let i = 0; i < newgif.frames[0].pixelData.length; ++i) {
+  newgif.frames[0].pixelData[i] = i % 11;
 }
-var buffer = newgif.writeToArray();
+const buffer = newgif.writeToArray();
 
-fs.writeFile(path.resolve(__dirname, "sample.gif"), Buffer.from(buffer), function (err) {
+fs.writeFile(
+  path.resolve(__dirname, "sample.gif"),
+  Buffer.from(buffer),
+  err => {
     if (err) throw err;
+    // eslint-disable-next-line no-console
     console.log("It's saved!");
-});
+  }
+);
 ```
@@ -110,0 +117,0 @@

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

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

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

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

78457

increased by66.4%

Lines of code

2071

increased by74.77%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

150

increased by4.9%

Worsened metrics

Dev dependency count

17

increased by13.33%

Number of package files

21

decreased by-4.55%

Number of low supply chain risk alerts

2

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes