refactor: code quality cleanup

Author: cmoog

.github/workflows/build.yml

@@ -18,6 +18,7 @@ jobs:
         with:
           submodules: true
       - uses: cachix/install-nix-action@v16
+      # TODO: implement build cache
       - run: npm ci
       - run: ./compile_sqls.fish
       - run: npx vsce package --out sqlnotebook-${{ github.sha }}.vsix
@@ -26,3 +27,15 @@ jobs:
         with:
           name: sqlnotebook-${{ github.sha }}.vsix
           path: sqlnotebook-${{ github.sha }}.vsix
+  test:
+    runs-on: ubuntu-20.04
+    defaults:
+      run:
+        shell: nix develop -c bash {0}
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: true
+      - uses: cachix/install-nix-action@v16
+      - run: npm ci
+      - run: npm run lint

.vscodeignore

@@ -3,10 +3,15 @@
 out/test/**
 src/**
 .gitignore
-vsc-extension-quickstart.md
 **/tsconfig.json
 **/.eslintrc.json
 **/*.map
 **/*.ts
 **/*.tsbuildinfo
 sqls
+.github
+flake.nix
+flake.lock
+.envrc
+.gitmodules
+webview

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-## [0.5.0]
+## v0.5.0
 
 - Bundle `sqls` language server into `vscode-sql-notebook`.
   - When running on a compatible arch/os, notebooks can now

README.md

@@ -15,7 +15,7 @@ and view output interactively.
 - Open any `.sql` file as a Notebook.
 - Execute query blocks in the Notebook UI and view output.
 - Configure database connections in the SQL Notebook sidepanel.
-- Supports MySQL PostgreSQL, and MSSQL (OracleDB and SQLite support coming soon).
+- Supports MySQL, PostgreSQL, and MSSQL (OracleDB and SQLite support coming soon).
 - (unstable) Built-in typed autocomplete with an embeded language server.
 
 ## Usage

src/commands.ts

@@ -8,12 +8,11 @@ import { getPool, PoolConfig } from './driver';
 import { storageKey, globalConnPool, globalLspClient } from './extension';
 import { getCompiledLSPBinaryPath, sqlsDriverFromDriver } from './lsp';
 
-export const deleteConnectionConfiguration =
-  (
-    context: vscode.ExtensionContext,
-    connectionsSidepanel: SQLNotebookConnections
-  ) =>
-  async (item: ConnectionListItem) => {
+export function deleteConnectionConfiguration(
+  context: vscode.ExtensionContext,
+  connectionsSidepanel: SQLNotebookConnections
+) {
+  return async (item: ConnectionListItem) => {
     const without = context.globalState
       .get<ConnData[]>(storageKey, [])
       .filter(({ name }) => name !== item.config.name);
@@ -26,13 +25,13 @@ export const deleteConnectionConfiguration =
     );
     connectionsSidepanel.refresh();
   };
+}
 
-export const connectToDatabase =
-  (
-    context: vscode.ExtensionContext,
-    connectionsSidepanel: SQLNotebookConnections
-  ) =>
-  async (item?: ConnectionListItem) => {
+export function connectToDatabase(
+  context: vscode.ExtensionContext,
+  connectionsSidepanel: SQLNotebookConnections
+) {
+  return async (item?: ConnectionListItem) => {
     let selectedName: string;
     if (!item) {
       const names = context.globalState
@@ -94,13 +93,15 @@ export const connectToDatabase =
       connectionsSidepanel.setActive(null);
     }
   };
+}
 
 function startLanguageServer(conn: ConnData, password?: string) {
   try {
     const driver = sqlsDriverFromDriver(conn.driver);
     const binPath = getCompiledLSPBinaryPath();
-    if (!binPath)
+    if (!binPath) {
       throw Error('Platform not supported, language server disabled.');
+    }
     if (driver) {
       globalLspClient.start({
         binPath,

src/extension.ts

@@ -179,7 +179,7 @@ class SQLNotebookController {
       writeSuccess(execution, 'Successfully executed query');
       return;
     }
-    const tables = result.map((r) => resultToMarkdownTable(r));
+    const tables = result.map(resultToMarkdownTable);
     writeSuccess(execution, tables, 'text/markdown');
   }
 }
@@ -195,9 +195,7 @@ function resultToMarkdownTable(result: TabularResult): string {
       Object.fromEntries(Object.entries(result).map((pair) => [pair[0], '...']))
     );
   }
-  return `${markdownHeader(result[0])}\n${result
-    .map((r) => markdownRow(r))
-    .join('\n')}`;
+  return `${markdownHeader(result[0])}\n${result.map(markdownRow).join('\n')}`;
 }
 
 function escapeNewline(a: string | number | null): string | number | null {

src/lsp.ts

@@ -37,7 +37,9 @@ export function getCompiledLSPBinaryPath(): string | null {
   const goos = { linux: 'linux', darwin: 'darwin', win32: 'windows' }[
     platform.toString()
   ];
-  if (!goarch && !goos) return null;
+  if (!goarch && !goos) {
+    return null;
+  }
   return path.join(
     __filename,
     '..',