photoswipe - npm Package Compare versions

Comparing version 4.1.3 to 5.1.8-beta.0

package.json

 {
   "name": "photoswipe",
-  "version": "4.1.3",
+  "version": "5.1.8-beta.0",
+  "main": "dist/photoswipe.esm.js",
+  "style": "dist/photoswipe.css",
+  "files": [
+    "dist",
+    "src",
+    "README.md"
+  ],
   "engines": {
-    "node": ">= 0.8.0"
+    "node": ">= 0.12.0"
   },
   "scripts": {
-    "test": "grunt jshint"
+    "build": "npm run build-and-minify-js && npm run build-css && npm run copy-to-dist",
+    "watch": "concurrently \"npm:watch-js\" \"npm:watch-css\" \"npm:watch-docs\"",
+    "build-and-minify-js": "rollup --config build/rollup.config.js",
+    "watch-js": "rollup --config build/rollup.config.watch.js --watch",
+    "build-css": "copyfiles -f src/*.css dist/ && copyfiles -f src/*.css website/static/photoswipe/",
+    "watch-css": "chokidar \"src/*.css\" --command \"npm run build-css\"",
+    "watch-docs": "cd website/ && npm start",
+    "copy-to-dist": "copyfiles -f website/static/photoswipe/* dist/",
+    "lint": "eslint src/js/**/*.js",
+    "lint-auto-fix": "eslint src/js/**/*.js --fix",
+    "test": "npm run lint"
   },
   "devDependencies": {
-    "grunt": "~1.0.3",
-    "grunt-autoprefixer": "^3.0.3",
-    "grunt-contrib-clean": "~2.0.0",
-    "grunt-contrib-concat": "~1.0.1",
-    "grunt-contrib-copy": "^1.0.0",
-    "grunt-contrib-cssmin": "^3.0.0",
-    "grunt-contrib-jshint": "~2.0.0",
-    "grunt-contrib-uglify": "~4.0.0",
-    "grunt-contrib-watch": "~1.1.0",
-    "grunt-jekyll": "~1.0.0",
-    "grunt-sass": "^3.0.2",
-    "grunt-svgmin": "^5.0.0"
+    "@babel/core": "^7.13.16",
+    "@babel/eslint-parser": "^7.13.14",
+    "chokidar-cli": "^3.0.0",
+    "concurrently": "^6.0.2",
+    "copyfiles": "^2.4.1",
+    "eslint": "^7.25.0",
+    "eslint-config-airbnb-base": "^13.2.0",
+    "eslint-plugin-import": "^2.22.1",
+    "rollup": "^2.46.0",
+    "rollup-plugin-copy": "^3.4.0",
+    "rollup-plugin-terser": "^7.0.2"
   },
@@ -33,3 +49,2 @@ "repository": {
   "homepage": "https://photoswipe.com",
-  "main": "dist/photoswipe.js",
   "keywords": [
@@ -44,4 +59,4 @@ "gallery",
   ],
-  "author": "Dmitry Semenov (http://dimsemenov.com)",
+  "author": "Dmytro Semenov (https://dimsemenov.com)",
   "license": "MIT"
 }

README.md

@@ -1,73 +0,28 @@
-# PhotoSwipe Repository 
+v5 is now available for testing, please visit [documentation and examples](https://photoswipe.com/v5/docs/getting-started/) and report any issues that you find.
 
-[![Build Status](https://travis-ci.org/dimsemenov/PhotoSwipe.svg)](https://travis-ci.org/dimsemenov/PhotoSwipe) 
-[![devDependency Status](https://david-dm.org/dimsemenov/PhotoSwipe/dev-status.svg)](https://david-dm.org/dimsemenov/PhotoSwipe#info=devDependencies)
-[![Flattr](http://api.flattr.com/button/flattr-badge-large.png)](http://flattr.com/thing/3698358/dimsemenovPhotoSwipe-on-GitHub)
+[![Sponsor via OpenCollective](https://img.shields.io/opencollective/all/photoswipe?label=Sponsor%20via%20OpenCollective)](https://opencollective.com/photoswipe)
+[![Follow on Twitter](https://img.shields.io/twitter/follow/photoswipe?style=social)](https://twitter.com/intent/user?screen_name=photoswipe)
 
-JavaScript image gallery for mobile and desktop. 
 
-- [Documentation and getting started guide](http://photoswipe.com/documentation/getting-started.html).
-- [Demo and script home page](http://photoswipe.com).
-- [NPM](https://www.npmjs.com/package/photoswipe) `npm install photoswipe`.
-- Bower `bower install photoswipe`.
+### Repo structure
 
-## Location of files
+- `dist/` - main JS and CSS
+- `src/` - source JS and CSS.
+  - `src/js/photoswipe.js` - entry for PhotoSwipe Core.
+  - `src/js/lightbox/lightbox.js` - entry for PhotoSwipe Lightbox.
+- `docs/` - documentation markdown files.
+- `website/` - website with documentation, demos and manual tests.
+- `build/` - rollup build config.
 
-- Compiled PhotoSwipe JS and CSS files, SVG and PNG sprites are in the [dist/](https://github.com/dimsemenov/PhotoSwipe/tree/master/dist) folder.
-- Source files (.JS and .SCSS) are in the [src/](https://github.com/dimsemenov/PhotoSwipe/tree/master/src) folder.  Note that PhotoSwipe uses Autoprefixer when compiling SASS files.
-- Demo website is in the [website/](https://github.com/dimsemenov/PhotoSwipe/tree/master/website) folder.
-- Documentation markdown files are in [website/documentation/](https://github.com/dimsemenov/PhotoSwipe/tree/master/website/documentation).
+### Build
 
-## Plugins / extensions / addons
+- `npm run build` - builds and minifies JS and CSS to `dist/` directory. 
+- `npm run lint` - lints JS files in `src/` with eslint (`npm run lint-auto-fix` to fix auto-fixable issues).
 
-- [Ruby gem](https://rubygems.org/gems/photoswipe-rails).
-- Ember.js addons: [ember-photoswipe](https://github.com/kaermorchen/ember-photoswipe), [ember-cli-photoswipe](https://github.com/poetic/ember-cli-photoswipe).
-- [Eager app](https://eager.io/app/DvuKIoU8iTOt).
-- [Koken CMS plugin](https://github.com/DanielMuller/koken-plugin-photoswipe).
-- [Orchard CMS module](https://gallery.orchardproject.net/List/Modules/Orchard.Module.Cascade.PhotoSwipe).
-- [Yellow CMS plugin](https://github.com/datenstrom/yellow-plugins/tree/master/gallery).
-- [Kirby CMS plugin](https://github.com/SiteMarina/guggenheim).
-- [Drupal CMF module](https://www.drupal.org/project/photoswipe).
-- [ProcessWire CMS module](https://github.com/blynx/MarkupProcesswirePhotoswipe).
-- [SPIP CMS module](https://plugins.spip.net/photoswipe.html).
-- [Fork CMS MediaLibrary widget](https://github.com/forkcms/forkcms).
+### Build docs and demos
 
-Coded something useful? <a href='mailto:[e-mail]?subject="PhotoSwipe Plugin"'>Email me</a> and I’ll post a link to it here.
+- `npm install` in root
+- `npm install` in `/website/` directory to get docusaurus (if you also need to build docs)
+- `npm run watch` - watches changes for files in `src/` and `docs/`, starts Docusaurus - demo website with many examples where you perform manual tests, at 3000 port (visit [http://localhost:3000](http://localhost:3000)).
 
-## Build 
 
-To compile PhotoSwipe by yourself, make sure that you have [Node.js](http://nodejs.org/), [Grunt.js](https://github.com/cowboy/grunt), [Ruby](http://www.ruby-lang.org/) and [Jekyll](https://github.com/mojombo/jekyll/) installed, then:
-
-1) Clone the repository
-
-	git clone https://github.com/dimsemenov/PhotoSwipe.git
-
-2) Go inside the PhotoSwipe folder that you fetched and install Node dependencies
-
-	cd PhotoSwipe && npm install
-
-3) Run `grunt` to generate the JS and CSS files in the `dist` folder and the site in the `_site/` folder
-
-	grunt
-
-Optionally:
-
-- Run `grunt watch` to automatically rebuild files (JS, CSS, demo website and documentation) when you change files in `src/` or in `website/`.
-- Run `grunt nosite` to build just JS and CSS files (output is folder `dist/`).
-- Run `grunt pswpbuild` to build just JS files. Param `--pswp-exclude` allows to exclude modules, for example `grunt pswpbuild --pswp-exclude=history` will exclude history module.
-
-## Using PhotoSwipe?
-
-If you’ve used PhotoSwipe in some interesting way, or on the site of a popular brand, I’d be very grateful if you <a href='mailto:[e-mail]?subject="Site that uses PhotoSwipe"'>shoot me</a> a link to it.
-
-## License
-
-Script is licensed under MIT license with one exception: Do not create a public WordPress plugin based on it, as I will develop it. If you need to use it for a public WordPress plugin right now, please ask me by email first. Thanks!
-
-Attribution is not required, but much appreciated, especially if you’re making a product for developers.
-
-## About
-
-PhotoSwipe 4.0+ is developed by [Dmitry Semenov](http://twitter.com/dimsemenov). But initially script was created in 2011 by [Code Computerlove](http://www.codecomputerlove.com/), a digital agency in Manchester, they [passed](https://twitter.com/PhotoSwipe/status/444134042787930113) on development in March 2014. You can view [source and documentation](https://github.com/dimsemenov/PhotoSwipe/tree/v3.0.3) of old PhotoSwipe (<4.0) in history of this repo.
-
-

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

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 v1

Quality

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

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

759771

increased by4%

Dev dependency count

11

decreased by-8.33%

Lines of code

10944

increased by21.84%

Worsened metrics

Number of package files

46

decreased by-32.35%

Number of low quality alerts

1

increased byInfinity%

Number of lines in readme file

29

decreased by-60.81%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes