@pikacss/nuxt-pikacss 0.0.46 → 0.0.48

package/README.md

@@ -0,0 +1,26 @@
+# @pikacss/nuxt-pikacss
+
+Nuxt module for PikaCSS. Automatically registers the Vite plugin and imports generated CSS.
+
+## Installation
+
+```bash
+pnpm add -D @pikacss/nuxt-pikacss
+```
+
+## Usage
+
+```ts
+// nuxt.config.ts
+export default defineNuxtConfig({
+  modules: ['@pikacss/nuxt-pikacss'],
+})
+```
+
+## Documentation
+
+See the [full documentation](https://pikacss.com/guide/integrations/nuxt).
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -3,13 +3,52 @@ import { NuxtModule } from "@nuxt/schema";
 export * from "@pikacss/unplugin-pikacss/vite";
 
 //#region src/index.d.ts
+/**
+ * Configuration options for the PikaCSS Nuxt module.
+ *
+ * @remarks
+ * Mirrors the unplugin `PluginOptions` with `currentPackageName` omitted because
+ * the Nuxt module supplies it automatically.
+ *
+ * @example
+ * ```ts
+ * // nuxt.config.ts
+ * export default defineNuxtConfig({
+ *   modules: ['@pikacss/nuxt-pikacss'],
+ *   pikacss: {
+ *     config: './pika.config.ts',
+ *     scan: { include: ['**\/*.vue'] },
+ *   },
+ * })
+ * ```
+ */
 type ModuleOptions = Omit<PluginOptions, 'currentPackageName'>;
+/**
+ * PikaCSS Nuxt module.
+ *
+ * Integrates PikaCSS into a Nuxt application by registering a Vite plugin
+ * (with `enforce: 'pre'`) and a Nuxt plugin template that imports the
+ * generated `pika.css` stylesheet.
+ *
+ * Configure options under the `pikacss` key in `nuxt.config`. When no
+ * options are provided, the module scans `**\/*.{js,ts,jsx,tsx,vue}` by default.
+ */
 declare const _default: NuxtModule<ModuleOptions>;
 declare module '@nuxt/schema' {
   interface NuxtConfig {
+    /**
+     * PikaCSS module options used during Nuxt configuration merging.
+     *
+     * @default `undefined`
+     */
     pikacss?: ModuleOptions;
   }
   interface NuxtOptions {
+    /**
+     * Resolved PikaCSS module options available at runtime on `nuxt.options`.
+     *
+     * @default `undefined`
+     */
     pikacss?: ModuleOptions;
   }
 }

package/dist/index.mjs

@@ -1,9 +1,17 @@
 import { addPluginTemplate, addVitePlugin, defineNuxtModule } from "@nuxt/kit";
 import PikaCSSVitePlugin from "@pikacss/unplugin-pikacss/vite";
-
-export * from "@pikacss/unplugin-pikacss/vite"
-
+export * from "@pikacss/unplugin-pikacss/vite";
 //#region src/index.ts
+/**
+* PikaCSS Nuxt module.
+*
+* Integrates PikaCSS into a Nuxt application by registering a Vite plugin
+* (with `enforce: 'pre'`) and a Nuxt plugin template that imports the
+* generated `pika.css` stylesheet.
+*
+* Configure options under the `pikacss` key in `nuxt.config`. When no
+* options are provided, the module scans `**\/*.{js,ts,jsx,tsx,vue}` by default.
+*/
 var src_default = defineNuxtModule({
 	meta: {
 		name: "pikacss",
@@ -19,16 +27,11 @@ var src_default = defineNuxtModule({
 		addVitePlugin({
 			...PikaCSSVitePlugin({
 				currentPackageName: "@pikacss/nuxt-pikacss",
-				...nuxt.options.pikacss || { scan: { include: [
-					"**/*.vue",
-					"**/*.tsx",
-					"**/*.jsx"
-				] } }
+				...nuxt.options.pikacss || { scan: { include: ["**/*.{js,ts,jsx,tsx,vue}"] } }
 			}),
 			enforce: "pre"
 		});
 	}
 });
-
 //#endregion
-export { src_default as default };
+export { src_default as default };

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@pikacss/nuxt-pikacss",
   "type": "module",
-  "version": "0.0.46",
+  "version": "0.0.48",
   "author": "DevilTea <ch19980814@gmail.com>",
   "license": "MIT",
+  "homepage": "https://pikacss.com",
   "repository": {
     "type": "git",
-    "url": "https://github.com/pikacss/pikacss.git",
-    "directory": "packages/nuxt-pikacss"
+    "url": "git+https://github.com/pikacss/pikacss.git",
+    "directory": "packages/nuxt"
   },
   "bugs": {
     "url": "https://github.com/pikacss/pikacss/issues"
@@ -36,21 +37,28 @@
   "files": [
     "dist"
   ],
+  "engines": {
+    "node": ">=22"
+  },
+  "peerDependencies": {
+    "@nuxt/kit": "^4.4.2",
+    "@nuxt/schema": "^4.4.2"
+  },
   "dependencies": {
-    "@nuxt/kit": "^4.3.1",
     "pathe": "^2.0.3",
-    "@pikacss/unplugin-pikacss": "0.0.46"
+    "@pikacss/unplugin-pikacss": "0.0.48"
   },
   "devDependencies": {
-    "@nuxt/schema": "^4.3.1"
+    "@nuxt/kit": "^4.4.2",
+    "@nuxt/schema": "^4.4.2"
   },
   "scripts": {
-    "build": "tsdown && pnpm exec publint",
+    "build": "tsdown",
     "build:watch": "tsdown --watch",
     "typecheck": "pnpm typecheck:package && pnpm typecheck:test",
     "typecheck:package": "tsc --project ./tsconfig.package.json --noEmit",
     "typecheck:test": "tsc --project ./tsconfig.tests.json --noEmit",
-    "test": "vitest run",
-    "test:watch": "vitest"
+    "test": "vitest run --config ./vitest.config.ts",
+    "test:watch": "vitest --config ./vitest.config.ts"
   }
 }

package/src/index.ts

@@ -3,8 +3,37 @@ import type { PluginOptions } from '@pikacss/unplugin-pikacss/vite'
 import { addPluginTemplate, addVitePlugin, defineNuxtModule } from '@nuxt/kit'
 import PikaCSSVitePlugin from '@pikacss/unplugin-pikacss/vite'
 
+/**
+ * Configuration options for the PikaCSS Nuxt module.
+ *
+ * @remarks
+ * Mirrors the unplugin `PluginOptions` with `currentPackageName` omitted because
+ * the Nuxt module supplies it automatically.
+ *
+ * @example
+ * ```ts
+ * // nuxt.config.ts
+ * export default defineNuxtConfig({
+ *   modules: ['@pikacss/nuxt-pikacss'],
+ *   pikacss: {
+ *     config: './pika.config.ts',
+ *     scan: { include: ['**\/*.vue'] },
+ *   },
+ * })
+ * ```
+ */
 export type ModuleOptions = Omit<PluginOptions, 'currentPackageName'>
 
+/**
+ * PikaCSS Nuxt module.
+ *
+ * Integrates PikaCSS into a Nuxt application by registering a Vite plugin
+ * (with `enforce: 'pre'`) and a Nuxt plugin template that imports the
+ * generated `pika.css` stylesheet.
+ *
+ * Configure options under the `pikacss` key in `nuxt.config`. When no
+ * options are provided, the module scans `**\/*.{js,ts,jsx,tsx,vue}` by default.
+ */
 export default (defineNuxtModule<ModuleOptions>({
 	meta: {
 		name: 'pikacss',
@@ -24,7 +53,7 @@ export default (defineNuxtModule<ModuleOptions>({
 				...(
 					nuxt.options.pikacss || {
 						scan: {
-							include: ['**/*.vue', '**/*.tsx', '**/*.jsx'],
+							include: ['**/*.{js,ts,jsx,tsx,vue}'],
 						},
 					}
 				),
@@ -38,9 +67,19 @@ export * from '@pikacss/unplugin-pikacss/vite'
 
 declare module '@nuxt/schema' {
 	interface NuxtConfig {
+		/**
+		 * PikaCSS module options used during Nuxt configuration merging.
+		 *
+		 * @default `undefined`
+		 */
 		pikacss?: ModuleOptions
 	}
 	interface NuxtOptions {
+		/**
+		 * Resolved PikaCSS module options available at runtime on `nuxt.options`.
+		 *
+		 * @default `undefined`
+		 */
 		pikacss?: ModuleOptions
 	}
 }