@gjsify/vite-plugin-blueprint 0.2.0

package/README.md

@@ -0,0 +1,88 @@
+# vite-plugin-blueprint
+
+A Vite plugin for compiling Blueprint UI files (`.blp`) to XML and importing them as strings in your JavaScript/TypeScript code.
+
+## Features
+
+- Automatically compiles `.blp` files to XML when imported
+- Optionally minifies the generated XML
+- Seamlessly integrates with your Vite build process
+
+## Installation
+
+```bash
+npm install @gjsify/vite-plugin-blueprint --save-dev
+```
+
+or if you use Yarn:
+
+```bash
+yarn add @gjsify/vite-plugin-blueprint -D
+```
+
+## Usage
+
+Add the plugin to your Vite configuration:
+
+```javascript
+// vite.config.js / vite.config.ts
+import { defineConfig } from "vite";
+import blueprintPlugin from "@gjsify/vite-plugin-blueprint";
+
+export default defineConfig({
+  plugins: [
+    blueprintPlugin({
+      minify: true, // optional, defaults to false
+    }),
+  ],
+  // ... other configurations
+});
+```
+
+Then, you can import `.blp` files directly in your code:
+
+```javascript
+import myUIXML from "./path/to/my-ui.blp";
+console.log(myUIXML); // This will log the compiled XML content as a string
+```
+
+### TypeScript
+
+To use the plugin with TypeScript, you need to declare the module for `.blp` files in a `.d.ts` file:
+
+```typescript
+declare module "*.blp" {
+  const content: string;
+  export default content;
+}
+```
+
+Then, you can import `.blp` files in your TypeScript code:
+
+```typescript
+import myUIXML from "./path/to/my-ui.blp";
+console.log(myUIXML); // This will log the compiled XML content as a string
+```
+
+## Options
+
+The plugin accepts an options object with the following properties:
+
+- `minify` (boolean, optional): If set to `true`, the plugin will minify the generated XML. Default is `false`.
+
+## Requirements
+
+- Vite 2.x or higher
+- Node.js 12.x or higher
+- `blueprint-compiler` must be installed and available in your system's PATH
+
+## How it Works
+
+1. When a `.blp` file is imported, the plugin intercepts the import.
+2. It runs the `blueprint-compiler` to compile the `.blp` file to XML.
+3. If minification is enabled, the XML is minified.
+4. The resulting XML is returned as a string, which can be used in your JavaScript/TypeScript code.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+import { type Plugin } from "vite";
+export interface BlueprintPluginOptions {
+    minify?: boolean;
+    verbose?: boolean;
+}
+export default function blueprintPlugin(options?: BlueprintPluginOptions): Plugin;

package/dist/index.js

@@ -0,0 +1,33 @@
+import {} from "vite";
+import { execa } from "execa";
+import minifyXML from "minify-xml";
+export default function blueprintPlugin(options = {}) {
+    const { minify = false, verbose = false } = options;
+    return {
+        name: "vite-plugin-blueprint",
+        async load(id) {
+            if (id.endsWith(".blp")) {
+                try {
+                    // Compile .blp file and get XML output directly
+                    const { stdout } = await execa("blueprint-compiler", ["compile", id]);
+                    if (verbose)
+                        console.log(`Compiled ${id}`);
+                    let xmlContent = stdout;
+                    // Minify XML if option is enabled
+                    if (minify) {
+                        xmlContent = minifyXML(xmlContent);
+                        if (verbose)
+                            console.log(`Minified XML for ${id}`);
+                    }
+                    // Return the XML content as a string
+                    return `export default ${JSON.stringify(xmlContent)};`;
+                }
+                catch (error) {
+                    console.error(`Error processing ${id}:`, error);
+                    throw error;
+                }
+            }
+        },
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,MAAM,MAAM,CAAC;AACnC,OAAO,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAC9B,OAAO,SAAS,MAAM,YAAY,CAAC;AAOnC,MAAM,CAAC,OAAO,UAAU,eAAe,CACrC,UAAkC,EAAE;IAEpC,MAAM,EAAE,MAAM,GAAG,KAAK,EAAE,OAAO,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC;IAEpD,OAAO;QACL,IAAI,EAAE,uBAAuB;QAE7B,KAAK,CAAC,IAAI,CAAC,EAAE;YACX,IAAI,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBACxB,IAAI,CAAC;oBACH,gDAAgD;oBAChD,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,KAAK,CAAC,oBAAoB,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC;oBACtE,IAAI,OAAO;wBAAE,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;oBAE3C,IAAI,UAAU,GAAG,MAAM,CAAC;oBAExB,kCAAkC;oBAClC,IAAI,MAAM,EAAE,CAAC;wBACX,UAAU,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;wBACnC,IAAI,OAAO;4BAAE,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,CAAC,CAAC;oBACrD,CAAC;oBAED,qCAAqC;oBACrC,OAAO,kBAAkB,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC;gBACzD,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,OAAO,CAAC,KAAK,CAAC,oBAAoB,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;oBAChD,MAAM,KAAK,CAAC;gBACd,CAAC;YACH,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC"}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@gjsify/vite-plugin-blueprint",
+  "version": "0.2.0",
+  "description": "Vite plugin for compiling Gnome Blueprint files",
+  "main": "dist/index.js",
+  "type": "module",
+  "scripts": {
+    "test": "echo \"Warning: no test specified\" && exit 0",
+    "clear": "rm -rf dist",
+    "check": "tsc --noEmit",
+    "build": "tsc --declaration"
+  },
+  "author": "Pascal Garber <pascal@mailfreun.de>",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^24.3.0",
+    "typescript": "^5.9.2",
+    "vite": "^7.1.2"
+  },
+  "peerDependencies": {
+    "vite": "*"
+  },
+  "dependencies": {
+    "execa": "^9.6.0",
+    "minify-xml": "^4.5.2"
+  }
+}

package/src/index.ts

@@ -0,0 +1,42 @@
+import { type Plugin } from "vite";
+import { execa } from "execa";
+import minifyXML from "minify-xml";
+
+export interface BlueprintPluginOptions {
+  minify?: boolean;
+  verbose?: boolean;
+}
+
+export default function blueprintPlugin(
+  options: BlueprintPluginOptions = {}
+): Plugin {
+  const { minify = false, verbose = false } = options;
+
+  return {
+    name: "vite-plugin-blueprint",
+
+    async load(id) {
+      if (id.endsWith(".blp")) {
+        try {
+          // Compile .blp file and get XML output directly
+          const { stdout } = await execa("blueprint-compiler", ["compile", id]);
+          if (verbose) console.log(`Compiled ${id}`);
+
+          let xmlContent = stdout;
+
+          // Minify XML if option is enabled
+          if (minify) {
+            xmlContent = minifyXML(xmlContent);
+            if (verbose) console.log(`Minified XML for ${id}`);
+          }
+
+          // Return the XML content as a string
+          return `export default ${JSON.stringify(xmlContent)};`;
+        } catch (error) {
+          console.error(`Error processing ${id}:`, error);
+          throw error;
+        }
+      }
+    },
+  };
+}

package/src/type.d.ts

@@ -0,0 +1,4 @@
+declare module "*.blp" {
+  const content: string;
+  export default content;
+}

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "preserveWatchOutput": true,
+    "lib": ["ESNext"],
+    "types": ["node"],
+    "outDir": "./dist",
+    "module": "NodeNext",
+    "target": "ESNext",
+    "moduleResolution": "NodeNext",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "declaration": true,
+    "sourceMap": true,
+    "diagnostics": true,
+    "verbatimModuleSyntax": true,
+    "isolatedModules": true
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["node_modules", "dist"]
+}