@pikacss/nuxt-pikacss 0.0.39 → 0.0.40

package/README.md

@@ -13,12 +13,12 @@ pnpm add @pikacss/nuxt-pikacss
 **nuxt.config.ts**:
 ```typescript
 export default defineNuxtConfig({
-  modules: [
-    '@pikacss/nuxt-pikacss'
-  ],
-  pikacss: {
-    // options
-  }
+	modules: [
+		'@pikacss/nuxt-pikacss'
+	],
+	pikacss: {
+		// options
+	}
 })
 ```
 
@@ -39,9 +39,9 @@ The module works out of the box with zero configuration:
 ```typescript
 // nuxt.config.ts
 export default defineNuxtConfig({
-  modules: [
-    '@pikacss/nuxt-pikacss'
-  ]
+	modules: [
+		'@pikacss/nuxt-pikacss'
+	]
 })
 ```
 
@@ -52,40 +52,43 @@ You can customize PikaCSS through the `pikacss` option:
 ```typescript
 // nuxt.config.ts
 export default defineNuxtConfig({
-  modules: [
-    '@pikacss/nuxt-pikacss'
-  ],
-  pikacss: {
-    // File scanning configuration
-    scan: {
-      include: ['**/*.vue', '**/*.tsx', '**/*.jsx'],
-      exclude: ['node_modules/**']
-    },
-    
-    // Engine configuration or config file path
-    config: './pika.config.ts',
-    
-    // Auto-create config file if missing
-    autoCreateConfig: true,
-    
-    // PikaCSS function name (globally available in Nuxt)
-    fnName: 'pika',
-    
-    // Output format for class names
-    transformedFormat: 'string', // 'string' | 'array' | 'inline'
-    
-    // TypeScript code generation
-    tsCodegen: true, // or specify a path: 'src/pika.gen.ts'
-    
-    // CSS code generation
-    cssCodegen: true // or specify a path: 'src/pika.gen.css'
-  }
+	modules: [
+		'@pikacss/nuxt-pikacss'
+	],
+	pikacss: {
+		// File scanning configuration
+		scan: {
+			include: ['**/*.vue', '**/*.tsx', '**/*.jsx'], // Default patterns for Nuxt
+			exclude: ['node_modules/**', 'dist/**'] // Default: node_modules and dist
+		},
+
+		// Engine configuration or config file path
+		config: './pika.config.ts', // or inline EngineConfig object
+
+		// Auto-create config file if missing
+		autoCreateConfig: true, // Default: true
+
+		// PikaCSS function name (globally available in Nuxt)
+		fnName: 'pika', // Default: 'pika'
+
+		// Output format for class names
+		transformedFormat: 'string', // 'string' | 'array' | 'inline' (default: 'string')
+
+		// TypeScript code generation
+		tsCodegen: true, // true (auto path) | false | custom path string
+
+		// CSS code generation (always enabled, cannot be false)
+		cssCodegen: true // true (auto path) | custom path string
+	}
 })
 ```
 
-::: tip
-The `pika()` function is globally available in Nuxt components - no import needed!
-:::
+### Automatic Features
+
+The Nuxt module provides zero-config setup with automatic:
+- **CSS Injection**: Virtual `pika.css` module is auto-imported - no manual import needed
+- **Vue Scanning**: Automatically scans `.vue`, `.tsx`, `.jsx` files
+- **Global Function**: `pika()` is globally available in all components
 
 ### Using in Components
 
@@ -97,9 +100,9 @@ The module automatically imports the virtual `pika.css` module and makes `pika()
 
 // Style object
 const styles = pika({
-  display: 'flex',
-  alignItems: 'center',
-  gap: '1rem'
+	display: 'flex',
+	alignItems: 'center',
+	gap: '1rem'
 })
 
 // Using shortcuts
@@ -107,21 +110,55 @@ const centered = pika('flex-center')
 
 // Combining shortcuts with styles
 const button = pika('btn', {
-  backgroundColor: '#3b82f6',
-  color: 'white'
+	backgroundColor: '#3b82f6',
+	color: 'white'
 })
 </script>
 
 <template>
-  <div :class="styles">
-    <button :class="button">Click me</button>
-  </div>
+	<div :class="styles">
+		<button :class="button">
+			Click me
+		</button>
+	</div>
 </template>
 ```
 
 ## Options
 
-All options from `@pikacss/unplugin-pikacss` are supported. See the [unplugin documentation](../unplugin/README.md) for details.
+The module accepts all options from `@pikacss/unplugin-pikacss` (except `currentPackageName` which is set automatically).
+
+### PluginOptions Interface
+
+```typescript
+interface ModuleOptions {
+	scan?: {
+		include?: string | string[] // Default: ['**/*.vue', '**/*.tsx', '**/*.jsx']
+		exclude?: string | string[] // Default: ['node_modules/**', 'dist/**']
+	}
+	config?: EngineConfig | string // Config object or path (default: auto-detect)
+	autoCreateConfig?: boolean // Default: true
+	fnName?: string // Default: 'pika'
+	transformedFormat?: 'string' | 'array' | 'inline' // Default: 'string'
+	tsCodegen?: boolean | string // Default: true (auto-generate pika.gen.ts)
+	cssCodegen?: true | string // Default: true (auto-generate pika.gen.css)
+}
+```
+
+### Option Details
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `scan.include` | `string \| string[]` | `['**/*.vue', '**/*.tsx', '**/*.jsx']` | File patterns to scan for `pika()` calls |
+| `scan.exclude` | `string \| string[]` | `['node_modules/**', 'dist/**']` | File patterns to exclude from scanning |
+| `config` | `EngineConfig \| string` | Auto-detect | Engine config object or path to config file |
+| `autoCreateConfig` | `boolean` | `true` | Auto-create config file if missing |
+| `fnName` | `string` | `'pika'` | Function name to detect in code |
+| `transformedFormat` | `'string' \| 'array' \| 'inline'` | `'string'` | Output format for generated class names |
+| `tsCodegen` | `boolean \| string` | `true` | Generate TypeScript types (true = auto path, false = disabled, string = custom path) |
+| `cssCodegen` | `true \| string` | `true` | Generate CSS output (true = auto path, string = custom path) |
+
+See the [@pikacss/unplugin-pikacss documentation](https://github.com/pikacss/pikacss/tree/main/packages/unplugin) for complete details.
 
 ## PikaCSS Configuration
 
@@ -131,7 +168,7 @@ Create a `pika.config.ts` file in your project root:
 import { defineEngineConfig } from '@pikacss/core'
 
 export default defineEngineConfig({
-  // Your PikaCSS configuration
+	// Your PikaCSS configuration
 })
 ```
 

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@pikacss/nuxt-pikacss",
   "type": "module",
-  "version": "0.0.39",
+  "version": "0.0.40",
   "author": "DevilTea <ch19980814@gmail.com>",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/pikacss/pikacss.git",
+    "url": "https://github.com/pikacss/pikacss.github.io.git",
     "directory": "packages/nuxt-pikacss"
   },
   "bugs": {
-    "url": "https://github.com/pikacss/pikacss/issues"
+    "url": "https://github.com/pikacss/pikacss.github.io/issues"
   },
   "keywords": [
     "pikacss",
@@ -43,7 +43,7 @@
   "dependencies": {
     "@nuxt/kit": "^4.2.2",
     "pathe": "^2.0.3",
-    "@pikacss/unplugin-pikacss": "0.0.39"
+    "@pikacss/unplugin-pikacss": "0.0.40"
   },
   "devDependencies": {
     "@nuxt/schema": "^4.2.2"