chore: update the readme

README.md

@@ -1,32 +1,14 @@
-<!--
-Get your module up and running quickly.
-
-Find and replace all on all files (CMD+SHIFT+F):
-- Name: Varlet Module
-- Package name: Varlet Module
-- Description: Varlet Module
--->
-
-# Varlet Nuxt (WIP)
+# Varlet Nuxt
 
 Welcome to contribute this repo
 
-<!-- [![npm version][npm-version-src]][npm-version-href]
-[![npm downloads][npm-downloads-src]][npm-downloads-href]
-[![License][license-src]][license-href]
-[![Nuxt][nuxt-src]][nuxt-href] -->
-
 Varlet Module for Nuxt3
 
-<!-- - [✨ &nbsp;Release Notes](/CHANGELOG.md) -->
-<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/my-module?file=playground%2Fapp.vue) -->
-<!-- - [📖 &nbsp;Documentation](https://example.com) -->
-
 ## Features
 
-<!-- Highlight some of the features your module provide here -->
-- Automatically import directives.
-- Automatically import of showDialog, showToast and other methods components.
+- Make up the Lazy Option
+- Component Demo for Playground
+- Template for Nuxt3
 
 
 ## Quick Setup
@@ -57,7 +39,7 @@ export default defineNuxtConfig({
 })
 ```
 
-That's it! You can now use My Module in your Nuxt app ✨
+That's it! You can now use Varlet Module in your Nuxt app ✨
 
 ## Development
 
@@ -84,16 +66,3 @@ npm run test:watch
 # Release new version
 npm run release
 ```
-
-<!-- Badges -->
-<!-- [npm-version-src]: https://img.shields.io/npm/v/my-module/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
-[npm-version-href]: https://npmjs.com/package/my-module
-
-[npm-downloads-src]: https://img.shields.io/npm/dm/my-module.svg?style=flat&colorA=18181B&colorB=28CF8D
-[npm-downloads-href]: https://npmjs.com/package/my-module
-
-[license-src]: https://img.shields.io/npm/l/my-module.svg?style=flat&colorA=18181B&colorB=28CF8D
-[license-href]: https://npmjs.com/package/my-module
-
-[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
-[nuxt-href]: https://nuxt.com -->

playground/app.vue

@@ -10,14 +10,20 @@ const show = ref(false)
 </script>
 
 <template>
-  <var-button type="primary" block @click="show = !show">基本使用</var-button>
-  <var-snackbar v-model:show="show">
-    这是一个消息条！！
-  </var-snackbar>
-  <div v-ripple class="ripple-example-block">点击</div>
-  <var-skeleton :loading="show">
-    加载的数据
-  </var-skeleton>
+  <div>
+    <var-button type="primary" block @click="show = !show">
+      基本使用
+    </var-button>
+    <var-snackbar v-model:show="show">
+      这是一个消息条！！
+    </var-snackbar>
+    <div v-ripple class="ripple-example-block">
+      点击
+    </div>
+    <var-skeleton :loading="show">
+      加载的数据
+    </var-skeleton>
+  </div>
 </template>
 
 <style>
@@ -32,4 +38,4 @@ const show = ref(false)
   -webkit-tap-highlight-color: rgba(0, 0, 0, 0);
   transition: background-color 0.25s;
 }
-</style>
+</style>

src/core/components.ts

@@ -4,7 +4,7 @@ import { kebabCase } from '@varlet/shared'
 import { moduleName, functionComponents } from '../config'
 import { ModuleOptions } from '../types'
 
-export function resolveComponents(config: ModuleOptions) {
+export function resolveComponents (config: ModuleOptions) {
   const { components } = config
 
   components.forEach((item) => {
@@ -23,7 +23,7 @@ export function resolveComponents(config: ModuleOptions) {
   })
 }
 
-export function resolveStyles(config: ModuleOptions, name: string) {
+export function resolveStyles (config: ModuleOptions, name: string) {
   const { components } = config
 
   if (functionComponents.includes(name)) {

src/core/directives.ts

@@ -2,7 +2,7 @@ import { kebabCase } from '@varlet/shared'
 import { moduleName } from '../config'
 import type { ModuleOptions } from '../types'
 
-export function resolveDirectives(
+export function resolveDirectives (
   config: ModuleOptions,
   name: string
 ): undefined | [name: string, styles?: string] {

src/core/imports.ts

@@ -3,7 +3,7 @@ import { addImportsSources } from '@nuxt/kit'
 import { moduleName } from '../config'
 import type { ModuleOptions } from '../types'
 
-export function resolveImports(config: ModuleOptions) {
+export function resolveImports (config: ModuleOptions) {
   const { imports } = config
 
   addImportsSources({

src/core/options.ts

@@ -1,7 +1,7 @@
 import { useNuxt } from '@nuxt/kit'
 import { moduleName } from '../config'
 
-export function resolveOptions() {
+export function resolveOptions () {
   const nuxt = useNuxt()
 
   nuxt.options.build.transpile.push(moduleName)

src/core/transformPlugin.ts

@@ -24,15 +24,15 @@ export const transformPlugin = createUnplugin((options: PluginOptions) => {
   return {
     name: `${moduleName}:transform`,
     enforce: 'post',
-    transformInclude(id) {
+    transformInclude (id) {
       if (exclude.some(pattern => id.match(pattern))) {
         return false
       }
       if (include.some(pattern => id.match(pattern))) {
         return true
       }
     },
-    transform(code, id) {
+    transform (code, id) {
       const imports = new Set<string>()
       const directives: PresetImport[] = []
       const s = new MagicString(code)

src/gen.ts

@@ -1,11 +1,11 @@
 import { moduleName } from './config'
 import { PresetImport } from './types'
 
-export function genSideEffectsImport(value: string): string {
+export function genSideEffectsImport (value: string): string {
   return `import '${value}';`
 }
 
-export function genLibraryImport(list: PresetImport[]): string {
+export function genLibraryImport (list: PresetImport[]): string {
   const values = list.map((item) => {
     if (Array.isArray(item)) {
       const [name, as] = item

src/module.ts

@@ -10,7 +10,7 @@ export default defineNuxtModule<ModuleOptions>({
     configKey: moduleName
   },
   defaults,
-  setup(_options: ModuleOptions, nuxt) {
+  setup (_options: ModuleOptions, nuxt) {
     const _configs = _options
     resolveOptions()