chore: update readme

zjxxxxxxxxx · Sep 22, 2023 · 0b43bfb · 0b43bfb
1 parent 7fced3c
commit 0b43bfb
Show file tree

Hide file tree

Showing 5 changed files with 61 additions and 43 deletions.
diff --git a/.changeset/tender-elephants-guess.md b/.changeset/tender-elephants-guess.md
@@ -2,4 +2,4 @@
 '@open-editor/shared': patch
 ---
 
-add type uilt 'isBol'
+add type util 'isBol'
diff --git a/packages/client/src/resolve/createVueResolver.ts b/packages/client/src/resolve/createVueResolver.ts
@@ -129,16 +129,16 @@ function parseVueSource(__source: string) {
 }
 
 let cacheIsVueSource: boolean | undefined;
-function isVueSource(element: HTMLElement) {
+function isVueSource(element?: HTMLElement | null) {
   if (isBol(cacheIsVueSource)) {
     return cacheIsVueSource;
   }
 
   while (element) {
-    if (getElementVueSource(element) != null) {
+    if (getElementVueSource(element)) {
       return (cacheIsVueSource = true);
     }
-    element = element.parentElement!;
+    element = element.parentElement;
   }
 
   return (cacheIsVueSource = false);

diff --git a/packages/rollup/README.md b/packages/rollup/README.md
@@ -29,19 +29,25 @@ export default defineConfig({
 });
 ```
 
-## Configuration
-
-The following show the default values of the configuration
+## Options
 
 ```ts
-OpenEditor({
-  // source root path
-  rootDir: process.cwd(),
-
-  // render the toggle into the browser
-  displayToggle: false,
-
-  // custom openEditor handler
-  onOpenEditor: undefined,
-});
+interface Options {
+  /**
+   * source rootDir path
+   *
+   * @default process.cwd()
+   */
+  rootDir?: string;
+  /**
+   * render the toggle into the browser
+   *
+   * @default false
+   */
+  displayToggle?: boolean;
+  /**
+   * custom openEditor handler
+   */
+  onOpenEditor?(file: string): void;
+}
 ```
diff --git a/packages/vite/README.md b/packages/vite/README.md
@@ -29,19 +29,25 @@ export default defineConfig({
 });
 ```
 
-## Configuration
-
-The following show the default values of the configuration
+## Options
 
 ```ts
-OpenEditor({
-  // source root path
-  rootDir: process.cwd(),
-
-  // render the toggle into the browser
-  displayToggle: false,
-
-  // custom openEditor handler
-  onOpenEditor: undefined,
-});
+interface Options {
+  /**
+   * source rootDir path
+   *
+   * @default process.cwd()
+   */
+  rootDir?: string;
+  /**
+   * render the toggle into the browser
+   *
+   * @default false
+   */
+  displayToggle?: boolean;
+  /**
+   * custom openEditor handler
+   */
+  onOpenEditor?(file: string): void;
+}
 ```
diff --git a/packages/webpack/README.md b/packages/webpack/README.md
@@ -29,19 +29,25 @@ module.exports = {
 };
 ```
 
-## Configuration
-
-The following show the default values of the configuration
+## Options
 
 ```ts
-OpenEditor({
-  // source root path
-  rootDir: process.cwd(),
-
-  // render the toggle into the browser
-  displayToggle: false,
-
-  // custom openEditor handler
-  onOpenEditor: undefined,
-});
+interface Options {
+  /**
+   * source rootDir path
+   *
+   * @default process.cwd()
+   */
+  rootDir?: string;
+  /**
+   * render the toggle into the browser
+   *
+   * @default false
+   */
+  displayToggle?: boolean;
+  /**
+   * custom openEditor handler
+   */
+  onOpenEditor?(file: string): void;
+}
 ```