@vuecast/astro-module 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,88 @@
+# @vuecast/astro-module
+
+Write Vue Single File Components (`.vue` files) in your Astro projects.
+
+## Features
+
+- Use `.vue` files as pages in your Astro project
+- Full Vue SFC support with all Vue features
+- Seamless integration with Astro's build system
+- Ensures proper head rendering support
+
+## Prerequisites
+
+First, scaffold a new Astro project:
+
+```bash
+npm create astro@latest
+```
+
+Install the official Astro Vue integration:
+
+```bash
+npx astro add vue
+```
+
+## Installation
+
+```bash
+pnpm add @vuecast/astro-module
+# or
+npm install @vuecast/astro-module
+# or
+yarn add @vuecast/astro-module
+```
+
+## Usage
+
+1. Add the integration to your `astro.config.mjs`. Note that `@vuecast/astro-module` must be added after the Vue integration:
+
+```js
+import { defineConfig } from "astro/config";
+import vue from "@astrojs/vue";
+import vuecast from "@vuecast/astro-module";
+
+export default defineConfig({
+  integrations: [
+    vue(), // Vue integration must come first
+    vuecast(), // Then add VueCast
+  ],
+});
+```
+
+2. Create `.vue` files in your `src/pages` directory:
+
+```vue
+<!-- src/pages/index.vue -->
+<script setup lang="ts">
+const fruits = ["apples", "oranges", "bananas", "cherries", "grapes"];
+</script>
+
+<template>
+  <div>
+    <h1>Hello from VueCast!</h1>
+    <ul>
+      <li v-for="(fruit, index) in fruits" :key="index">
+        {{ index + 1 }}: {{ fruit }}
+      </li>
+    </ul>
+  </div>
+</template>
+
+<style scoped>
+/* Your component styles here */
+</style>
+```
+
+## How it Works
+
+The integration:
+
+1. Registers `.vue` as a valid page extension in Astro
+2. Sets up the Vue renderer for processing `.vue` files
+3. Ensures proper head rendering support for Vue components
+4. Integrates with Astro's build system through Vite
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,8 @@
+import { AstroIntegration } from 'astro';
+
+interface VuecastAstroPluginOptions {
+}
+
+declare function vuecastAstroIntegration(options: VuecastAstroPluginOptions): AstroIntegration;
+
+export { vuecastAstroIntegration as VuecastAstro, vuecastAstroIntegration as default };

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import { AstroIntegration } from 'astro';
+
+interface VuecastAstroPluginOptions {
+}
+
+declare function vuecastAstroIntegration(options: VuecastAstroPluginOptions): AstroIntegration;
+
+export { vuecastAstroIntegration as VuecastAstro, vuecastAstroIntegration as default };

package/dist/index.mjs

@@ -0,0 +1,32 @@
+function vuecastAstroIntegration(options) {
+  return {
+    name: "@vuecast/astro",
+    hooks: {
+      "astro:config:setup": async (params) => {
+        const { updateConfig, addPageExtension, addRenderer } = params;
+        addRenderer({
+          name: "vuecast:astro",
+          serverEntrypoint: "./node_modules/@astrojs/vue/dist/server.js"
+        });
+        addPageExtension(".vue");
+        updateConfig({
+          vite: {
+            plugins: [{
+              name: "vuecast-post",
+              async transform(code, id) {
+                if (!id.endsWith(".vue"))
+                  return;
+                const regex = /(\]\))(;?\n?)$/;
+                const replacement = ",[Symbol.for('astro.needsHeadRendering'),true]$1";
+                code = code.replace(regex, replacement);
+                return code;
+              }
+            }]
+          }
+        });
+      }
+    }
+  };
+}
+
+export { vuecastAstroIntegration as VuecastAstro, vuecastAstroIntegration as default };

package/package.json

@@ -1,12 +1,37 @@
 {
   "name": "@vuecast/astro-module",
-  "version": "1.0.0",
-  "main": "index.js",
+  "version": "1.0.1",
+  "type": "module",
+  "description": "Astro integration for Vue SFC pages",
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "unbuild",
+    "publish-beta": "npm run build && npm run increment-beta-version && npm publish --tag beta",
+    "increment-beta-version": "npm version prerelease --preid=beta",
+    "publish-patch": "npm run build && npm run increment-version && npm publish",
+    "increment-version": "npm version patch"
   },
-  "keywords": [],
+  "keywords": [
+    "vue",
+    "astro",
+    "sfc",
+    "meta-framework"
+  ],
   "author": "",
-  "license": "ISC",
-  "description": ""
-}
+  "license": "MIT",
+  "devDependencies": {
+    "unbuild": "^2.0.0"
+  }
+}

package/index.js

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