kirbyup 0.9.5 → 0.10.0

package/README.md

@@ -1,30 +1,46 @@
 # kirbyup
 
-> Take a lool into the [pluginkit](./pluginkit) folder for an example setup.
+> Take a look into Kirby's [pluginkit](https://github.com/getkirby/pluginkit/tree/4-panel) repository for an example setup.
 
 The fastest and leanest way to bundle your Kirby Panel plugins. No configuration necessary.
 
-## Install
+## Installation
 
-Install it locally in your project folder:
+If you want to use kirbyup right away, there is no need to install it. Simply call it with `npx`:
+
+```json
+{
+  "scripts": {
+    "dev": "npx -y kirbyup src/index.js --watch",
+    "build": "npx -y kirbyup src/index.js"
+  }
+}
+```
+
+While kirbyup will stay backwards compatible, exact build reproducibility may be of importance to you. If so, I recommend to target a specific package version, rather than using `npx`. Install kirbyup with a package manager of your choice locally to your project:
 
 ```bash
 npm i kirbyup --save-dev
 ```
 
-You can also install it globally.
-
-## Usage
+Example package configuration:
 
 ```json
 {
   "scripts": {
-    "dev": "npx -y kirbyup src/index.js --watch",
-    "build": "npx -y kirbyup src/index.js"
+    "dev": "kirbyup src/index.js --watch",
+    "build": "kirbyup src/index.js"
+  },
+  "devDependencies": {
+    "kirbyup": "^0.9.5"
   }
 }
 ```
 
+Global installation is supported as well, but not recommended.
+
+## Usage
+
 ### Development
 
 Rebuild the Panel plugin on any file changes:
@@ -53,10 +69,6 @@ kirbyup src/index.js
 
 The final panel plugin will be bundled, minified, and written into the current directory as `./index.js`.
 
-## TODO
-
-- [ ] HMR with Vite in lib mode
-
 ## Credits
 
 - [Vite](https://vitejs.dev) by Evan You and all of its contributors.

package/dist/cli.js

@@ -56,7 +56,7 @@ var name, version;
 var init_package = __esm({
   "package.json"() {
     name = "kirbyup";
-    version = "0.9.5";
+    version = "0.10.0";
   }
 });
 
@@ -153,6 +153,7 @@ __export(src_exports, {
 async function runViteBuild(options) {
   let result;
   const currentDir = process.cwd();
+  const isDev = !!options.watch;
   try {
     result = await (0, import_vite.build)({
       plugins: [(0, import_vite_plugin_vue2.createVuePlugin)()],
@@ -163,7 +164,8 @@ async function runViteBuild(options) {
           name: "kirbyupExport",
           fileName: () => "index.js"
         },
-        minify: !options.watch,
+        sourcemap: isDev ? "inline" : false,
+        minify: !isDev,
         outDir: currentDir,
         emptyOutDir: false,
         rollupOptions: {
@@ -204,7 +206,7 @@ async function build(_options) {
       "index.{css,js}"
     ];
     const watchPaths = typeof options.watch === "boolean" ? (0, import_path.dirname)(options.entry) : Array.isArray(options.watch) ? options.watch.filter((path) => typeof path === "string") : options.watch;
-    log(`Watching for changes in ${Array.isArray(watchPaths) ? watchPaths.map((v) => '"' + v + '"').join(" | ") : '"' + watchPaths + '"'}`);
+    log(`Watching for changes in ${Array.isArray(watchPaths) ? watchPaths.map((i) => `"${i}"`).join(" | ") : `"${watchPaths}"`}`);
     const watcher = watch(watchPaths, {
       ignoreInitial: true,
       ignorePermissionErrors: true,

package/dist/index.js

@@ -92,7 +92,7 @@ var import_nanocolors2 = __toModule(require("nanocolors"));
 
 // package.json
 var name = "kirbyup";
-var version = "0.9.5";
+var version = "0.10.0";
 
 // src/log.ts
 var colorMap = new Map([
@@ -117,6 +117,7 @@ function log(message, type = "info") {
 async function runViteBuild(options) {
   let result;
   const currentDir = process.cwd();
+  const isDev = !!options.watch;
   try {
     result = await (0, import_vite.build)({
       plugins: [(0, import_vite_plugin_vue2.createVuePlugin)()],
@@ -127,7 +128,8 @@ async function runViteBuild(options) {
           name: "kirbyupExport",
           fileName: () => "index.js"
         },
-        minify: !options.watch,
+        sourcemap: isDev ? "inline" : false,
+        minify: !isDev,
         outDir: currentDir,
         emptyOutDir: false,
         rollupOptions: {
@@ -177,7 +179,7 @@ async function build(_options) {
       "index.{css,js}"
     ];
     const watchPaths = typeof options.watch === "boolean" ? (0, import_path.dirname)(options.entry) : Array.isArray(options.watch) ? options.watch.filter((path) => typeof path === "string") : options.watch;
-    log(`Watching for changes in ${Array.isArray(watchPaths) ? watchPaths.map((v) => '"' + v + '"').join(" | ") : '"' + watchPaths + '"'}`);
+    log(`Watching for changes in ${Array.isArray(watchPaths) ? watchPaths.map((i) => `"${i}"`).join(" | ") : `"${watchPaths}"`}`);
     const watcher = watch(watchPaths, {
       ignoreInitial: true,
       ignorePermissionErrors: true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kirbyup",
-  "version": "0.9.5",
+  "version": "0.10.0",
   "description": "Zero-config bundler for Kirby Panel plugins",
   "files": [
     "dist"
@@ -35,12 +35,13 @@
     "build": "tsup src/cli.ts src/index.ts --target node14 --clean --dts",
     "test": "jest",
     "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
-    "release": "node scripts/release.js"
+    "release": "node scripts/release.js",
+    "prepare": "husky install"
   },
   "dependencies": {
     "cac": "^6.7.3",
     "chokidar": "^3.5.2",
-    "nanocolors": "^0.1.6",
+    "nanocolors": "^0.2.10",
     "sass": "^1.42.1",
     "vite": "^2.5.10",
     "vite-plugin-vue2": "^1.8.2",
@@ -49,17 +50,18 @@
   "devDependencies": {
     "@types/fs-extra": "^9.0.13",
     "@types/jest": "^27.0.2",
-    "@types/node": "^16.9.6",
+    "@types/node": "^16.10.1",
     "conventional-changelog-cli": "^2.1.1",
-    "enquirer": "^2.3.6",
     "execa": "^5.1.1",
     "fast-glob": "^3.2.7",
     "fs-extra": "^10.0.0",
-    "jest": "^27.2.1",
+    "jest": "^27.2.2",
     "prettier": "^2.4.1",
+    "prompts": "^2.4.1",
     "ts-essentials": "^8.1.0",
     "ts-jest": "^27.0.5",
-    "tsup": "^5.1.0",
-    "typescript": "^4.4.3"
+    "tsup": "^5.2.1",
+    "typescript": "^4.4.3",
+    "husky": "^7.0.2"
   }
 }