Workspace configuration (#62)

* use onInitialize

* apply connection setting from workspace/configuration

* apply lint setting from workspace/configuration

* strip unexpected console.log from pg library

* fix failed test

* add test for configObject option

* Update README

* update package.json

Author: joe-re

.vscode/settings.json

@@ -9,5 +9,5 @@
 		"out": true
 	},
 	"typescript.tsdk": "./node_modules/typescript/lib",
-	"typescript.tsc.autoDetect": "off"
+	"typescript.tsc.autoDetect": "off",
 }

README.md

@@ -79,14 +79,13 @@ $ sql-language-server up [options]        run sql-language-server
 $ sql-language-server up --method stdio
 ```
 
-### Connect to database
-
-#### Using Configuration Files
+### Configuration
 
 There are two ways to use configuration files.
 
 - Set personal configuration file(~/.config/sql-language-server/.sqllsrc.json)
 - Set project configuration file on your project root(\${YOUR_PROJECT/.sqllsrc.json})
+- Use workspace/configuration according to LSP specification
 
 #### Example for personal configuration file
 
@@ -135,7 +134,7 @@ There are two ways to use configuration files.
 
 Please restart sql-language-server process after create .sqllsrc.json.
 
-#### Parameters
+#### Parameters of connections
 
 | Key          | Description                                                                                                               | value                   | required | default                           |
 | ------------ | ------------------------------------------------------------------------------------------------------------------------- | ----------------------- | -------- | --------------------------------- |
@@ -231,6 +230,101 @@ It will merge them as following:
 }
 ```
 
+#### workspace/configuration
+
+##### Parameters of workspace configuration
+
+- connections: It's the same as `connections` params of personal config file
+- lint: It's the same as configuration of [sqlint](https://github.com/joe-re/sql-language-server/tree/release/packages/sqlint#configuration).
+
+
+##### Example of workspace configuration
+
+- [coc.nvim](https://github.com/neoclide/coc.nvim)
+
+~/.config/nvim/coc-settings.json
+```json
+{
+  "languageserver": {
+    "sql": {
+      "command": "sql-language-server",
+      "args": ["up", "--method", "stdio"],
+      "filetypes": ["sql"],
+      "settings": {
+        "sqlLanguageServer": {
+          "connections": [
+            {
+              "name": "mysql_project",
+              "adapter": "mysql",
+              "host": "127.0.0.1",
+              "port": 3306,
+              "user": "sqlls",
+              "password": "sqlls",
+              "database": "mysql_db",
+              "projectPaths": ["/Users/joe_re/src/MysqlProject"],
+              "ssh": {
+                "user": "ubuntu",
+                "remoteHost": "xxx-xx-xxx-xxx-xxx.ap-southeast-1.compute.amazonaws.com",
+                "dbHost": "127.0.0.1",
+                "port": 3306
+              }
+            }
+          ],
+          "lint": {
+            "rules": {
+              "align-column-to-the-first": "error",
+              "column-new-line": "error",
+              "linebreak-after-clause-keyword": "off",
+              "reserved-word-case": ["error", "upper"],
+              "space-surrounding-operators": "error",
+              "where-clause-new-line": "error",
+              "align-where-clause-to-the-first": "error"
+            }
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+- vscode workspace setting
+
+```json
+"settings": {
+  "sqlLanguageServer.connections": [
+    {
+      "name": "mysql_project",
+      "adapter": "mysql",
+      "host": "127.0.0.1",
+      "port": 3306,
+      "user": "sqlls",
+      "password": "sqlls",
+      "database": "mysql_db",
+      "projectPaths": ["/Users/joe_re/src/MysqlProject"],
+      "ssh": {
+        "user": "ubuntu",
+        "remoteHost": "xxx-xx-xxx-xxx-xxx.ap-southeast-1.compute.amazonaws.com",
+        "dbHost": "127.0.0.1",
+        "port": 3306
+      }
+    }
+  ],
+  "sqlLanguageServer.lint": {
+    "rules": {
+      "align-column-to-the-first": "off",
+      "column-new-line": "error",
+      "linebreak-after-clause-keyword": "error",
+      "reserved-word-case": ["error", "upper"],
+      "space-surrounding-operators": "error",
+      "where-clause-new-line": "error",
+      "align-where-clause-to-the-first": "error",
+    }
+  }
+}
+```
+
+
 #### Inject envitonment variables
 
 ${env:VARIABLE_NAME} syntax allows you to replace configuration value with enviroment variable.

example/monaco_editor/src/client/App.svelte

@@ -2,14 +2,15 @@
   import {
     executeSwitchDatabaseCommand,
     executeFixAllFixableProblemsCommand,
+    executeWorkspaceConfig,
     getConnectionList,
-    getCurrecntConnection
+    getCurrecntConnection,
   } from './client'
 
   const commands = [
     { id: 'fixAllFixableProblems', text: 'fixAllFixableProblems' },
-    // TODO
     { id: 'switchDatabaseConnection', text: 'switchDatabaseConnection' },
+    { id: 'workspace/configuration', text: 'workspace/configuration' },
   ]
 
   let command = commands[0]
@@ -19,6 +20,8 @@
       executeFixAllFixableProblemsCommand()
     } else if (command.id === 'switchDatabaseConnection') {
       executeSwitchDatabaseCommand(connection)
+    } else if (command.id === 'workspace/configuration') {
+      executeWorkspaceConfig(connection)
     }
   }
 

example/monaco_editor/src/client/client.ts

@@ -99,7 +99,7 @@ export function executeFixAllFixableProblemsCommand() {
   const params: ExecuteCommandParams = {
     command: 'fixAllFixableProblems',
     arguments: ['inmemory://model.sql']
-  }
+}
   languageClient.sendRequest('workspace/executeCommand', params)
 }
 
@@ -111,6 +111,14 @@ export function executeSwitchDatabaseCommand(db: string) {
   languageClient.sendRequest('workspace/executeCommand', params)
 }
 
+export function executeWorkspaceConfig(db: string) {
+  // TODO: implement
+  // languageClient.sendRequest('workspace/configuration', { test: 'test' }).catch(e => {
+  //   console.log('--- error ---')
+  //   console.log(e)
+  // })
+}
+
 export function getConnectionList() {
   return connectionNames
 }

package.json

@@ -6,7 +6,7 @@
   "main": "./packages/client/out/extension",
   "repository": {
     "type": "git",
-    "url": "https://github.com/joe-re/sql-language-server"
+    "url": "git+https://github.com/joe-re/sql-language-server.git"
   },
   "keywords": [
     "sql",
@@ -57,7 +57,25 @@
         "title": "Rebuild SQLite3 Client",
         "category": "SQLLanguageServer"
       }
-    ]
+    ],
+    "configuration": {
+      "type": "object",
+      "title": "sql-language-server configuration",
+      "properties": {
+        "sqlLanguageServer.connections": {
+          "scope": "resource",
+          "type": "array",
+          "default": [],
+          "description": "connection setting"
+        },
+        "sqlLanguageServer.lint": {
+          "scope": "resource",
+          "type": "object",
+          "default": {},
+          "description": "lint setting"
+        }
+      }
+    }
   },
   "private": true,
   "workspaces": [

packages/client/extension.ts

@@ -26,7 +26,7 @@ export function activate(context: ExtensionContext) {
     diagnosticCollectionName: 'sqlLanguageServer',
     synchronize: {
       configurationSection: 'sqlLanguageServer',
-      fileEvents: workspace.createFileSystemWatcher('**/.sqllsrc.json')
+      // fileEvents: workspace.createFileSystemWatcher('**/.sqllsrc.json')
     }
   }
 

packages/server/package.json

@@ -7,7 +7,10 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/joe-re/sql-language-server"
+    "url": "git+https://github.com/joe-re/sql-language-server.git"
+  },
+  "bugs": {
+    "url": "https://github.com/joe-re/sql-language-server/issues"
   },
   "keywords": [
     "sql",
@@ -44,6 +47,7 @@
     "sqlite3": "^4.2.0",
     "vscode-languageclient": "^6.1.3",
     "vscode-languageserver": "^6.1.1",
+    "vscode-languageserver-protocol": "^3.15.3",
     "vscode-languageserver-textdocument": "^1.0.1",
     "yargs": "^12.0.1"
   },

packages/server/rollup.config.js

@@ -21,6 +21,7 @@ export default {
     replace({
       delimiters: ['', ''],
       values: {
+        "console.log('using faster connection')": '',
         'require(\'readable-stream/transform\')': 'require(\'stream\').Transform',
         'require("readable-stream/transform")': 'require("stream").Transform',
         'readable-stream': 'stream',

packages/server/src/SettingStore.ts

@@ -13,7 +13,7 @@ export type SSHConfig = {
   passphrase?: string
   identityFile?: string
 }
-export type Settings = {
+export type Connection = {
   name: string | null,
   adapter: 'mysql' | 'postgresql' | 'postgres' | 'sqlite3' | null,
   host: string | null
@@ -27,7 +27,7 @@ export type Settings = {
 }
 
 type PersonalConfig = {
-  connections: Settings[]
+  connections: Connection[]
 }
 
 function fileExists(path: string) {
@@ -47,7 +47,7 @@ function readFile(filePath: string) {
 
 export default class SettingStore extends EventEmitter.EventEmitter {
   private personalConfig: PersonalConfig = { connections: []}
-  private state: Settings = {
+  private state: Connection = {
     name: null,
     adapter: null,
     host: null,
@@ -83,7 +83,7 @@ export default class SettingStore extends EventEmitter.EventEmitter {
     const config = this.personalConfig.connections.find(v => v.name === connectionName)
     if (!config) {
       const errorMessage = `not find connection name: ${connectionName}`
-      logger.error(`not find connection name: ${connectionName}`)
+      logger.error(errorMessage)
       throw new Error(errorMessage)
     }
     this.setSetting(config)
@@ -93,8 +93,8 @@ export default class SettingStore extends EventEmitter.EventEmitter {
     personalConfigPath: string,
     projectConfigPath: string,
     projectPath: string
-  ): Promise<Settings | null> {
-    let personalConfig = { connections: [] } as PersonalConfig, projectConfig = {} as Settings
+  ): Promise<Connection | null> {
+    let personalConfig = { connections: [] } as PersonalConfig, projectConfig = {} as Connection
     if (fileExists(personalConfigPath)) {
       personalConfig = JSON.parse(readFile(personalConfigPath))
       this.personalConfig = personalConfig
@@ -107,21 +107,25 @@ export default class SettingStore extends EventEmitter.EventEmitter {
       logger.debug(`There isn't project config file., ${projectConfigPath}`)
     }
     const extractedPersonalConfig = projectConfig.name
-      ? personalConfig.connections.find((v: Settings) => v.name === projectConfig.name)
-      : personalConfig.connections.find((v: Settings) => v.projectPaths?.includes(projectPath))
-    if (!extractedPersonalConfig) {
-      logger.debug(`Failed to extract personal config, { path: ${projectPath}, projectName: ${projectConfig.name} }`)
-    }
+      ? personalConfig.connections.find((v: Connection) => v.name === projectConfig.name)
+      : this.extractPersonalConfigMatchedProjectPath(projectPath)
 
     const sshConfig = { ...extractedPersonalConfig?.ssh || {}, ...projectConfig?.ssh || {} } as SSHConfig
     const config = { ...extractedPersonalConfig, ...projectConfig }
     config.ssh = sshConfig
-    logger.debug(`Set config: ${JSON.stringify(config)}`)
     this.setSetting(config)
     return this.getSetting()
   }
 
-  setSetting(setting: Partial<Settings>) {
+  async setSettingFromWorkspaceConfig(connections: Connection[], projectPath: string = '') {
+    this.personalConfig = { connections }
+    const extractedPersonalConfig = this.extractPersonalConfigMatchedProjectPath(projectPath)
+    this.setSetting(extractedPersonalConfig || {})
+    return this.getSetting()
+  }
+
+  setSetting(setting: Partial<Connection>) {
+    logger.debug(`Set config: ${JSON.stringify(setting)}`)
     const replaceEnv = (v: { [key: string]: any }) => {
       for (const k in v) {
         if (v[k] && typeof v[k] === 'object') {
@@ -141,4 +145,12 @@ export default class SettingStore extends EventEmitter.EventEmitter {
     logger.debug('setting store, emit "change"')
     this.emit('change', this.state)
   }
+
+  private extractPersonalConfigMatchedProjectPath(projectPath: string) {
+    const con = this.personalConfig.connections.find((v: Connection) => v.projectPaths?.includes(projectPath))
+    if (!con) {
+      logger.debug(`Not to extract personal config, { path: ${projectPath}, projectName: ${projectPath} }`)
+    }
+    return con
+  }
 }

packages/server/src/createDiagnostics.ts

@@ -2,16 +2,16 @@ import { parse } from '@joe-re/sql-parser'
 import log4js from 'log4js';
 import { PublishDiagnosticsParams, Diagnostic } from 'vscode-languageserver'
 import { DiagnosticSeverity }from 'vscode-languageserver-types'
-import { lint, ErrorLevel, LintResult } from 'sqlint'
+import { lint, ErrorLevel, LintResult, RawConfig } from 'sqlint'
 import cache, { LintCache } from './cache'
 
 const logger = log4js.getLogger()
 
-function doLint(uri: string, sql: string): Diagnostic[] {
+function doLint(uri: string, sql: string, config?: RawConfig | null): Diagnostic[] {
   if (!sql) {
     return []
   }
-  const result: LintResult[] = JSON.parse(lint({ configPath: process.cwd(), formatType: 'json', text: sql }))
+  const result: LintResult[] = JSON.parse(lint({ configPath: process.cwd(), formatType: 'json', text: sql, configObject: config }))
   const lintDiagnostics = result.map(v => v.diagnostics).flat()
   const lintCache: LintCache[] = []
   const diagnostics = lintDiagnostics.map(v => {
@@ -32,13 +32,13 @@ function doLint(uri: string, sql: string): Diagnostic[] {
   return diagnostics
 }
 
-export default function createDiagnostics(uri: string, sql: string): PublishDiagnosticsParams {
+export default function createDiagnostics(uri: string, sql: string, config?: RawConfig | null): PublishDiagnosticsParams {
   logger.debug(`createDiagnostics`)
   let diagnostics: Diagnostic[] = []
   try {
     const ast = parse(sql)
     logger.debug(`ast: ${JSON.stringify(ast)}`)
-    diagnostics = doLint(uri, sql)
+    diagnostics = doLint(uri, sql, config)
   } catch (e) {
     logger.debug('parse error')
     logger.debug(e)