kirbyup 3.4.0 → 3.5.0

package/README.md

@@ -2,25 +2,26 @@
 
 # kirbyup
 
-[![npm version](https://img.shields.io/npm/v/kirbyup?color=a1b858&label=)](https://www.npmjs.com/package/kirbyup)
-
-The official bundler for Kirby Panel plugins with zero-config usage and built-in HMR.
+The official bundler for Kirby Panel plugins. Zero-config, built-in HMR.
 
 - [✨  Release Notes](https://github.com/johannschopplich/kirbyup/releases)
 - [📖  Read the documentation](https://kirbyup.getkirby.com)
 
 ## Key Features
 
-- 🔄 [Hot module replacement](https://kirbyup.getkirby.com/guide/getting-started.html#development)
-- 🎒 PostCSS support
-- 🧭 Add custom path aliases
-- 🔌 Run actions based on environment variables
-- 🦔 [Extends Vite with `kirbyup.config.js`](https://kirbyup.getkirby.com/guide/config-file)
+- 🔄 [Hot Module Replacement](https://kirbyup.getkirby.com/guide/getting-started.html#development)
+- 🎒 [PostCSS & Sass](https://kirbyup.getkirby.com/guide/postcss)
+- 🧩 [kirbyuse Integration](https://kirbyup.getkirby.com/guide/kirbyuse)
+- 🔌 [Environment Variables](https://kirbyup.getkirby.com/guide/environment-variables)
+- 🦔 [Configuration File](https://kirbyup.getkirby.com/guide/config-file)
+- 🧭 [Path Aliases](https://kirbyup.getkirby.com/guide/path-aliases)
 
 ## Setup
 
 > [!TIP]
-> [📖 Read the documentation](https://kirbyup.getkirby.com)
+> Skip starting from scratch and pick one of the following starters:
+> - [`eslint`](./examples/eslint)
+> - [`unocss`](./examples/unocss)
 
 ```bash
 # pnpm
@@ -28,16 +29,12 @@ pnpm add -D kirbyup
 
 # npm
 npm i -D kirbyup
-```
-
-## Basic Usage
 
-> [!TIP]
-> [📖 Read the documentation](https://kirbyup.getkirby.com) or skip starting from scratch and pick one of the following starters:
-> - [`eslint`](./examples/eslint)
-> - [`tailwindcss`](./examples/tailwindcss)
+# yarn
+yarn add -D kirbyup
+```
 
-Having installed kirbyup, you can add the following scripts as shortcuts to the commands you will use most often:
+After installation, add these scripts to your `package.json`:
 
 ```json
 {
@@ -46,18 +43,18 @@ Having installed kirbyup, you can add the following scripts as shortcuts to the
     "build": "kirbyup src/index.js"
   },
   "devDependencies": {
-    "kirbyup": "^3.4.0"
+    "kirbyup": "^3.5.0"
   }
 }
 ```
 
-## 💻 Development
+## Development
 
 1. Clone this repository
 2. Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
 3. Install dependencies using `pnpm install`
-4. Run `pnpm run dev:prepare`
-5. Start development server using `pnpm run dev`
+4. Build with `pnpm run build`
+5. Run tests with `pnpm test`
 
 ## License
 

package/dist/client/config.d.mts

@@ -1,6 +1,5 @@
-import { U as UserConfig } from '../shared/kirbyup.DNMktHWN.mjs';
-import 'vite';
-
+import { r as UserConfig } from "../types-C3c_wslr.mjs";
+//#region src/client/config.d.ts
 declare function defineConfig(config: UserConfig): UserConfig;
-
-export { defineConfig };
+//#endregion
+export { defineConfig };

package/dist/client/config.mjs

@@ -1,5 +1,6 @@
+//#region src/client/config.ts
 function defineConfig(config) {
-  return config;
+	return config;
 }
-
+//#endregion
 export { defineConfig };

package/dist/client/plugin.d.mts

@@ -1,12 +1,7 @@
-declare const kirbyup: Readonly<{
-    /**
-     * Auto-import Kirby Panel components, transformed by
-     * kirbyup's glob-import plugin for Vite.
-     *
-     * @example
-     * kirbyup.import('./components/blocks/*.vue')
-     */
-    import(glob: string): Record<string, any>;
-}>;
-
-export { kirbyup };
+//#region src/client/plugin.d.ts
+interface KirbyupUtilities {
+  import: (glob: string) => Record<string, any>;
+}
+declare const kirbyup: Readonly<KirbyupUtilities>;
+//#endregion
+export { KirbyupUtilities, kirbyup };

package/dist/client/plugin.mjs

@@ -1,24 +1,20 @@
-const kirbyup = Object.freeze({
-  /**
-   * Auto-import Kirby Panel components, transformed by
-   * kirbyup's glob-import plugin for Vite.
-   *
-   * @example
-   * kirbyup.import('./components/blocks/*.vue')
-   */
-  import(glob) {
-    const modules = glob;
-    return Object.entries(modules).reduce(
-      (accumulator, [path, component]) => {
-        accumulator[getComponentName(path)] = component.default;
-        return accumulator;
-      },
-      {}
-    );
-  }
-});
+//#region src/client/plugin.ts
+const kirbyup = Object.freeze({ 
+/**
+* Auto-import Kirby Panel components, transformed by
+* kirbyup's glob-import plugin for Vite.
+*
+* @example
+* kirbyup.import('./components/blocks/*.vue')
+*/
+import(glob) {
+	return Object.entries(glob).reduce((accumulator, [path, component]) => {
+		accumulator[getComponentName(path)] = component.default;
+		return accumulator;
+	}, {});
+} });
 function getComponentName(path) {
-  return path.substring(path.lastIndexOf("/") + 1, path.lastIndexOf(".")).toLowerCase();
+	return path.substring(path.lastIndexOf("/") + 1, path.lastIndexOf(".")).toLowerCase();
 }
-
+//#endregion
 export { kirbyup };

package/dist/node/cli.d.mts

@@ -1,2 +1 @@
-
-export { };
+export {}

package/dist/node/cli.mjs

@@ -1,53 +1,42 @@
-import { cac } from 'cac';
-import { n as name, b as build, s as serve, v as version, h as handleError } from '../shared/kirbyup.Bxmi3UeO.mjs';
-import 'node:fs';
-import 'node:fs/promises';
-import '@vitejs/plugin-vue2';
-import '@vitejs/plugin-vue2-jsx';
-import 'consola';
-import 'consola/utils';
-import 'pathe';
-import 'perfect-debounce';
-import 'rollup-plugin-external-globals';
-import 'vite';
-import 'vite-plugin-full-reload';
-import 'vue/compiler-sfc';
-import 'c12';
-import 'postcss-load-config';
-import 'magic-string';
-import 'nypm';
-import 'node:buffer';
-import 'node:util';
-import 'node:zlib';
-
+import { a as version, i as name, n as serve, r as handleError, t as build } from "../node-UMSghnjT.mjs";
+import { cac } from "cac";
+//#region src/node/cli-start.ts
 async function startCli(cwd = process.cwd(), argv = process.argv) {
-  const cli = cac(name);
-  cli.command("<file>", "Compile the Kirby Panel plugin to index.js and index.css").option("-d, --out-dir <dir>", "Output directory", { default: cwd }).option(
-    "-w, --watch [path]",
-    "Watch for file changes. If no path is specified, the folder of the input file will be watched",
-    { default: false }
-  ).example("kirbyup src/index.js").example("kirbyup src/index.js --out-dir ~/kirby-site/site/plugins/demo").example("kirbyup src/index.js --watch src/**/*.{js,css} --watch assets/*\n").action(async (file, options) => {
-    process.env.NODE_ENV ||= options.watch ? "development" : "production";
-    await build({ cwd, entry: file, ...options });
-  });
-  cli.command("serve <file>", "Start development server with live reload").option("--no-watch", "Don't watch .php files for changes", { default: "\0" }).option("-w, --watch <path>", "Watch additional files", { default: "./**/*.php" }).option("-p, --port <number>", "Port for the development server", { default: 5177 }).option("-d, --out-dir <dir>", "Output directory").example("kirbyup serve src/index.js").example("kirbyup serve src/index.js --no-watch --port 3003").example("kirbyup serve src/index.js --watch snippets/*.php --watch templates/*.php\n").action(async (file, options) => {
-    process.env.NODE_ENV ||= "development";
-    const server = await serve({ cwd, entry: file, ...options });
-    const exitProcess = async () => {
-      try {
-        await server.close();
-      } finally {
-        process.exit();
-      }
-    };
-    process.once("SIGINT", exitProcess);
-  });
-  cli.help(
-    (s) => s.map((msg) => ({ ...msg, body: msg.body.replace(" (default: \0)", "") }))
-  );
-  cli.version(version);
-  cli.parse(argv, { run: false });
-  await cli.runMatchedCommand();
+	const cli = cac(name);
+	cli.command("<file>", "Compile the Kirby Panel plugin to index.js and index.css").option("-d, --out-dir <dir>", "Output directory", { default: cwd }).option("-w, --watch [path]", "Watch for file changes. If no path is specified, the folder of the input file will be watched", { default: false }).example("kirbyup src/index.js").example("kirbyup src/index.js --out-dir ~/kirby-site/site/plugins/demo").example("kirbyup src/index.js --watch src/**/*.{js,css} --watch assets/*\n").action(async (file, options) => {
+		process.env.NODE_ENV ||= options.watch ? "development" : "production";
+		await build({
+			cwd,
+			entry: file,
+			...options
+		});
+	});
+	cli.command("serve <file>", "Start development server with live reload").option("--no-watch", "Don't watch .php files for changes", { default: "\0" }).option("-w, --watch <path>", "Watch additional files", { default: "./**/*.php" }).option("-p, --port <number>", "Port for the development server", { default: 5177 }).option("-d, --out-dir <dir>", "Output directory").example("kirbyup serve src/index.js").example("kirbyup serve src/index.js --no-watch --port 3003").example("kirbyup serve src/index.js --watch snippets/*.php --watch templates/*.php\n").action(async (file, options) => {
+		process.env.NODE_ENV ||= "development";
+		const server = await serve({
+			cwd,
+			entry: file,
+			...options
+		});
+		const exitProcess = async () => {
+			try {
+				await server.close();
+			} finally {
+				process.exit();
+			}
+		};
+		process.once("SIGINT", exitProcess);
+	});
+	cli.help((s) => s.map((msg) => ({
+		...msg,
+		body: msg.body.replace(" (default: \0)", "")
+	})));
+	cli.version(version);
+	cli.parse(argv, { run: false });
+	await cli.runMatchedCommand();
 }
-
+//#endregion
+//#region src/node/cli.ts
 startCli().catch(handleError);
+//#endregion
+export {};

package/dist/node/index.d.mts

@@ -1,7 +1,7 @@
-import * as vite from 'vite';
-import { B as BuildOptions, S as ServeOptions } from '../shared/kirbyup.DNMktHWN.mjs';
-
+import { n as ServeOptions, t as BuildOptions } from "../types-C3c_wslr.mjs";
+import { ViteDevServer } from "vite";
+//#region src/node/index.d.ts
 declare function build(options: BuildOptions): Promise<void>;
-declare function serve(options: ServeOptions): Promise<vite.ViteDevServer>;
-
-export { build, serve };
+declare function serve(options: ServeOptions): Promise<ViteDevServer>;
+//#endregion
+export { build, serve };

package/dist/node/index.mjs

@@ -1,20 +1,2 @@
-import 'node:fs';
-import 'node:fs/promises';
-import '@vitejs/plugin-vue2';
-import '@vitejs/plugin-vue2-jsx';
-import 'consola';
-import 'consola/utils';
-import 'pathe';
-import 'perfect-debounce';
-import 'rollup-plugin-external-globals';
-import 'vite';
-import 'vite-plugin-full-reload';
-import 'vue/compiler-sfc';
-export { b as build, s as serve } from '../shared/kirbyup.Bxmi3UeO.mjs';
-import 'c12';
-import 'postcss-load-config';
-import 'magic-string';
-import 'nypm';
-import 'node:buffer';
-import 'node:util';
-import 'node:zlib';
+import { n as serve, t as build } from "../node-UMSghnjT.mjs";
+export { build, serve };