Feature: Add option to set database in connection

README.MD

@@ -76,7 +76,7 @@ Below is the list that have direct support for `sql-lint` either through plugins
 
 ## Checks
 
-A quick rundown of the checks is below but you should [read the documentation](https://sql-lint.readthedocs.io/en/latest/files/checks.html) 
+A quick rundown of the checks is below but you should [read the documentation](https://sql-lint.readthedocs.io/en/latest/files/checks.html)
 for an exhaustive list.
 
 `sql-lint` comes with its own suite of checks. It

docs/files/configuration.md

@@ -33,7 +33,8 @@ You should put the following in there for more intelligent errors to come throug
     "host": "localhost",
     "user": "root",
     "password": "hunter2",
-    "port": 3306
+    "port": 3306,
+    "database": "your_database"
 }
 ```
 
@@ -68,6 +69,12 @@ The port to connect to.
 
 Optional, default is `3306`.
 
+### `database`
+
+The database to connect to.
+
+Optional, default is no database, where you will have to specify the database in your queries.
+
 ### `ignore-errors`
 
 Don't want to be warned about a particular error? 
@@ -115,6 +122,8 @@ The below configuration contains every option available.
     "host": "localhost",
     "user": "root",
     "password": "password",
+    "port": 3306,
+    "database": "your_database",
     "ignore-errors": [
         "odd-code-point",
         "missing-where",

docs/files/development.md

@@ -93,6 +93,9 @@ Change your config file in `~/.config/sql-lint/config.json` to have the followin
 }
 ```
 
+Optionally, you can also add `"database": "your_database_name"` if you want to connect 
+to a specific database. However, most tests were written without this option.
+
 ## This documentation
 
 This documentation is built on `sphinx` and `readthedocs`. To run it locally,

src/checker/checkerRunner.ts

@@ -66,7 +66,6 @@ class CheckerRunner {
           printer.warnAboutUncategoriseableQuery(content, tokenised, prefix);
         }
 
-
         for (const check of checks) {
           const checker = factory.build(check);
 

src/cli.ts

@@ -37,6 +37,7 @@ import databaseFactory from "./database/databaseFactory";
     .option("--host <string>", "The host for the database connection")
     .option("--user <string>", "The user for the database connection")
     .option("--password <string>", "The password for the database connection")
+    .option("--database <string>", "The database for the database connection")
     .option("--port <string>", "The port for the database connection")
     .option("--config <string>", "The path to the configuration file")
     .option("--ignore-errors <string...>", "The errors to ignore (comma separated)")
@@ -113,7 +114,8 @@ import databaseFactory from "./database/databaseFactory";
       program.host || configuration?.host || "localhost",
       program.user || configuration?.user || "root", // bad practice but unfortunately common, make it easier for the user
       program.password || configuration?.password,
-      program.port || configuration?.port || undefined // let mysql2 or pg figure out the default port
+      program.port || configuration?.port || undefined, // let mysql2 or pg figure out the default port
+      program.database || configuration?.database || undefined,
     );
   }
 

src/database/databaseFactory.ts

@@ -7,13 +7,14 @@ export default function databaseFactory(
   host: string,
   user: string,
   password: string,
-  port?: number
+  port?: number,
+  database?: string
 ): IDatabase {
   switch (driver) {
     case "mysql":
-      return new MySqlDatabase(host, user, password, port);
+      return new MySqlDatabase(host, user, password, port, database);
     case "postgres":
-      return new PostgresDatabase(host, user, password, port);
+      return new PostgresDatabase(host, user, password, port, database);
     default:
       throw new Error(`${driver} driver is unsupported`);
   }

src/database/mySqlDatabase.ts

@@ -4,12 +4,19 @@ import IDatabase, { sqlError } from "./interface";
 export default class MySqlDatabase implements IDatabase {
   private connection: mysql.Connection;
 
-  constructor(host: string, user: string, password: string, port?: number) {
+  constructor(
+    host: string,
+    user: string,
+    password: string,
+    port?: number,
+    database?: string
+  ) {
     this.connection = mysql.createConnection({
       host,
       user,
       password,
       port,
+      database,
     });
   }
 

src/database/postgresDatabase.ts

@@ -4,12 +4,19 @@ import IDatabase, { sqlError } from "./interface";
 export default class PostgresDatabase implements IDatabase {
   private pool: Pool;
 
-  constructor(host: string, user: string, password: string, port?: number) {
+  constructor(
+    host: string,
+    user: string,
+    password: string,
+    port?: number,
+    database?: string
+  ) {
     this.pool = new Pool({
       host,
       user,
       password,
       port,
+      database,
     });
   }
 

src/main.ts

@@ -11,6 +11,7 @@ interface Parameters {
   host?: string;
   user?: string;
   port?: number;
+  database?: string;
   driver?: string;
   prefix?: string;
   password?: string;
@@ -21,41 +22,26 @@ export default async ({
   sql,
   host,
   port,
-  user = '',
-  prefix = '',
-  password = '',
+  database,
+  user = "",
+  prefix = "",
+  password = "",
   verbosity = 0,
-  driver = 'mysql',
+  driver = "mysql",
 }: Parameters): Promise<IMessage[]> => {
-  const printer = new Printer(
-    verbosity,
-    new JsonFormat(),
-  );
+  const printer = new Printer(verbosity, new JsonFormat());
 
-  let db: IDatabase|undefined;
+  let db: IDatabase | undefined;
   if (host) {
-    db = databaseFactory(
-      driver,
-      host,
-      user,
-      password,
-      port,
-    )
+    db = databaseFactory(driver, host, user, password, port, database);
   }
 
   const runner = new CheckerRunner();
-  await runner.run(
-    putContentIntoLines(sql),
-    printer,
-    prefix,
-    [],
-    driver,
-    db,
-  )
+  await runner.run(putContentIntoLines(sql), printer, prefix, [], driver, db);
 
   if (db) {
     db.end();
   }
 
   return printer.messages;
-}
+};

src/reader/reader.ts

@@ -31,15 +31,15 @@ export function putContentIntoLines(contents: string): Query[] {
       currentQueryContent += char;
       continue;
     }
-    
+
     if (escape) {
       escape = false;
       currentQueryContent += char;
       continue;
     }
 
     // Toggle string state
-    if (char === "'" || char === "\"") {
+    if (char === "'" || char === '"') {
       if (currentQuote === null) {
         currentQuote = char;
       } else if (currentQuote === char) {

test/integration/sql-lint.test.ts

@@ -52,19 +52,15 @@ test("it brings back a version number", (done) => {
   shelltest().cmd(`${sqlLint} --version`).expect("stdout", /^\d/).end(done);
 });
 
-test("--port is a valid option", (done) => {
-  shelltest()
-    .cmd(`${sqlLint} --help`)
-    .expect("stdout", /.*--port.*/)
-    .end(done);
-});
-
-test("--config is a valid option", (done) => {
-  shelltest()
-    .cmd(`${sqlLint} --help`)
-    .expect("stdout", /.*--config.*/)
-    .end(done);
-});
+test.each(["--port", "--config", "--database"])(
+  "%s is a valid option",
+  (option) => {
+    shelltest()
+      .cmd(`${sqlLint} --help`)
+      .expect("stdout", new RegExp(`.*${option}.*`))
+      .end();
+  }
+);
 
 test("Good queries exit with 0", (done) => {
   shelltest()

test/unit/main.test.ts

@@ -26,7 +26,7 @@ test.each([
       error: "[sql-lint: trailing-whitespace] Trailing whitespace",
     },
   ],
-])("it can run programmatically", async (sql, expected) => {
+])("it can run programmatically (%s)", async (sql, expected) => {
   const errors = await sqlLint({ sql: sql });
   expect(errors[0]).toMatchObject(expected);
 });