Merge pull request #7 from tidbcloud/chore/extensions-linter

chore: add extension database-linter

packages/extensions/basic-setup/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tidbcloud/tisqleditor-extensions-basic-setup",
-  "version": "0.0.1",
+  "version": "1.0.0",
   "description": "tisqleditor extensions",
   "type": "module",
   "main": "dist/index.js",

packages/extensions/database-linter/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@tidbcloud/tisqleditor-extensions-database-linter",
+  "version": "1.0.0",
+  "description": "tisqleditor extensions",
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/*.js",
+    "dist/*.ts",
+    "package.json",
+    "README.md"
+  ],
+  "scripts": {
+    "tsc:watch": "tsc --watch",
+    "rollup:watch": "rollup -c --watch",
+    "dev": "concurrently --kill-others \"pnpm tsc:watch\" \"pnpm rollup:watch\"",
+    "build": "tsc && rollup -c"
+  },
+  "keywords": [
+    "tidbcloud",
+    "sql",
+    "editor",
+    "extensions",
+    "database linter"
+  ],
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "@codemirror/lint": "^6.8.0",
+    "@codemirror/state": "^6.4.1",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "rollup": "^4.18.0",
+    "tslib": "^2.6.3",
+    "typescript": "^5.4.5"
+  },
+  "peerDependencies": {
+    "@codemirror/lint": "^6.8.0",
+    "@codemirror/state": "^6.4.1",
+    "@codemirror/view": "^6.26.3"
+  },
+  "dependencies": {
+    "@tidbcloud/tisqleditor-extensions-sql-parser": "workspace:^",
+    "@tidbcloud/tisqleditor-extensions-grammer-linter": "workspace:^"
+  }
+}

packages/extensions/database-linter/src/index.ts

@@ -0,0 +1,47 @@
+import { linter, Diagnostic } from '@codemirror/lint'
+
+import { getSqlStatements } from '@tidbcloud/tisqleditor-extensions-sql-parser'
+import {
+  hintEle,
+  linterBaseTheme
+} from '@tidbcloud/tisqleditor-extensions-grammer-linter'
+
+export type DBLinterOptions = {
+  level?: 'error' | 'warning'
+  title?: string
+  message?: string
+  preCheck?: () => string
+}
+
+const databaseLinter = (config: DBLinterOptions) =>
+  linter((view) => {
+    const diagnostics: Diagnostic[] = []
+
+    if (config.preCheck && config.preCheck()) {
+      return diagnostics
+    }
+
+    getSqlStatements(view.state).forEach((statement) => {
+      if (statement.database === '' && statement.type !== 'ddl') {
+        diagnostics.push({
+          from: statement.from,
+          to: statement.to,
+          severity: config.level || 'warning',
+          message: '',
+          renderMessage: () => {
+            return hintEle(
+              config.title || '',
+              config.message ||
+                'No database selected by using `USE {database}` statement, this statement may run failed.'
+            )
+          }
+        })
+      }
+    })
+
+    return diagnostics
+  })
+
+export function dbLinter(config: DBLinterOptions) {
+  return [databaseLinter(config), linterBaseTheme]
+}

packages/extensions/grammer-check/tsconfig.json → packages/extensions/database-linter/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../tsconfig.json",
+  "extends": "../../tsconfig.json",
   "compilerOptions": {
     "outDir": "./dist"
   },

packages/extensions/grammer-check/package.json → packages/extensions/grammer-linter/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@tidbcloud/tisqleditor-extensions-grammer-check",
+  "name": "@tidbcloud/tisqleditor-extensions-grammer-linter",
   "version": "1.0.0",
   "description": "tisqleditor extensions",
   "type": "module",
@@ -23,7 +23,7 @@
     "sql",
     "editor",
     "extensions",
-    "grammer check"
+    "grammer linter"
   ],
   "author": "",
   "license": "MIT",

packages/extensions/grammer-linter/rollup.config.js

@@ -0,0 +1,10 @@
+import typescript from '@rollup/plugin-typescript'
+
+export default {
+  input: './src/index.ts',
+  output: {
+    dir: './dist',
+    format: 'es'
+  },
+  plugins: [typescript()]
+}

packages/extensions/grammer-check/src/index.ts → packages/extensions/grammer-linter/src/index.ts

@@ -2,7 +2,7 @@ import { linter, Diagnostic } from '@codemirror/lint'
 import { Extension } from '@codemirror/state'
 import { EditorView } from '@codemirror/view'
 
-export interface GrammerCheckConfig {
+export interface GrammerLinterConfig {
   title?: string
   content?: string
 }
@@ -13,7 +13,7 @@ export interface RegexpItem {
   message: string
 }
 
-const linterBaseTheme: Extension = EditorView.baseTheme({
+export const linterBaseTheme: Extension = EditorView.baseTheme({
   '.cm-tooltip-hover': {
     marginTop: '4px',
     borderRadius: '8px'
@@ -50,7 +50,7 @@ const linterBaseTheme: Extension = EditorView.baseTheme({
   }
 })
 
-const hintEle = (title?: string, content?: string) => {
+export const hintEle = (title?: string, content?: string) => {
   const ele = document.createDocumentFragment()
   const titleEle = document.createElement('div')
   titleEle.textContent = title ?? 'Invalid Character'
@@ -64,7 +64,7 @@ const hintEle = (title?: string, content?: string) => {
   return ele
 }
 
-const chineseCharacterCheckParser = (config: GrammerCheckConfig) => {
+const chineseCharacterCheckParser = (config: GrammerLinterConfig) => {
   return linter((view) => {
     const diagnostics: Diagnostic[] = []
     view.visibleRanges.forEach((range) => {
@@ -139,7 +139,7 @@ const regexMatchParser = (regs: RegexpItem[]) => {
   })
 }
 
-export const chineseCharacterLinter = (config: GrammerCheckConfig) => {
+export const chineseCharacterLinter = (config: GrammerLinterConfig) => {
   return [chineseCharacterCheckParser(config), linterBaseTheme]
 }
 

packages/extensions/grammer-linter/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist"
+  },
+  "include": ["./src"]
+}

packages/extensions/lang-sql/package.json

@@ -18,7 +18,13 @@
     "dev": "concurrently --kill-others \"pnpm tsc:watch\" \"pnpm rollup:watch\"",
     "build": "tsc && rollup -c"
   },
-  "keywords": [],
+  "keywords": [
+    "tidbcloud",
+    "sql",
+    "editor",
+    "extensions",
+    "lang sql"
+  ],
   "author": "",
   "license": "MIT",
   "devDependencies": {

packages/extensions/sql-parser/package.json

@@ -18,7 +18,13 @@
     "dev": "concurrently --kill-others \"pnpm tsc:watch\" \"pnpm rollup:watch\"",
     "build": "tsc && rollup -c"
   },
-  "keywords": [],
+  "keywords": [
+    "tidbcloud",
+    "sql",
+    "editor",
+    "extensions",
+    "sql parser"
+  ],
   "author": "",
   "license": "MIT",
   "devDependencies": {