swup - npm Package Compare versions

Comparing version 2.0.19 to 3.0.0-rc.1

package.json

 {
   "name": "swup",
-  "version": "2.0.19",
-  "description": "Complete, flexible, extensible and easy to use page transition library for your web.",
-  "main": "lib/index.js",
+  "amdName": "Swup",
+  "version": "3.0.0-rc.1",
+  "description": "Complete, flexible, extensible, and easy-to-use page transition library for your server-side rendered website.",
+  "type": "module",
+  "source": "src/index.ts",
+  "main": "dist/index.cjs",
+  "module": "dist/index.module.js",
+  "unpkg": "dist/index.umd.js",
+  "types": "dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.modern.js"
+    },
+    "./*": {
+      "types": "./dist/types/*.d.ts",
+      "require": "./dist/*.cjs",
+      "default": "./dist/*.modern.js"
+    }
+  },
+  "files": [
+    "src",
+    "dist"
+  ],
   "scripts": {
-    "cy:open": "cypress open",
-    "compile": "babel --presets es2015,stage-0 -d lib/ src/",
-    "build": "webpack-cli",
-    "lint": "prettier src/**/*.{js,mjs} --write",
-    "prepublish": "npm run compile && npm run build",
+    "build": "npm run build:module && npm run build:bundle",
+    "build:module": "microbundle src/*.ts -f modern,esm,cjs",
+    "build:bundle": "microbundle src/index.ts -f umd --external none",
+    "dev": "microbundle src/*.ts -w",
+    "lint": "prettier 'src/**/*.ts' --write",
+    "prepublish": "npm run build",
     "postinstall": "opencollective-postinstall || true",
-    "ci": "npm run build && npm run test:instrument && start-server-and-test test:server http://localhost:8274 test:run:record",
-    "test": "npm run build && npm run test:instrument && start-server-and-test test:server http://localhost:8274 test:run",
-    "test:headed": "npm run build && npm run test:instrument && start-server-and-test test:server http://localhost:8274 cy:open",
+    "ci": "start-server-and-test test:start 8274 cy:run:record",
+    "test": "start-server-and-test test:start 8274 cy:run",
+    "test:dev": "start-server-and-test test:start 8274 cy:open",
     "test:instrument": "nyc instrument --compact=false dist test/site/swup",
     "test:server": "http-server --port 8274 test/site",
-    "test:run": "cypress run",
-    "test:run:record": "cypress run --record"
+    "test:start": "npm run test:instrument && npm run test:server",
+    "cy:run": "cypress run",
+    "cy:run:record": "cypress run --record",
+    "cy:open": "cypress open"
   },
@@ -40,16 +65,9 @@ "author": "Georgy Marchuk",
     "@swup/prettier-config": "^1.0.0",
-    "@swup/webpack-config": "^1.0.0",
-    "babel-cli": "^6.26.0",
-    "babel-loader": "^7.1.4",
-    "babel-preset-es2015": "^6.24.1",
-    "babel-preset-stage-0": "^6.24.1",
     "cypress": "^10.0.2",
     "http-server": "^14.1.1",
     "istanbul-lib-coverage": "^3.2.0",
+    "microbundle": "^0.15.0",
     "nyc": "^15.1.0",
-    "prettier": "1.17.0",
-    "start-server-and-test": "^1.14.0",
-    "uglifyjs-webpack-plugin": "^1.2.5",
-    "webpack": "^4.8.3",
-    "webpack-cli": "^3.3.2"
+    "prettier": "1.19.0",
+    "start-server-and-test": "^1.14.0"
   },
@@ -56,0 +74,0 @@ "collective": {

readme.md

@@ -1,44 +0,60 @@
-<h3 align="center"><a href="https://github.com/swup/swup/discussions/424">We're looking for maintainers!</a></h3>
+<br>
 
----
-
-<p align="center"><img width="420" alt="swup" src="https://swup.js.org/assets/images/swup-logo.svg"></p>
 <p align="center">
-Complete, flexible, extensible and easy to use page transition library for your static web.
+  <img width="280" alt="swup" src="https://swup.js.org/assets/images/swup-logo.svg">
 </p>
+
 <p align="center">
-    <a href="https://www.npmjs.com/package/swup"><img src="https://img.shields.io/npm/v/swup.svg" alt="npm version"></a>
-    <img src="https://img.shields.io/bundlephobia/minzip/swup.svg" alt="Gzip Size">
-    <a href="https://github.com/gmrchk/swup/blob/master/LICENSE"><img src="https://img.shields.io/github/license/gmrchk/swup.svg" alt="License"></a>
-    <a href="https://www.npmjs.com/package/swup"><img src="https://img.shields.io/npm/dt/swup.svg" alt="npm downloads"></a>
-    <a href="https://circleci.com/gh/swup/swup"><img src="https://circleci.com/gh/swup/swup.svg?style=svg" alt="CircleCI"></a>
+  <a href="https://www.npmjs.com/package/swup"><img src="https://img.shields.io/npm/v/swup.svg" alt="npm version"></a>
+  <a href="https://bundlephobia.com/package/swup"><img src="https://img.shields.io/bundlephobia/minzip/swup.svg" alt="Bundle size"></a>
+  <a href="https://github.com/gmrchk/swup/blob/master/LICENSE"><img src="https://img.shields.io/github/license/gmrchk/swup.svg" alt="License"></a>
+  <a href="https://www.npmjs.com/package/swup"><img src="https://img.shields.io/npm/dt/swup.svg" alt="npm downloads"></a>
+  <a href="https://circleci.com/gh/swup/swup"><img src="https://circleci.com/gh/swup/swup.svg?style=shield" alt="Build status"></a>
 </p>
 
-[Here](https://medium.com/@gmarcuk/introducing-swup-v2-814e40316dee)'s what's new in v2. Check [changelog](https://swup.js.org/other/changelog) for recent changes, see all [swup repositories](https://github.com/swup/) to discover more, or checkout the [discussions](https://github.com/swup/swup/discussions).
+<br>
 
-- [Discussions](https://github.com/swup/swup/discussions)
-- [Getting Started](https://swup.js.org/getting-started)
-  - [Example](https://swup.js.org/getting-started/example)
-  - [Demo](https://swup.js.org/getting-started/demo)
-  - [Reloading JavaScript](https://swup.js.org/getting-started/reloading-javascript)
-  - [Video Tutorials](https://swup.js.org/getting-started/videos)
-- [Options](https://swup.js.org/options)
-- [Events](https://swup.js.org/events)
-- Extensions
-    - [Plugins](https://swup.js.org/plugins)
-    - [Themes](https://swup.js.org/themes)
-    - [3rd Party Integrations](https://swup.js.org/third-party-integrations)
-- [JavaScript API](https://swup.js.org/api)
-- [Swup CLI](https://swup.js.org/cli)
-- [CI/CD Integration](https://swup.js.org/ci-cd)
-- Other
-    - [Changelog](https://swup.js.org//other/changelog)
-    - [Contributions](https://swup.js.org/other/contributions)
-    - [Repositories](https://github.com/swup)
-    - [Sites using swup](https://github.com/swup/swup/discussions/333)
+# Swup
 
-If you're having trouble implementing swup, checkout [Common Issues](https://swup.js.org/other/common-issues), [Closed Issues](https://github.com/gmrchk/swup/issues?q=is%3Aissue+is%3Aclosed) or open a [new one](https://github.com/gmrchk/swup/issues/new).
+Complete, flexible, extensible, and easy-to-use page transition library for your server-side rendered website.
 
-[Become a backer or sponsor on Open Collective](https://opencollective.com/swup) or support swup through [GitHub sponsors](https://github.com/sponsors/gmrchk). 
+[Features](#features) •
+[Documentation](https://swup.js.org/getting-started) •
+[Plugins](https://swup.js.org/plugins) •
+[Themes](https://swup.js.org/themes) •
+[Discussions](https://github.com/swup/swup/discussions)
 
+## Overview
+
+Swup is a library that helps you add page transitions to server-side rendered websites. It handles
+the complete lifecycle of a page visit by intercepting link clicks, loading the new page in the
+background, replacing the content and transitioning between the old and the new page.
+
+Its goal is to make adding transitions to a site as simple as possible, while providing lots of
+other quality-of-life improvements.
+
+## Features
+
+- ✨ Auto-detects [CSS transitions](https://swup.js.org/getting-started/how-it-works) for perfect timing
+- 🔗 Updates URLs and preserves native browser history behavior
+- 📦 Uses a [cache](https://swup.js.org/api/cache) to speed up subsequent page loads
+- 💡 Offers [events](https://swup.js.org/events) for hooking into the lifecycle
+- 🔌 Has a powerful [plugin system](https://swup.js.org/plugins) and many official and third-party plugins
+- 🎨 Provides ready-to-go [themes](https://swup.js.org/themes) to get started quickly
+
+## Examples
+
 <img src="https://user-images.githubusercontent.com/9338324/49190360-50125480-f372-11e8-89e9-d2fb091a2240.gif" width="100%">
+
+Take a look at [Sites using swup](https://github.com/swup/swup/discussions/333) for more examples.
+
+## Having trouble?
+
+If you're having trouble implementing swup, check out the [Common Issues](https://swup.js.org/other/common-issues) section of the docs, look at [closed issues](https://github.com/gmrchk/swup/issues?q=is%3Aissue+is%3Aclosed) or create a [new discussion](https://github.com/swup/swup/discussions/new).
+
+## Want to Contribute?
+
+<a href="https://github.com/swup/swup/discussions/424">We're looking for maintainers!</a>   👀
+
+Become a sponsor on [Open Collective](https://opencollective.com/swup) or support development through
+[GitHub sponsors](https://github.com/sponsors/gmrchk).

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

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

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

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

433559

increased by303.6%

Dev dependency count

9

decreased by-43.75%

Number of package files

124

increased by287.5%

Number of lines in readme file

61

increased by35.56%

Number of medium supply chain risk alerts

1

decreased by-50%

Is type module

Yes

Worsened metrics

Lines of code

2090

decreased by-2.47%

Number of low quality alerts

4

increased by300%

No dependency changes