kirbyup 3.0.0 → 3.0.2

package/LICENSE

@@ -1,7 +1,7 @@
 MIT License
 
-Copyright (c) 2021-2023 Johann Schopplich <https://github.com/johannschopplich>
-Copyright (c) 2022-2023 Jonas Kuske <https://github.com/jonaskuske>
+Copyright (c) 2021-PRESENT Johann Schopplich <https://github.com/johannschopplich>
+Copyright (c) 2022-PRESENT Jonas Kuske <https://github.com/jonaskuske>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,5 +1,6 @@
 # kirbyup
 
+> [!NOTE]
 > 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.
@@ -17,7 +18,7 @@ The fastest and leanest way to bundle your Kirby Panel plugins. No configuration
 
 ## Requirements
 
-- Node 16 or newer
+- Latest Node.js LTS version (currently v18)
 
 ## Get Started Right Away
 
@@ -41,6 +42,7 @@ If you want to use kirbyup right away, there is no need to install it. Simply ca
 }
 ```
 
+> [!NOTE]
 > If `npx` doesn't use the latest kirbyup version, although it is available, run `npx -y kirbyup@latest` instead or delete the `~/.npm/_npx` cache folder.
 
 While kirbyup will stay backwards compatible, exact build reproducibility may be of importance to you. If so, I recommend targeting a specific package version, rather than using `npx`. Install kirbyup with a package manager of your choice locally to your project:
@@ -72,7 +74,8 @@ Global installation is supported as well, but not recommended.
 
 Start a development server for the Panel plugin:
 
-> ℹ️ This feature requires Kirby v3.7.4+.
+> [!NOTE]
+> This feature requires Kirby v3.7.4+.
 
 ```bash
 kirbyup serve src/index.js
@@ -122,7 +125,8 @@ You can use the alias:
 import someUtility from '~/utils'
 ```
 
-> ℹ️ You can use `@/` as path alias as well.
+> [!NOTE]
+> You can use `@/` as path alias as well.
 
 ### Auto-Import Blocks and Fields
 
@@ -172,7 +176,7 @@ Loaded env variables are also exposed to your source code via `import.meta.env`.
 
 To prevent accidentally leaking env variables for distribution, only variables prefixed with `KIRBYUP_` or `VITE_` are exposed to your processed code. Take the following file as an example:
 
-```
+```ini
 DB_PASSWORD=foobar
 KIRBYUP_SOME_KEY=123
 ```
@@ -187,9 +191,11 @@ Create a `kirbyup.config.js` or `kirbyup.config.ts` configuration file the root-
 import { resolve } from 'node:path'
 import { defineConfig } from 'kirbyup/config'
 
+const currentDir = new URL('.', import.meta.url).pathname
+
 export default defineConfig({
   alias: {
-    '#deep/': `${resolve(__dirname, 'src/deep')}/`
+    '#deep/': `${resolve(currentDir, 'src/deep')}/`
   },
   extendViteConfig: {
     build: {
@@ -239,7 +245,8 @@ The output directory where the plugin file read by Kirby is saved. Defaults to t
 
 Specifies additional files that should be watched for changes, with changes causing the page to reload. Repeat `--watch` for multiple paths.
 
-> 💡 By default, kirbyup will watch all PHP files (`./**/*.php`) in the plugin directory and reload the page if it detects changes. Using `--watch` to set your own path overrides this setting, so you need to add the PHP glob explicitly if you want to keep the behavior: `--watch ./my/files/* --watch ./**/*.php`
+> [!NOTE]
+> By default, kirbyup will watch all PHP files (`./**/*.php`) in the plugin directory and reload the page if it detects changes. Using `--watch` to set your own path overrides this setting, so you need to add the PHP glob explicitly if you want to keep the behavior: `--watch ./my/files/* --watch ./**/*.php`
 
 ##### `--no-watch`
 
@@ -252,6 +259,6 @@ Disables the default behavior of watching all PHP files for changes.
 
 ## License
 
-[MIT](./LICENSE) License © 2021-2023 [Johann Schopplich](https://github.com/johannschopplich)
+[MIT](./LICENSE) License © 2021-PRESENT [Johann Schopplich](https://github.com/johannschopplich)
 
-[MIT](./LICENSE) License © 2022-2023 [Jonas Kuske](https://github.com/jonaskuske)
+[MIT](./LICENSE) License © 2022-PRESENT [Jonas Kuske](https://github.com/jonaskuske)

package/cli.mjs

@@ -1,3 +1,3 @@
 #!/usr/bin/env node
 'use strict'
-import('./dist/cli.mjs')
+import('./dist/node/cli.mjs')

package/dist/client/config.d.mts

@@ -0,0 +1,6 @@
+import { U as UserConfig } from '../shared/kirbyup.cf02d174.mjs';
+import 'vite';
+
+declare function defineConfig(config: UserConfig): UserConfig;
+
+export { defineConfig };

package/dist/{config.d.ts → client/config.d.ts}

@@ -1,4 +1,4 @@
-import { U as UserConfig } from './types-77db3ac4.js';
+import { U as UserConfig } from '../shared/kirbyup.cf02d174.js';
 import 'vite';
 
 declare function defineConfig(config: UserConfig): UserConfig;

package/dist/client/plugin.d.ts

@@ -0,0 +1,12 @@
+declare const kirbyup: Readonly<{
+    /**
+     * Auto-import Kirby Panel components, will be transformed by
+     * kirbyup's auto import plugin for Vite
+     *
+     * @example
+     * kirbyup.import('./components/blocks/*.vue')
+     */
+    import(glob: string): Record<string, any>;
+}>;
+
+export { kirbyup };

package/dist/node/cli.d.mts

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

package/dist/node/cli.d.ts

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

package/dist/{cli.mjs → node/cli.mjs}

@@ -1,10 +1,10 @@
 import { cac } from 'cac';
-import { n as name, b as build, s as serve, v as version, h as handleError } from './shared/kirbyup.330155d0.mjs';
+import { n as name, b as build, s as serve, v as version, h as handleError } from '../shared/kirbyup.3a78cfb2.mjs';
 import 'node:fs';
 import 'node:fs/promises';
 import 'pathe';
 import 'consola';
-import 'picocolors';
+import 'consola/utils';
 import 'perfect-debounce';
 import 'vite';
 import 'vue/compiler-sfc';

package/dist/node/index.d.mts

@@ -0,0 +1,7 @@
+import * as vite from 'vite';
+import { B as BuildOptions, S as ServeOptions } from '../shared/kirbyup.cf02d174.mjs';
+
+declare function build(options: BuildOptions): Promise<void>;
+declare function serve(options: ServeOptions): Promise<vite.ViteDevServer>;
+
+export { build, serve };

package/dist/{index.d.ts → node/index.d.ts}

@@ -1,5 +1,5 @@
 import * as vite from 'vite';
-import { B as BuildOptions, S as ServeOptions } from './types-77db3ac4.js';
+import { B as BuildOptions, S as ServeOptions } from '../shared/kirbyup.cf02d174.js';
 
 declare function build(options: BuildOptions): Promise<void>;
 declare function serve(options: ServeOptions): Promise<vite.ViteDevServer>;

package/dist/{index.mjs → node/index.mjs}

@@ -2,7 +2,7 @@ import 'node:fs';
 import 'node:fs/promises';
 import 'pathe';
 import 'consola';
-import 'picocolors';
+import 'consola/utils';
 import 'perfect-debounce';
 import 'vite';
 import 'vue/compiler-sfc';
@@ -13,7 +13,7 @@ import 'rollup-plugin-external-globals';
 import 'postcss-load-config';
 import 'postcss-logical';
 import 'postcss-dir-pseudo-class';
-export { b as build, s as serve } from './shared/kirbyup.330155d0.mjs';
+export { b as build, s as serve } from '../shared/kirbyup.3a78cfb2.mjs';
 import 'node:zlib';
 import 'node:util';
 import 'node:buffer';

package/dist/shared/{kirbyup.330155d0.mjs → kirbyup.3a78cfb2.mjs}

@@ -1,8 +1,8 @@
 import { existsSync, statSync, unlinkSync } from 'node:fs';
 import { writeFile, readFile } from 'node:fs/promises';
 import { normalize, relative, resolve, dirname, basename } from 'pathe';
-import consola from 'consola';
-import colors from 'picocolors';
+import { consola } from 'consola';
+import { colors } from 'consola/utils';
 import { debounce } from 'perfect-debounce';
 import { createServer, mergeConfig, build as build$1 } from 'vite';
 import * as vueCompilerSfc from 'vue/compiler-sfc';
@@ -21,7 +21,7 @@ import MagicString from 'magic-string';
 import { detect } from 'detect-package-manager';
 
 const name = "kirbyup";
-const version = "3.0.0";
+const version = "3.0.2";
 
 class PrettyError extends Error {
   constructor(message) {
@@ -55,7 +55,7 @@ async function printFileInfo(root, outDir, filePath, content, type, maxLength) {
   const compressedSize = await getCompressedSize(content);
   const writeColor = type === "chunk" ? colors.cyan : colors.magenta;
   consola.log(
-    colors.white(colors.dim(prettyOutDir)) + writeColor(filePath.padEnd(maxLength + 2)) + colors.dim(`${kibs.toFixed(2)} KiB${compressedSize}`)
+    colors.white(colors.dim(prettyOutDir)) + writeColor(filePath.padEnd(maxLength + 2)) + colors.dim(`${kibs.toFixed(2)} kB${compressedSize}`)
   );
 }
 

package/dist/{types-77db3ac4.d.ts → shared/kirbyup.cf02d174.d.mts}

@@ -33,4 +33,4 @@ interface UserConfig {
     extendViteConfig?: InlineConfig;
 }
 
-export { BuildOptions as B, ServeOptions as S, UserConfig as U };
+export type { BuildOptions as B, ServeOptions as S, UserConfig as U };

package/dist/shared/kirbyup.cf02d174.d.ts

@@ -0,0 +1,36 @@
+import { AliasOptions, InlineConfig } from 'vite';
+
+interface BaseOptions {
+    cwd: string;
+    entry: string;
+}
+interface ServeOptions extends BaseOptions {
+    watch: false | string | string[];
+    port: number;
+    outDir?: string;
+}
+interface BuildOptions extends BaseOptions {
+    outDir: string;
+    watch: boolean | string | string[];
+}
+interface UserConfig {
+    /**
+     * Load from config files
+     * Set to `false` to disable
+     */
+    configFile?: string | false;
+    /**
+     * Specifies an `Object`, or an `Array` of `Object`,
+     * which defines aliases used to replace values in `import` statements.
+     * With either format, the order of the entries is important,
+     * in that the first defined rules are applied first.
+     */
+    alias?: AliasOptions;
+    /**
+     * Extends Vite's configuration. Will be merged with kirbyup's
+     * default configuration. Be careful what to extend.
+     */
+    extendViteConfig?: InlineConfig;
+}
+
+export type { BuildOptions as B, ServeOptions as S, UserConfig as U };

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "kirbyup",
-  "version": "3.0.0",
-  "packageManager": "pnpm@8.6.3",
+  "type": "module",
+  "version": "3.0.2",
+  "packageManager": "pnpm@8.10.5",
   "description": "Zero-config bundler for Kirby Panel plugins",
   "author": {
     "name": "Johann Schopplich",
@@ -25,27 +26,27 @@
   ],
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.mjs"
+      "types": "./dist/node/index.d.ts",
+      "import": "./dist/node/index.mjs"
     },
     "./config": {
-      "types": "./dist/config.d.ts",
-      "import": "./dist/config.mjs"
+      "types": "./dist/client/config.d.ts",
+      "import": "./dist/client/config.mjs"
     },
     "./plugin": {
-      "types": "./dist/plugin.d.ts",
-      "import": "./dist/plugin.mjs"
+      "types": "./dist/client/plugin.d.ts",
+      "import": "./dist/client/plugin.mjs"
     }
   },
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
+  "module": "./dist/node/index.mjs",
+  "types": "./dist/node/index.d.ts",
   "typesVersions": {
     "*": {
       "config": [
-        "./dist/config.d.ts"
+        "./dist/client/config.d.ts"
       ],
       "plugin": [
-        "./dist/plugin.d.ts"
+        "./dist/client/plugin.d.ts"
       ]
     }
   },
@@ -55,11 +56,11 @@
     "dist"
   ],
   "engines": {
-    "node": ">=16"
+    "node": ">=18"
   },
   "scripts": {
     "build": "unbuild",
-    "dev": "STUB=true unbuild",
+    "dev": "UNBUILD_STUB=true unbuild",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "release": "bumpp --commit --push --tag",
@@ -70,39 +71,38 @@
   "dependencies": {
     "@vitejs/plugin-vue2": "2.2.0",
     "@vitejs/plugin-vue2-jsx": "1.1.0",
-    "@vue/compiler-sfc": "^2.7.14",
+    "@vue/compiler-sfc": "^2.7.15",
     "cac": "^6.7.14",
     "chokidar": "^3.5.3",
-    "consola": "^2.15.3",
-    "detect-package-manager": "^2.0.1",
-    "magic-string": "^0.30.0",
+    "consola": "^3.2.3",
+    "detect-package-manager": "^3.0.1",
+    "magic-string": "^0.30.5",
     "pathe": "^1.1.1",
-    "perfect-debounce": "^0.1.3",
-    "picocolors": "^1.0.0",
-    "postcss": "^8.4.24",
-    "postcss-dir-pseudo-class": "^7.0.2",
+    "perfect-debounce": "^1.0.0",
+    "postcss": "^8.4.31",
+    "postcss-dir-pseudo-class": "^8.0.0",
     "postcss-load-config": "^4.0.1",
-    "postcss-logical": "^6.2.0",
+    "postcss-logical": "^7.0.0",
     "rollup-plugin-external-globals": "^0.8.0",
-    "sass": "^1.63.4",
-    "unconfig": "^0.3.9",
-    "vite": "^4.3.9",
+    "sass": "^1.69.5",
+    "unconfig": "^0.3.11",
+    "vite": "^4.5.0",
     "vite-plugin-full-reload": "^1.0.5",
-    "vue": "^2.7.14"
+    "vue": "^2.7.15"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^0.38.6",
-    "@types/fs-extra": "^11.0.1",
-    "@types/node": "^18.16.18",
-    "@types/prompts": "^2.4.4",
-    "bumpp": "^9.1.1",
-    "eslint": "^8.43.0",
-    "fast-glob": "^3.2.12",
+    "@antfu/eslint-config": "^1.1.2",
+    "@types/fs-extra": "^11.0.4",
+    "@types/node": "^20.9.0",
+    "@types/prompts": "^2.4.8",
+    "bumpp": "^9.2.0",
+    "eslint": "^8.53.0",
+    "fast-glob": "^3.3.2",
     "fs-extra": "^11.1.1",
-    "simple-git-hooks": "^2.8.1",
-    "typescript": "~5.0.4",
-    "unbuild": "^1.2.1",
-    "vitest": "^0.29.8"
+    "simple-git-hooks": "^2.9.0",
+    "typescript": "~5.2.2",
+    "unbuild": "^2.0.0",
+    "vitest": "^0.34.6"
   },
   "simple-git-hooks": {
     "commit-msg": "node scripts/verifyCommit.mjs $1"

package/dist/cli.d.ts

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