diff --git a/packages/core/README.md b/packages/core/README.md index db79a91..7aec5d9 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -2,7 +2,7 @@ This package provides the `SQLEditorInstance` and `EditorCache` implementation. -`SQLEditorInstance` creates EditorView instance with pre-configured extensions to make it available to edit SQL code. +`SQLEditorInstance` creates EditorView instance with pre-configured extensions to make it available to edit SQL code, likes `@codemirror/lang-sql`, `@tidbcloud/codemirror-extension-sql-parser`, `@tidbcloud/codemirror-extension-cur-sql`. `EditorCache` stores the `SQLEditorInstance` in a map. diff --git a/packages/extensions/ai-widget/README.md b/packages/extensions/ai-widget/README.md index 4578c7f..8161cf4 100644 --- a/packages/extensions/ai-widget/README.md +++ b/packages/extensions/ai-widget/README.md @@ -1,6 +1,6 @@ # @tidbcloud/codemirror-extension-ai-widget -A codemirror extension provides a widget to chat with AI to help you write or refine SQL. (work with other languages wip) +A codemirror extension provides a widget to chat with AI to help you write or refine SQL. (will support to work with other languages later) https://github.com/tidbcloud/tisqleditor/assets/1284531/46684333-7efa-4925-bf58-9ab3fb45f692 @@ -22,10 +22,10 @@ https://github.com/tidbcloud/tisqleditor/assets/1284531/46684333-7efa-4925-bf58- npm install @tidbcloud/codemirror-extension-ai-widget ``` -You need to install its peer dependencies as well: +You need to install its dependencies as well: ```shell -npm install @codemirror/view @codemirror/state @codemirror/merge @codemirror/lang-sql +npm install @codemirror/view @codemirror/state @codemirror/merge @codemirror/lang-sql @tidbcloud/codemirror-extension-sql-parser @tidbcloud/codemirror-extension-cur-sql ``` ## Usage diff --git a/packages/extensions/cur-sql-gutter/README.md b/packages/extensions/cur-sql-gutter/README.md index dbab793..1654d47 100644 --- a/packages/extensions/cur-sql-gutter/README.md +++ b/packages/extensions/cur-sql-gutter/README.md @@ -13,10 +13,10 @@ A codemirror extension listens the editor selection change, and shows gutter for npm install @tidbcloud/codemirror-extension-cur-sql-gutter ``` -You need to install its peer dependencies as well: +You need to install its dependencies as well: ```shell -npm install @codemirror/view @codemirror/state @codemirror/lang-sql +npm install @codemirror/view @codemirror/state @codemirror/lang-sql @tidbcloud/codemirror-extension-sql-parser @tidbcloud/codemirror/extension-cur-sql ``` ## Usage diff --git a/packages/extensions/cur-sql/README.md b/packages/extensions/cur-sql/README.md index e72578c..099eaa0 100644 --- a/packages/extensions/cur-sql/README.md +++ b/packages/extensions/cur-sql/README.md @@ -10,12 +10,10 @@ This extension is installed internally inside the `SQLEditorInstance`. npm install @tidbcloud/codemirror-extension-cur-sql ``` -It will auto install `@tidbcloud/codemirror-extension-sql-parser` as its dependency. - -You need to install its peer dependencies as well: +You need to install its dependencies as well: ```shell -npm install @codemirror/view @codemirror/state @codemirror/language @codemirro/lang-sql +npm install @codemirror/view @codemirror/state @codemirror/language @codemirror/lang-sql @tidbcloud/codemirror-extension-sql-parser ``` ## Usage diff --git a/packages/extensions/linters/README.md b/packages/extensions/linters/README.md index 77c9171..83a6552 100644 --- a/packages/extensions/linters/README.md +++ b/packages/extensions/linters/README.md @@ -17,10 +17,10 @@ npm install @tidbcloud/codemirror-extension-linters ``` -You need to install its peer dependencies as well: +You need to install its dependencies as well: ```shell -npm install @codemirror/view @codemirror/state @codemirror/lint @codemirror/lang-sql +npm install @codemirror/view @codemirror/state @codemirror/lint @codemirror/lang-sql @tidbcloud/codemirror-extension-sql-parser ``` ## Usage diff --git a/packages/react/README.md b/packages/react/README.md index 2d2517f..9ea1511 100644 --- a/packages/react/README.md +++ b/packages/react/README.md @@ -110,4 +110,4 @@ export function OpenedFilesTabs() { - `doc`: editor initial content - `sqlConfig`: config for SQL dialect, schemas, tables - `theme`: editor theme, `@tidbcloud/codemirror-extensions-themes` provides 2 simple themes, `bbedit` for light mode, `oneDark` for dark mode, you can choose any other themes from third-party libraries or customize it by self -- `extraExts`: any other extra CodeMirror extensions you want to use, `@tidbcloud/tisqleditor-react` install some builtin extensions, likes `@tidbcloud/codemirror-extension-sql-parser`, `@tidbcloud/codemirror-extension-cur-sql` +- `extraExts`: any other extra CodeMirror extensions you want to use, `@tidbcloud/tisqleditor-react` install some builtin extensions, likes `@codemirror/lang-sql`, `@tidbcloud/codemirror-extension-sql-parser`, `@tidbcloud/codemirror-extension-cur-sql`