pixi-viewport - npm Package Compare versions

Comparing version 4.24.0 to 4.30.0

package.json

 {
     "name": "pixi-viewport",
-    "version": "4.24.0",
+    "version": "4.30.0",
     "description": "A highly configurable viewport/2D camera designed to work with pixi.js. Features include dragging, pinch-to-zoom, mouse wheel zooming, decelerated dragging, follow target, snap to point, snap to zoom, clamping, bouncing on edges, and move on mouse edges.",
-    "main": "dist/viewport.js",
-    "module": "src/viewport.js",
-    "types": "@types/index.d.ts",
+    "main": "dist/cjs/viewport.js",
+    "module": "dist/esm/viewport.es.js",
+    "bundle": "dist/viewport.min.js",
+    "types": "index.d.ts",
     "directories": {
@@ -13,18 +14,21 @@ "doc": "docs"
         "dist",
-        "@types"
+        "index.d.ts",
+        "src"
     ],
     "scripts": {
-        "dev": "rollup -c rollup.dev.js --watch",
-        "test": "mocha",
+        "start": "serve docs/",
+        "dev": "rollup -w -c docs/original/rollup.dev.js",
+        "test": "floss --path test",
         "coverage": "nyc mocha",
-        "build": "rollup -c",
-        "docs": "jsdoc -c .jsdoc.json",
+        "build": "rollup -c && yarn build:types",
+        "build:types": "rimraf ./compile && tsc -p ./tsconfig.json --outDir compile && api-extractor run",
+        "docs": "rimraf ./js && tsc -p ./tsconfig-docs.json --outDir js && jsdoc -c .jsdoc.json",
         "upgrade": "yarn upgrade-interactive --latest",
-        "prepublishOnly": "yarn run build && yarn run builds && yarn run docs",
+        "prepublishOnly": "yarn build && yarn builds && yarn build:types && yarn docs",
         "builds-rollup": "rollup -c docs/builds/rollup/rollup.config.js",
         "builds-browserify": "browserify docs/builds/browserify/code.js -o docs/builds/browserify/index.js",
-        "builds-standalone": "cp dist/viewport.js* docs/",
+        "builds-standalone": "cp dist/viewport.* docs/",
         "builds-typescript": "rollup -c docs/builds/ts/rollup.config.js",
-        "builds-demo": "rollup -c docs/rollup.config.js",
-        "builds": "yarn builds-rollup && yarn builds-browserify && yarn builds-standalone && yarn builds-typescript && yarn builds-demo"
+        "builds-original": "rollup -c docs/original/rollup.config.js",
+        "builds": "yarn builds-rollup && yarn builds-browserify && yarn builds-standalone && yarn builds-typescript && yarn builds-original"
     },
@@ -53,3 +57,6 @@ "repository": {
     "peerDependencies": {
-        "pixi.js": ">=4.6.0"
+        "@pixi/display": "^6.0.0",
+        "@pixi/interaction": "^6.0.0",
+        "@pixi/math": "^6.0.0",
+        "@pixi/ticker": "^6.0.0"
     },
@@ -60,33 +67,43 @@ "dependencies": {
     "devDependencies": {
-        "@babel/core": "^7.13.8",
-        "@babel/preset-env": "^7.13.9",
+        "@babel/core": "^7.13.16",
+        "@babel/preset-env": "^7.13.15",
         "@joseph184/rollup-plugin-node-builtins": "^2.1.4",
+        "@microsoft/api-extractor": "^7.14.0",
+        "@pixi-build-tools/rollup-configurator": "^1.0.14",
+        "@pixi/display": "^6.0.0",
+        "@pixi/eslint-config": "^2.0.1",
+        "@pixi/interaction": "^6.0.0",
+        "@pixi/math": "^6.0.0",
+        "@pixi/ticker": "^6.0.0",
         "@rollup/plugin-babel": "^5.3.0",
-        "@rollup/plugin-commonjs": "^17.1.0",
-        "@rollup/plugin-node-resolve": "^11.2.0",
-        "@rollup/plugin-typescript": "^8.2.0",
+        "@rollup/plugin-commonjs": "^18.0.0",
+        "@rollup/plugin-node-resolve": "^11.2.1",
+        "@rollup/plugin-sucrase": "^3.1.0",
+        "@typescript-eslint/eslint-plugin": "^4.22.0",
+        "@typescript-eslint/parser": "^4.22.0",
         "browserify": "^17.0.0",
-        "chai": "^4.3.1",
+        "chai": "^4.3.4",
         "clicked": "^4.0.3",
         "dom-ease": "^0.9.3",
+        "electron": "^12.0.5",
+        "eslint": "^7.24.0",
+        "floss": "^5.0.0",
         "fork-me-github": "^1.2.0",
         "jsdoc": "^3.6.3",
-        "mocha": "^8.3.0",
         "pixi-ease": "^3.0.7",
         "pixi.js": "^6.0.0",
         "raf": "^3.4.1",
-        "rollup": "^2.40.0",
+        "rollup": "^2.45.2",
         "rollup-plugin-node-globals": "^1.4.0",
         "rollup-plugin-peer-deps-external": "^2.2.4",
         "rollup-plugin-serve": "^1.1.0",
-        "rollup-plugin-terser": "^7.0.2",
         "serve": "^11.2.0",
         "settingspanel": "^2.0.0",
-        "tslib": "^2.1.0",
-        "typescript": "^4.2.2",
+        "tslib": "^2.2.0",
+        "typescript": "^4.2.4",
         "yy-counter": "^2.1.0",
-        "yy-fps": "^1.1.0",
+        "yy-fps": "^2.0.0",
         "yy-jsdoc-template": "^1.3.0",
-        "yy-random": "^1.10.1"
+        "yy-random": "^1.10.2"
     }
-}
+}

README.md

@@ -1,2 +0,2 @@
-# pixi-viewport
+# pixi-viewport - PixiJS Viewport Kit
 A highly configurable viewport/2D camera designed to work with pixi.js.
@@ -8,26 +8,12 @@
 
-## Migration from pixi-viewport v3 to v4
-Viewport needs to be imported or required as follows:
-```js
-import { Viewport } from 'pixi-viewport'
+## v4.30.0+
+This project was migrated to Typescript (thanks [@sukantpal](https://github.com/SukantPal)!). All functionality should be the same. The live Example has been updated.
 
-// or
+## Live Examples
+* New: [https://davidfig.github.io/pixi-viewport/](https://davidfig.github.io/pixi-viewport/) (using [flems.io](https://flems.io))
+* Original:  [https://davidfig.github.io/pixi-viewport/original/](https://davidfig.github.io/pixi-viewport/original)
 
-const Viewport = require('pixi-viewport').Viewport
-```
-Plugins have been moved to their own object:
-```js
-// viewport.pausePlugin('drag')
-viewport.plugins.pause('drag')
+## API Documentation
+[https://davidfig.github.io/pixi-viewport/jsdoc/](https://davidfig.github.io/pixi-viewport/jsdoc/)
 
-// viewport.resumePlugin('drag')
-viewport.plugins.resume('drag')
-
-// viewport.removePlugin('drag')
-viewport.plugins.remove('drag')
-
-// viewport.userPlugin('name', plugin, index)
-viewport.plugins.add('name', plugin, index)
-```
-
 ## Simple Example
@@ -38,2 +24,6 @@ ```js
 
+// or with require
+// const PIXI = require('pixi.js')
+// const Viewport = require('pixi-viewport').Viewport
+
 const app = new PIXI.Application()
@@ -69,16 +59,2 @@ document.body.appendChild(app.view)
 
-Using commonjs:
-```js
-const PIXI = require('pixi.js')
-const Viewport = require('pixi-viewport').Viewport
-
-// same code as above...
-```
-
-## Live Example
-[https://davidfig.github.io/pixi-viewport/](https://davidfig.github.io/pixi-viewport/)
-
-## API Documentation
-[https://davidfig.github.io/pixi-viewport/jsdoc/](https://davidfig.github.io/pixi-viewport/jsdoc/)
-
 ## Installation
@@ -95,6 +71,6 @@
 <script src="/directory-to-file/pixi.js"></script>
-<script src="/directory-to-file/pixi-viewport.js"></script>
-<!-- or <script type="module" src="/directory-to-file/pixi-viewport.es.js"></script> -->
+<script src="/directory-to-file/viewport.min.js"></script>
+<!-- or <script type="module" src="/directory-to-file/esm/viewport.es.js"></script> -->
 <script>
-    const Viewport = new Viewport.Viewport(options)
+    const Viewport = new pixi_viewport.Viewport(options)
 </script>
@@ -104,4 +80,38 @@ ```
 ## Build Examples
-I've included a bunch of build examples in the docs/builds directory, including: [browserify](https://github.com/davidfig/pixi-viewport/tree/master/docs/builds/browserify), [rollup](https://github.com/davidfig/pixi-viewport/tree/master/docs/builds/rollup), [standalone (e.g., cdn)](https://github.com/davidfig/pixi-viewport/tree/master/docs/builds/standalone), [standalone (pixi.js v4)](https://github.com/davidfig/pixi-viewport/tree/master/docs/builds/standalone-v4), and [typescript](https://github.com/davidfig/pixi-viewport/tree/master/docs/builds/ts). You can see the live demos at [https://davidfig.github.io/pixi-viewport/builds/](https://davidfig.github.io/pixi-viewport/builds/).
+I've included the following build examples in the docs/ directory:
 
+* [flems-io interactive demo](https://davidfig.github.io/pixi-viewport/)
+* [original demo built with rollup](https://github.com/davidfig/pixi-viewport/tree/master/docs/original)
+* [browserify](https://github.com/davidfig/pixi-viewport/tree/master/docs/builds/browserify)
+* [rollup](https://github.com/davidfig/pixi-viewport/tree/master/docs/builds/rollup)
+* [standalone (e.g., cdn)](https://github.com/davidfig/pixi-viewport/tree/master/docs/builds/standalone)
+* [standalone (pixi.js v4)](https://github.com/davidfig/pixi-viewport/tree/master/docs/builds/standalone-v4)
+* [typescript](https://github.com/davidfig/pixi-viewport/tree/master/docs/builds/ts).
+
+You can see the live demos at [https://davidfig.github.io/pixi-viewport/builds/](https://davidfig.github.io/pixi-viewport/builds/).
+
+## Migration from pixi-viewport v3 to v4
+Viewport needs to be imported or required as follows:
+```js
+import { Viewport } from 'pixi-viewport'
+
+// or
+
+const Viewport = require('pixi-viewport').Viewport
+```
+Plugins have been moved to their own object:
+```js
+// viewport.pausePlugin('drag')
+viewport.plugins.pause('drag')
+
+// viewport.resumePlugin('drag')
+viewport.plugins.resume('drag')
+
+// viewport.removePlugin('drag')
+viewport.plugins.remove('drag')
+
+// viewport.userPlugin('name', plugin, index)
+viewport.plugins.add('name', plugin, index)
+```
+
 ## Tests
@@ -131,2 +141,2 @@
 MIT License
-(c) 2020 [YOPEY YOPEY LLC](https://yopeyopey.com/) by David Figatner ([e-mail])
+(c) 2021 [YOPEY YOPEY LLC](https://yopeyopey.com/) by David Figatner ([e-mail])

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

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Fixed alerts

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1598545

increased by138.8%

Number of package files

33

increased by312.5%

Lines of code

20824

increased by394.98%

Number of lines in readme file

136

increased by7.94%

Worsened metrics

Dependency count

5

increased by150%

Dev dependency count

40

increased by33.33%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes