feat: extension readme

packages/extensions/autocomplete/README.md

@@ -37,10 +37,6 @@ const editorView = new EditorView({
 
 ## API
 
-```
-
-```
-
 ```ts
 // DefaultCompletionConfig configs please refer to: https://codemirror.net/docs/ref/#autocomplete.autocompletion
 

packages/extensions/basic-setup/README.md

@@ -11,7 +11,7 @@ npm install @tidbcloud/codemirror-extension-basic-setup
 You need to install its peer dependencies as well:
 
 ```shell
-npm install @codemirror/autocomplete @codemirror/commands @codemirror/lang-sql @codemirror/language  @codemirror/lint @codemirror/search @codemirror/state @codemirror/view  @codemirror/highlight
+npm install @codemirror/autocomplete @codemirror/commands @codemirror/lang-sql @codemirror/language  @codemirror/lint @codemirror/search @codemirror/state @codemirror/view  @lezer/highlight
 ```
 
 ## Usage
@@ -24,11 +24,6 @@ import {
   basicSetup
 } from '@tidbcloud/codemirror-extension-basic-setup'
 
-interface basicSetupOptions {
-  title?: string
-  message?: string
-}
-
 const editorView = new EditorView({
   state: EditorState.create({
     doc,

packages/extensions/events/README.md

@@ -1,6 +1,6 @@
 # @tidbcloud/codemirror-extension-events
 
-Events Extensions for CodeMirror6. This extension provides 3 default events: onChange, onFocusChange and onSelectionChange.
+Events extensions for CodeMirror6. This extension provides 3 default events: onChange, onFocusChange and onSelectionChange.
 
 ## Installation
 
@@ -11,7 +11,7 @@ npm install @tidbcloud/codemirror-extension-events
 You need to install its peer dependencies as well:
 
 ```shell
-npm install @codemirror/view @codemirror/view
+npm install @codemirror/view @codemirror/state
 ```
 
 ## Usage

packages/extensions/linters/README.md

@@ -1,6 +1,6 @@
 # @tidbcloud/codemirror-extension-linters
 
-This extension provide 3 linters:
+This extension provides 3 linters:
 
 - fullWidthCharLinter: lint all the chinese characters
 - useDbLinter: use statement linter, the first statement should be use dbName;
@@ -23,7 +23,7 @@ npm install @codemirror/view @codemirror/state @codemirror/lint
 ```ts
 import { EditorView } from '@codemirror/view'
 import { EditorState } from '@codemirror/state'
-import { autoCompletion } from '@tidbcloud/codemirror-extension-linters'
+import { fullWidthCharLinter } from '@tidbcloud/codemirror-extension-linters'
 
 interface charLinterConfig {
   title?: string
@@ -46,7 +46,7 @@ const editorView = new EditorView({
 ```ts
 import { EditorView } from '@codemirror/view'
 import { EditorState } from '@codemirror/state'
-import { autoCompletion } from '@tidbcloud/codemirror-extension-linters'
+import { useDbLinter } from '@tidbcloud/codemirror-extension-linters'
 
 type DBLinterOptions = {
   level?: 'error' | 'warning'
@@ -72,7 +72,7 @@ const editorView = new EditorView({
 ```ts
 import { EditorView } from '@codemirror/view'
 import { EditorState } from '@codemirror/state'
-import { autoCompletion } from '@tidbcloud/codemirror-extension-linters'
+import { regexMatchLinter } from '@tidbcloud/codemirror-extension-linters'
 
 interface RegexpItem {
   reg: RegExp