vite-plugin-kiru 0.24.0

package/LICENSE

@@ -0,0 +1,7 @@
+ISC License
+
+Copyright (c) 2024-present, Rob (LankyMoose) Austen and Kiru contributors
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,44 @@
+# vite-plugin-kiru
+
+Vite plugin for <a href="https://kirujs.dev">Kiru</a> apps that enables HMR, devtools, and more.
+
+## Installation
+
+```bash
+npm i -D vite-plugin-kiru
+# or
+pnpm add -D vite-plugin-kiru
+```
+
+### Basic Usage
+
+```ts
+// vite.config.ts
+import { defineConfig } from "vite"
+import kiru from "vite-plugin-kiru"
+
+export default defineConfig({
+  plugins: [kiru()],
+})
+```
+
+### Configuration
+
+```ts
+kiru({
+  // Enable or disable the Kiru devtools.
+  // Defaults to true in development mode.
+  devtools: false,
+
+  // Or provide configuration for the devtools client
+  devtools: {
+    // Path where the devtools client will be served
+    pathname: "/devtools", // default: "/__devtools__"
+    // Optional - function to format file links that will be displayed in the devtools
+    formatFileLink: (path, line) => `vscode://file/${path}:${line}`,
+  },
+
+  // Additional directories (relative to root) to include in transforms.
+  include: ["../shared/"],
+})
+```

package/build.dev.ts

@@ -0,0 +1,29 @@
+import esbuild from "esbuild"
+import fs from "node:fs"
+
+await esbuild
+  .context({
+    entryPoints: ["src/index.ts"],
+    bundle: true,
+    platform: "node",
+    target: "esnext",
+    format: "esm",
+    outfile: "./dist/index.js",
+    external: ["kiru"],
+    write: true,
+    plugins: [
+      {
+        name: "build-evts",
+        setup({ onEnd }) {
+          onEnd(() => {
+            console.log("[vite-plugin-kiru]: Build complete!")
+            fs.copyFileSync("./src/types.d.ts", "dist/index.d.ts")
+          })
+        },
+      },
+    ],
+  })
+  .then((ctx) => {
+    ctx.watch()
+    console.log("[vite-plugin-kiru]: Watching for changes...")
+  })

package/dist/index.d.ts

@@ -0,0 +1,57 @@
+import type { Plugin } from "vite"
+
+export type FileLinkFormatter = (path: string, line: number) => string
+
+export interface DevtoolsOptions {
+  /**
+   * Specifies the path to the devtools app displayed via popup
+   * @default "/__devtools__"
+   */
+  pathname?: string
+
+  /**
+   * Formats the link displayed in devtools to the component's source code
+   * @param path the path to the file that contains the component on disk
+   * @param line the component's line number
+   * @returns {string} the formatted link
+   * @default (path, line) => `vscode://file/${path}:${line}`
+   */
+  formatFileLink?: FileLinkFormatter
+}
+
+export interface KiruPluginOptions {
+  /**
+   * Whether the devtools should be injected into the build during development
+   * @default true
+   */
+  devtools?: boolean | DevtoolsOptions
+
+  /**
+   * Additional directories (relative to root) to include in transforms
+   * @example ['../path/to/components/']
+   */
+  include?: string[]
+
+  /**
+   * Whether logging should be enabled
+   * @default false
+   */
+  loggingEnabled?: boolean
+
+  /**
+   * Callback for when a file is transformed
+   */
+  onFileTransformed?: (id: string, content: string) => void
+
+  /**
+   * Callback for when a file is excluded from transforms due to not being in project root or `include`
+   */
+  onFileExcluded?: (id: string) => void
+}
+
+/**
+ * Registers a callback to be fired when the HMR is triggered
+ */
+export function onHMR(callback: () => void): void
+
+export default function kiru(opts?: KiruPluginOptions): Plugin