kirbyup 0.21.0 → 0.22.2

package/README.md

@@ -11,8 +11,9 @@ The fastest and leanest way to bundle your Kirby Panel plugins. No configuration
 - 🔍 Watch mode
 - \*️⃣ `kirbyup.import` to [auto-import blocks & fields](#auto-import-blocks-and-fields)
 - 🎒 [PostCSS support](#postcss)
-- 🧭 [`~/` path resolve alias](#path-resolve-alias)
+- 🧭 [Path resolve aliases](#path-resolve-aliases)
 - 🔌 [Env variables support](#env-variables)
+- 🦔 [Extendable configuration with `kirbyup.config.js`](#extendable-configuration-with-kirbyupconfigjs)
 
 ## Requirements
 
@@ -58,7 +59,7 @@ Example package configuration:
     "build": "kirbyup src/index.js"
   },
   "devDependencies": {
-    "kirbyup": "^0.20.1"
+    "kirbyup": "latest"
   }
 }
 ```
@@ -106,7 +107,7 @@ If no configuration file is found, kirbyup will apply two PostCSS plugins which
 - [postcss-logical](https://github.com/csstools/postcss-logical) lets you use logical, rather than physical, direction and dimension mappings in CSS, following the [CSS Logical Properties and Values](https://drafts.csswg.org/css-logical/) specification.
 - [postcss-dir-pseudo-class](https://github.com/csstools/postcss-dir-pseudo-class) lets you style by directionality using the `:dir()` pseudo-class in CSS, following the [Selectors](https://www.w3.org/TR/selectors-4/#the-dir-pseudo) specification. It gives you the same syntax Kirby uses for full compatibility with RTL localizations of the Panel.
 
-### Path Resolve Alias
+### Path Resolve Aliases
 
 Import certain modules more easily by using the `~/` path alias. It will resolve to the directory of your input file, for example `src` when building `kirbyup src/index.js`.
 
@@ -187,6 +188,38 @@ KIRBYUP_SOME_KEY=123
 
 Only `KIRBYUP_SOME_KEY` will be exposed as `import.meta.env.VITE_SOME_KEY` to your plugin's source code, but `DB_PASSWORD` will not.
 
+### Extendable Configuration With `kirbyup.config.js`
+
+Create a `kirbyup.config.js` or `kirbyup.config.ts` configuration file the root-level of your project to customize kirbyup.
+
+```js
+import { resolve } from 'path'
+import { defineConfig } from 'kirbyup'
+
+export default defineConfig({
+  alias: {
+    '#deep/': `${resolve(__dirname, 'src/deep')}/`
+  },
+  extendViteConfig: {
+    build: {
+      lib: {
+        name: 'myPlugin'
+      }
+    }
+  }
+})
+```
+
+#### `alias`
+
+When aliasing to file system paths, always use absolute paths. Relative alias values will be used as-is and will not be resolved into file system paths.
+
+#### `extendViteConfig`
+
+You can build upon the defaults kirbup uses and extend the Vite configuration with custom plugins etc.
+
+For a complete list of options, take a look at the [Vite configuration options](https://vitejs.dev/config/).
+
 ## Options
 
 > Inspect all available options with `kirbyup --help`.
@@ -206,4 +239,4 @@ Sets the watch mode. If no path is specified, kirbyup watches the folder of the
 
 ## License
 
-MIT
+[MIT](./LICENSE) License © 2021 [Johann Schopplich](https://github.com/johannschopplich)

package/bin/kirbyup.cjs

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require('../dist/cli.cjs')

package/dist/chunks/index.cjs

@@ -0,0 +1,298 @@
+'use strict';
+
+const pathe = require('pathe');
+const fs = require('fs');
+const vite = require('vite');
+const vitePluginVue2 = require('vite-plugin-vue2');
+const MagicString = require('magic-string');
+const unconfig = require('unconfig');
+const postcssrc = require('postcss-load-config');
+const postcssLogical = require('postcss-logical');
+const postcssDirPseudoClass = require('postcss-dir-pseudo-class');
+const consola = require('consola');
+const colorette = require('colorette');
+const promises = require('fs/promises');
+const zlib = require('zlib');
+const util = require('util');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e["default"] : e; }
+
+const MagicString__default = /*#__PURE__*/_interopDefaultLegacy(MagicString);
+const postcssrc__default = /*#__PURE__*/_interopDefaultLegacy(postcssrc);
+const postcssLogical__default = /*#__PURE__*/_interopDefaultLegacy(postcssLogical);
+const postcssDirPseudoClass__default = /*#__PURE__*/_interopDefaultLegacy(postcssDirPseudoClass);
+const consola__default = /*#__PURE__*/_interopDefaultLegacy(consola);
+
+const multilineCommentsRE = /\/\*(.|[\r\n])*?\*\//gm;
+const singlelineCommentsRE = /\/\/.*/g;
+
+function kirbyupAutoImportPlugin() {
+  let config;
+  return {
+    name: "kirbyup:auto-import",
+    configResolved(resolvedConfig) {
+      config = resolvedConfig;
+    },
+    async transform(code, id) {
+      if (code.includes("kirbyup.import")) {
+        const kirbyupImportRE = /\bkirbyup\.import\s*\(\s*('[^']+'|"[^"]+"|`[^`]+`)\s*\)/g;
+        const noCommentsCode = code.replace(multilineCommentsRE, (m) => " ".repeat(m.length)).replace(singlelineCommentsRE, (m) => " ".repeat(m.length));
+        let s = null;
+        let match;
+        while (match = kirbyupImportRE.exec(noCommentsCode)) {
+          const { 0: exp, 1: rawPath, index } = match;
+          if (!s)
+            s = new MagicString__default(code);
+          s.overwrite(index, index + exp.length, `kirbyup.import(import.meta.globEager(${rawPath}))`);
+        }
+        if (s) {
+          return {
+            code: s.toString(),
+            map: config.build.sourcemap ? s.generateMap({ hires: true }) : null
+          };
+        }
+      }
+      return null;
+    }
+  };
+}
+
+function defineConfig(config) {
+  return config;
+}
+function createConfigLoader(configOrPath = process.cwd(), extraConfigSources = []) {
+  let inlineConfig = {};
+  if (typeof configOrPath !== "string") {
+    inlineConfig = configOrPath;
+    configOrPath = process.cwd();
+  }
+  const resolved = pathe.resolve(configOrPath);
+  let cwd = resolved;
+  let isFile = false;
+  if (fs.existsSync(resolved) && fs.statSync(resolved).isFile()) {
+    isFile = true;
+    cwd = pathe.dirname(resolved);
+  }
+  const loader = unconfig.createConfigLoader({
+    sources: isFile ? [
+      {
+        files: resolved,
+        extensions: []
+      }
+    ] : [
+      {
+        files: ["kirbyup.config"]
+      },
+      ...extraConfigSources
+    ],
+    cwd,
+    defaults: inlineConfig
+  });
+  return async () => {
+    const result = await loader.load();
+    result.config = result.config || inlineConfig;
+    return result;
+  };
+}
+
+class PrettyError extends Error {
+  constructor(message) {
+    super(message);
+    this.name = this.constructor.name;
+    if (typeof Error.captureStackTrace === "function") {
+      Error.captureStackTrace(this, this.constructor);
+    } else {
+      this.stack = new Error(message).stack;
+    }
+  }
+}
+function handleError(error) {
+  if (error instanceof PrettyError) {
+    consola__default.error(error.message);
+  }
+  process.exitCode = 1;
+}
+
+const compress = util.promisify(zlib.gzip);
+async function getCompressedSize(code) {
+  const size = (await compress(typeof code === "string" ? code : Buffer.from(code))).length / 1024;
+  return ` / gzip: ${size.toFixed(2)} KiB`;
+}
+async function printFileInfo(root, outDir, filePath, type, content) {
+  content ?? (content = await promises.readFile(pathe.resolve(outDir, filePath), "utf8"));
+  const prettyOutDir = pathe.normalize(pathe.relative(root, pathe.resolve(root, outDir))) + "/";
+  const kibs = content.length / 1024;
+  const compressedSize = await getCompressedSize(content);
+  const writeColor = type === "chunk" ? colorette.cyan : colorette.magenta;
+  consola__default.log(colorette.white(colorette.dim(prettyOutDir)) + writeColor(filePath) + "   " + colorette.dim(`${kibs.toFixed(2)} KiB${compressedSize}`));
+}
+function debouncePromise(fn, delay, onError) {
+  let timeout;
+  let promiseInFly;
+  let callbackPending;
+  return function debounced(...args) {
+    if (promiseInFly) {
+      callbackPending = () => {
+        debounced(...args);
+        callbackPending = void 0;
+      };
+    } else {
+      if (timeout)
+        clearTimeout(timeout);
+      timeout = setTimeout(() => {
+        timeout = void 0;
+        promiseInFly = fn(...args).catch(onError).finally(() => {
+          promiseInFly = void 0;
+          if (callbackPending)
+            callbackPending();
+        });
+      }, delay);
+    }
+  };
+}
+
+// src/math.ts
+
+// src/array.ts
+function toArray(array) {
+  array = array || [];
+  if (Array.isArray(array))
+    return array;
+  return [array];
+}
+
+const name = "kirbyup";
+const version = "0.22.2";
+
+let resolvedKirbyupConfig;
+let resolvedPostCssConfig;
+async function viteBuild(options) {
+  let result;
+  const mode = options.watch ? "development" : "production";
+  const root = process.cwd();
+  const outDir = options.outDir ?? root;
+  const aliasDir = pathe.resolve(root, pathe.dirname(options.entry));
+  const { alias = {}, extendViteConfig = {} } = resolvedKirbyupConfig;
+  const defaultConfig = {
+    mode,
+    plugins: [vitePluginVue2.createVuePlugin(), kirbyupAutoImportPlugin()],
+    build: {
+      lib: {
+        entry: pathe.resolve(root, options.entry),
+        formats: ["iife"],
+        name: "kirbyupExport",
+        fileName: () => "index.js"
+      },
+      minify: mode === "production",
+      outDir,
+      emptyOutDir: false,
+      rollupOptions: {
+        external: ["vue"],
+        output: {
+          assetFileNames: "index.[ext]",
+          globals: {
+            vue: "Vue"
+          }
+        }
+      }
+    },
+    resolve: {
+      alias: {
+        "~/": `${aliasDir}/`,
+        "@/": `${aliasDir}/`,
+        ...alias
+      }
+    },
+    css: {
+      postcss: resolvedPostCssConfig
+    },
+    envPrefix: ["VITE_", "KIRBYUP_"],
+    logLevel: "warn"
+  };
+  try {
+    result = await vite.build(vite.mergeConfig(defaultConfig, extendViteConfig));
+  } catch (error) {
+    consola__default.error("Build failed");
+    if (mode === "production") {
+      throw error;
+    }
+  }
+  if (result && !options.watch) {
+    const { output } = toArray(result)[0];
+    for (const { fileName, type, code } of output) {
+      printFileInfo(root, outDir, fileName, type, code);
+    }
+  }
+  return result;
+}
+async function resolveOptions(options) {
+  if (!options.entry) {
+    throw new PrettyError("No input file, try " + colorette.cyan(`${name} <path/to/file.js>`));
+  }
+  if (!fs.existsSync(options.entry)) {
+    throw new PrettyError(`Cannot find ${options.entry}`);
+  }
+  return options;
+}
+async function build(_options) {
+  const options = await resolveOptions(_options);
+  const loadConfig = createConfigLoader();
+  const { config, sources: configSources } = await loadConfig();
+  resolvedKirbyupConfig = config;
+  try {
+    resolvedPostCssConfig = await postcssrc__default({});
+  } catch (err) {
+    if (!/No PostCSS Config found/.test(err.message)) {
+      throw err;
+    }
+    resolvedPostCssConfig = {
+      plugins: [postcssLogical__default(), postcssDirPseudoClass__default()]
+    };
+  }
+  consola__default.log(colorette.green(`${name} v${version}`));
+  consola__default.start("Building " + colorette.cyan(options.entry));
+  if (options.watch) {
+    consola__default.info("Running in watch mode");
+  }
+  const debouncedBuild = debouncePromise(async () => {
+    viteBuild(options);
+  }, 100, handleError);
+  const startWatcher = async () => {
+    if (!options.watch)
+      return;
+    const { watch } = await import('chokidar');
+    const ignored = [
+      "**/{.git,node_modules}/**",
+      "index.{css,js}"
+    ];
+    const watchPaths = typeof options.watch === "boolean" ? pathe.dirname(options.entry) : Array.isArray(options.watch) ? options.watch.filter((path) => typeof path === "string") : options.watch;
+    consola__default.info("Watching for changes in " + toArray(watchPaths).map((i) => colorette.cyan(i)).join(", "));
+    const watcher = watch(watchPaths, {
+      ignoreInitial: true,
+      ignorePermissionErrors: true,
+      ignored
+    });
+    if (configSources.length) {
+      watcher.add(configSources);
+    }
+    watcher.on("all", async (type, file) => {
+      if (configSources.includes(file)) {
+        resolvedKirbyupConfig = (await loadConfig()).config;
+        consola__default.info(`${colorette.cyan(pathe.basename(file))} changed, setting new config`);
+      } else {
+        consola__default.log(colorette.green(type) + " " + colorette.white(colorette.dim(file)));
+      }
+      debouncedBuild();
+    });
+  };
+  await viteBuild(options);
+  consola__default.success("Build successful");
+  startWatcher();
+}
+
+exports.build = build;
+exports.defineConfig = defineConfig;
+exports.handleError = handleError;
+exports.name = name;
+exports.resolveOptions = resolveOptions;
+exports.version = version;

package/dist/chunks/index.mjs

@@ -0,0 +1,283 @@
+import { resolve, dirname, normalize, relative, basename } from 'pathe';
+import { existsSync, statSync } from 'fs';
+import { build as build$1, mergeConfig } from 'vite';
+import { createVuePlugin } from 'vite-plugin-vue2';
+import MagicString from 'magic-string';
+import { createConfigLoader as createConfigLoader$1 } from 'unconfig';
+import postcssrc from 'postcss-load-config';
+import postcssLogical from 'postcss-logical';
+import postcssDirPseudoClass from 'postcss-dir-pseudo-class';
+import consola from 'consola';
+import { white, dim, cyan, magenta, green } from 'colorette';
+import { readFile } from 'fs/promises';
+import { gzip } from 'zlib';
+import { promisify } from 'util';
+
+const multilineCommentsRE = /\/\*(.|[\r\n])*?\*\//gm;
+const singlelineCommentsRE = /\/\/.*/g;
+
+function kirbyupAutoImportPlugin() {
+  let config;
+  return {
+    name: "kirbyup:auto-import",
+    configResolved(resolvedConfig) {
+      config = resolvedConfig;
+    },
+    async transform(code, id) {
+      if (code.includes("kirbyup.import")) {
+        const kirbyupImportRE = /\bkirbyup\.import\s*\(\s*('[^']+'|"[^"]+"|`[^`]+`)\s*\)/g;
+        const noCommentsCode = code.replace(multilineCommentsRE, (m) => " ".repeat(m.length)).replace(singlelineCommentsRE, (m) => " ".repeat(m.length));
+        let s = null;
+        let match;
+        while (match = kirbyupImportRE.exec(noCommentsCode)) {
+          const { 0: exp, 1: rawPath, index } = match;
+          if (!s)
+            s = new MagicString(code);
+          s.overwrite(index, index + exp.length, `kirbyup.import(import.meta.globEager(${rawPath}))`);
+        }
+        if (s) {
+          return {
+            code: s.toString(),
+            map: config.build.sourcemap ? s.generateMap({ hires: true }) : null
+          };
+        }
+      }
+      return null;
+    }
+  };
+}
+
+function defineConfig(config) {
+  return config;
+}
+function createConfigLoader(configOrPath = process.cwd(), extraConfigSources = []) {
+  let inlineConfig = {};
+  if (typeof configOrPath !== "string") {
+    inlineConfig = configOrPath;
+    configOrPath = process.cwd();
+  }
+  const resolved = resolve(configOrPath);
+  let cwd = resolved;
+  let isFile = false;
+  if (existsSync(resolved) && statSync(resolved).isFile()) {
+    isFile = true;
+    cwd = dirname(resolved);
+  }
+  const loader = createConfigLoader$1({
+    sources: isFile ? [
+      {
+        files: resolved,
+        extensions: []
+      }
+    ] : [
+      {
+        files: ["kirbyup.config"]
+      },
+      ...extraConfigSources
+    ],
+    cwd,
+    defaults: inlineConfig
+  });
+  return async () => {
+    const result = await loader.load();
+    result.config = result.config || inlineConfig;
+    return result;
+  };
+}
+
+class PrettyError extends Error {
+  constructor(message) {
+    super(message);
+    this.name = this.constructor.name;
+    if (typeof Error.captureStackTrace === "function") {
+      Error.captureStackTrace(this, this.constructor);
+    } else {
+      this.stack = new Error(message).stack;
+    }
+  }
+}
+function handleError(error) {
+  if (error instanceof PrettyError) {
+    consola.error(error.message);
+  }
+  process.exitCode = 1;
+}
+
+const compress = promisify(gzip);
+async function getCompressedSize(code) {
+  const size = (await compress(typeof code === "string" ? code : Buffer.from(code))).length / 1024;
+  return ` / gzip: ${size.toFixed(2)} KiB`;
+}
+async function printFileInfo(root, outDir, filePath, type, content) {
+  content ?? (content = await readFile(resolve(outDir, filePath), "utf8"));
+  const prettyOutDir = normalize(relative(root, resolve(root, outDir))) + "/";
+  const kibs = content.length / 1024;
+  const compressedSize = await getCompressedSize(content);
+  const writeColor = type === "chunk" ? cyan : magenta;
+  consola.log(white(dim(prettyOutDir)) + writeColor(filePath) + "   " + dim(`${kibs.toFixed(2)} KiB${compressedSize}`));
+}
+function debouncePromise(fn, delay, onError) {
+  let timeout;
+  let promiseInFly;
+  let callbackPending;
+  return function debounced(...args) {
+    if (promiseInFly) {
+      callbackPending = () => {
+        debounced(...args);
+        callbackPending = void 0;
+      };
+    } else {
+      if (timeout)
+        clearTimeout(timeout);
+      timeout = setTimeout(() => {
+        timeout = void 0;
+        promiseInFly = fn(...args).catch(onError).finally(() => {
+          promiseInFly = void 0;
+          if (callbackPending)
+            callbackPending();
+        });
+      }, delay);
+    }
+  };
+}
+
+// src/math.ts
+
+// src/array.ts
+function toArray(array) {
+  array = array || [];
+  if (Array.isArray(array))
+    return array;
+  return [array];
+}
+
+const name = "kirbyup";
+const version = "0.22.2";
+
+let resolvedKirbyupConfig;
+let resolvedPostCssConfig;
+async function viteBuild(options) {
+  let result;
+  const mode = options.watch ? "development" : "production";
+  const root = process.cwd();
+  const outDir = options.outDir ?? root;
+  const aliasDir = resolve(root, dirname(options.entry));
+  const { alias = {}, extendViteConfig = {} } = resolvedKirbyupConfig;
+  const defaultConfig = {
+    mode,
+    plugins: [createVuePlugin(), kirbyupAutoImportPlugin()],
+    build: {
+      lib: {
+        entry: resolve(root, options.entry),
+        formats: ["iife"],
+        name: "kirbyupExport",
+        fileName: () => "index.js"
+      },
+      minify: mode === "production",
+      outDir,
+      emptyOutDir: false,
+      rollupOptions: {
+        external: ["vue"],
+        output: {
+          assetFileNames: "index.[ext]",
+          globals: {
+            vue: "Vue"
+          }
+        }
+      }
+    },
+    resolve: {
+      alias: {
+        "~/": `${aliasDir}/`,
+        "@/": `${aliasDir}/`,
+        ...alias
+      }
+    },
+    css: {
+      postcss: resolvedPostCssConfig
+    },
+    envPrefix: ["VITE_", "KIRBYUP_"],
+    logLevel: "warn"
+  };
+  try {
+    result = await build$1(mergeConfig(defaultConfig, extendViteConfig));
+  } catch (error) {
+    consola.error("Build failed");
+    if (mode === "production") {
+      throw error;
+    }
+  }
+  if (result && !options.watch) {
+    const { output } = toArray(result)[0];
+    for (const { fileName, type, code } of output) {
+      printFileInfo(root, outDir, fileName, type, code);
+    }
+  }
+  return result;
+}
+async function resolveOptions(options) {
+  if (!options.entry) {
+    throw new PrettyError("No input file, try " + cyan(`${name} <path/to/file.js>`));
+  }
+  if (!existsSync(options.entry)) {
+    throw new PrettyError(`Cannot find ${options.entry}`);
+  }
+  return options;
+}
+async function build(_options) {
+  const options = await resolveOptions(_options);
+  const loadConfig = createConfigLoader();
+  const { config, sources: configSources } = await loadConfig();
+  resolvedKirbyupConfig = config;
+  try {
+    resolvedPostCssConfig = await postcssrc({});
+  } catch (err) {
+    if (!/No PostCSS Config found/.test(err.message)) {
+      throw err;
+    }
+    resolvedPostCssConfig = {
+      plugins: [postcssLogical(), postcssDirPseudoClass()]
+    };
+  }
+  consola.log(green(`${name} v${version}`));
+  consola.start("Building " + cyan(options.entry));
+  if (options.watch) {
+    consola.info("Running in watch mode");
+  }
+  const debouncedBuild = debouncePromise(async () => {
+    viteBuild(options);
+  }, 100, handleError);
+  const startWatcher = async () => {
+    if (!options.watch)
+      return;
+    const { watch } = await import('chokidar');
+    const ignored = [
+      "**/{.git,node_modules}/**",
+      "index.{css,js}"
+    ];
+    const watchPaths = typeof options.watch === "boolean" ? dirname(options.entry) : Array.isArray(options.watch) ? options.watch.filter((path) => typeof path === "string") : options.watch;
+    consola.info("Watching for changes in " + toArray(watchPaths).map((i) => cyan(i)).join(", "));
+    const watcher = watch(watchPaths, {
+      ignoreInitial: true,
+      ignorePermissionErrors: true,
+      ignored
+    });
+    if (configSources.length) {
+      watcher.add(configSources);
+    }
+    watcher.on("all", async (type, file) => {
+      if (configSources.includes(file)) {
+        resolvedKirbyupConfig = (await loadConfig()).config;
+        consola.info(`${cyan(basename(file))} changed, setting new config`);
+      } else {
+        consola.log(green(type) + " " + white(dim(file)));
+      }
+      debouncedBuild();
+    });
+  };
+  await viteBuild(options);
+  consola.success("Build successful");
+  startWatcher();
+}
+
+export { build as b, defineConfig as d, handleError as h, name as n, resolveOptions as r, version as v };

package/dist/cli.cjs

@@ -0,0 +1,40 @@
+'use strict';
+
+const cac = require('cac');
+const index = require('./chunks/index.cjs');
+require('pathe');
+require('fs');
+require('vite');
+require('vite-plugin-vue2');
+require('magic-string');
+require('unconfig');
+require('postcss-load-config');
+require('postcss-logical');
+require('postcss-dir-pseudo-class');
+require('consola');
+require('colorette');
+require('fs/promises');
+require('zlib');
+require('util');
+
+async function main(options = {}) {
+  const cli = cac.cac(index.name);
+  cli.command("[file]", "Panel input file", {
+    ignoreOptionDefaultValue: true
+  }).option("-d, --out-dir <dir>", "Output directory", {
+    default: process.cwd()
+  }).option("--watch [path]", 'Watch mode, if path is not specified, it watches the folder of the input file. Repeat "--watch" for multiple paths').action(async (file, flags) => {
+    Object.assign(options, {
+      ...flags
+    });
+    if (file) {
+      options.entry = file;
+    }
+    await index.build(options);
+  });
+  cli.help();
+  cli.version(index.version);
+  cli.parse(process.argv, { run: false });
+  await cli.runMatchedCommand();
+}
+main().catch(index.handleError);

package/dist/cli.d.ts

@@ -1 +1 @@
-#!/usr/bin/env node
+