docs: add type explain code

Author: ThimoDEV

src/module.ts

@@ -1,4 +1,4 @@
-import { defineNuxtModule, addComponent, createResolver, addImports } from '@nuxt/kit'
+import { defineNuxtModule, addComponent, createResolver, addImports, extendViteConfig  } from '@nuxt/kit'
 
 // Module options TypeScript interface definition
 export interface ModuleOptions {}
@@ -24,11 +24,18 @@ export default defineNuxtModule<ModuleOptions>({
       from: resolve('./runtime/composables/useNuxtCodeMirror.ts'),
     })
 
-    _nuxt.hook('vite:extendConfig', (config) => {
+    // _nuxt.hook('vite:extendConfig', (config) => {
+    //   config.resolve = config.resolve || {}
+    //   config.resolve.alias = config.resolve.alias || {}
+
+    //   // @ts-expect-error - Add alias for @codemirror/view
+    //   config.resolve.alias['@codemirror/state'] = resolve(_nuxt.options.rootDir, 'node_modules/@codemirror/state')
+    // })
+    extendViteConfig((config) => {
       config.resolve = config.resolve || {}
       config.resolve.alias = config.resolve.alias || {}
 
-      // @ts-expect-error - Add alias for @codemirror/view
+      // @ts-expect-error - Add alias for @codemirror/state
       config.resolve.alias['@codemirror/state'] = resolve(_nuxt.options.rootDir, 'node_modules/@codemirror/state')
     })
   },

src/runtime/types/nuxt-codemirror.d.ts

@@ -79,6 +79,7 @@ export interface NuxtCodeMirrorProps
 }
 
 export interface UseCodeMirrorProps extends NuxtCodeMirrorProps {
+  /** Container element of the CodeMirror instance */
   container?: HTMLDivElement | null
   viewRef: Ref<EditorView | undefined>
   stateRef: Ref<EditorState | undefined>
@@ -116,8 +117,12 @@ export interface Statistics {
 }
 
 export interface CodeMirrorRef {
+  /** Container element of the CodeMirror instance */
   container: HTMLDivElement | null
+  /** The EditorView of the CodeMirror instance */
   view: EditorView | undefined
+  /** The EditorState of the CodeMirror instance */
   state: EditorState | undefined
+  /** Editor element of the CodeMirror instance */
   editor: HTMLDivElement | null
 }