Merge pull request #20 from swup/next

Update for swup 4

CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+<!-- ## [Unreleased] -->
+
+## [4.0.0] - 2023-07-26
+
+- Update for swup 4 compatibility
+
+## [3.0.0] - 2023-03-10
+
+- Switch to microbundle
+- Export native ESM module
+
+## [2.0.0] - 2022-08-20
+
+- Make global instance on window optional
+
+## [1.0.0] - 2019-05-02
+
+- Initial release
+
+[Unreleased]: https://github.com/swup/debug-plugin/compare/4.0.0...HEAD
+
+[4.0.0]: https://github.com/swup/debug-plugin/releases/tag/4.0.0
+[3.0.0]: https://github.com/swup/debug-plugin/releases/tag/3.0.0
+[2.0.0]: https://github.com/swup/debug-plugin/releases/tag/2.0.0
+[1.0.0]: https://github.com/swup/debug-plugin/releases/tag/1.0.0

README.md

@@ -0,0 +1,48 @@
+# Swup Debug Plugin
+
+A [swup](https://swup.js.org) plugin for debugging and helping in development.
+
+- Output all triggered hooks to the console as they happen
+- Rewrites swup's `log` method so that any output provided by plugins is visible
+- Detect common mistakes and suggest solutions in the console
+
+## Installation
+
+Install the plugin from npm and import it into your bundle.
+
+```bash
+npm install @swup/debug-plugin
+```
+
+```js
+import SwupDebugPlugin from '@swup/debug-plugin';
+```
+
+Or include the minified production file from a CDN:
+
+```html
+<script src="https://unpkg.com/@swup/debug-plugin@4"></script>
+```
+
+## Usage
+
+To run this plugin, include an instance in the swup options.
+
+```javascript
+const swup = new Swup({
+  plugins: [new SwupDebugPlugin()]
+});
+```
+
+## Options
+
+### globalInstance
+
+If `true`, the plugin will store the swup instance on the global window object, making swup
+available at `window.swup`. Defaults to `false`.
+
+```javascript
+{
+  globalInstance: true
+}
+```

package.json

@@ -1,8 +1,8 @@
 {
   "name": "@swup/debug-plugin",
   "amdName": "SwupDebugPlugin",
-  "version": "3.0.0",
-  "description": "Swup Debug plugin.",
+  "version": "4.0.0",
+  "description": "A swup plugin for debugging and helping in development",
   "type": "module",
   "source": "src/index.js",
   "main": "./dist/index.cjs",
@@ -17,7 +17,7 @@
     "dev": "swup-plugin dev",
     "lint": "swup-plugin lint",
     "format": "swup-plugin format",
-    "prepublish": "npm run build"
+    "prepublishOnly": "npm run build"
   },
   "author": {
     "name": "Georgy Marchuk",
@@ -42,10 +42,10 @@
     "url": "https://github.com/swup/debug-plugin.git"
   },
   "dependencies": {
-    "@swup/plugin": "^2.0.0"
+    "@swup/plugin": "^3.0.0"
   },
   "peerDependencies": {
-    "swup": "^3.0.0"
+    "swup": "^4.0.0"
   },
   "browserslist": [
     "extends @swup/browserslist-config"