🎉 add custom eslint-config

Author: casperiv0

.eslintrc.json

@@ -4,25 +4,20 @@
     "es2021": true,
     "node": true
   },
-  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended", "prettier", "plugin:prettier/recommended"],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier",
+    "@casper124578/eslint-config",
+    "plugin:prettier/recommended"
+  ],
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
     "ecmaVersion": 12,
     "sourceType": "module"
   },
   "plugins": ["@typescript-eslint", "prettier"],
   "rules": {
-    "quotes": ["error", "double"],
-    "semi": ["error", "always"],
-    "no-multi-spaces": ["error"],
-    "eqeqeq": ["warn", "always"],
-    "no-unused-vars": "off",
-    "no-duplicate-case": ["error"],
-    "no-extra-semi": ["error"],
-    "no-unreachable": ["error"],
-    "default-case": ["warn"],
-    "default-case-last": ["error"],
-    "no-useless-catch": ["warn"],
     "prettier/prettier": ["error"],
     "@typescript-eslint/no-explicit-any": "off",
     "@typescript-eslint/explicit-module-boundary-types": "off",

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.0.19
+
+- Add [custom ESLint config](https://github.com/dev-caspertheghost/eslint-config)
+
 ## 0.0.18
 
 - Update docs

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@casper124578/mysql.ts",
-  "version": "0.0.18",
+  "version": "0.0.19",
   "description": "A simple mysql wrapper for node.js",
   "main": "dist/index.js",
   "private": false,
@@ -9,6 +9,7 @@
     "build:tsc": "tsc --noEmit",
     "test": "ts-node tests/index.test.ts",
     "lint": "eslint . --ext .ts,.tsx",
+    "lint:fix": "eslint . --fix --ext .ts,.tsx",
     "format": "prettier --write \"**/*.{js,jsx,json,ts,tsx,yml,md}\" --ignore-path .gitignore"
   },
   "keywords": [
@@ -34,6 +35,7 @@
     "mysql": "^2.18.1"
   },
   "devDependencies": {
+    "@casper124578/eslint-config": "^0.0.3",
     "@types/mysql": "^2.15.18",
     "@typescript-eslint/eslint-plugin": "^4.23.0",
     "@typescript-eslint/parser": "^4.23.0",

package.json

@@ -1,42 +1,42 @@
 import { QueryValue, BuilderTypeOptions } from "./types";
 
 /**
- * Defaults: `nullable = true`, `length = 255`
+ * defaults: `nullable = true`, `length = 255`
  */
 export function string({ nullable = true, length = 255, DEFAULT }: BuilderTypeOptions): string {
   return `varchar(${length}) ${_returnNullable(nullable)} ${_returnDefault(DEFAULT)}`;
 }
 
 /**
- * Defaults: `nullable = true`, `length = 8`
+ * defaults: `nullable = true`, `length = 8`
  */
 export function int({ nullable = true, length = 8, DEFAULT }: BuilderTypeOptions<number>): string {
   return `int(${length}) ${_returnNullable(nullable)} ${_returnDefault(DEFAULT)}`;
 }
 
 /**
- * Defaults: `nullable = true`
+ * defaults: `nullable = true`
  */
 export function text({ nullable = true, DEFAULT }: Omit<BuilderTypeOptions, "length">): string {
   return `text ${_returnNullable(nullable)} ${_returnDefault(DEFAULT)}`;
 }
 
 /**
- * Defaults: `nullable = true`
+ * defaults: `nullable = true`
  */
 export function date({ nullable = true, DEFAULT }: Omit<BuilderTypeOptions, "length">) {
   return `DATE ${_returnNullable(nullable)} ${_returnDefault(DEFAULT)}`;
 }
 
 /**
- * Defaults: `nullable = true`, `DEFAULT = {}`
+ * defaults: `nullable = true`, `DEFAULT = {}`
  */
 export function json({ nullable = true, DEFAULT = {} }: Omit<BuilderTypeOptions<any>, "length">) {
   return `JSON ${_returnNullable(nullable)} ${_returnDefault(DEFAULT)}`;
 }
 
 /**
- * Defaults: `nullable = true`
+ * defaults: `nullable = true`
  */
 export function timestamp({ nullable = true, DEFAULT }: Omit<BuilderTypeOptions, "length">) {
   return `TIMESTAMP ${_returnNullable(nullable)} ${_returnDefault(DEFAULT)}`;

src/BuilderTypes.ts

@@ -94,7 +94,7 @@ export class Connection<Tables> {
     const connection = mysql.createConnection(this.config);
 
     return new Promise((resolve, reject) => {
-      return connection.connect(async (err) => {
+      connection.connect(async (err) => {
         if (err) {
           return reject(err);
         }

src/Connection.ts

@@ -19,7 +19,7 @@ export class QueryBuilder<Tables, T = any> {
   }
 
   /**
-   * Select 1 or more items from a table
+   * select 1 or more items from a table
    * @param {string|string[]} selector
    * @example
    *
@@ -48,7 +48,7 @@ export class QueryBuilder<Tables, T = any> {
   }
 
   /**
-   * Insert data into a table
+   * insert data into a table
    * @param tableName The name of the table
    * @param data Data that needs to be inserted
    */
@@ -64,7 +64,7 @@ export class QueryBuilder<Tables, T = any> {
   }
 
   /**
-   * Update data from a table
+   * update data from a table
    * @param tableName The name of the table
    * @param data Data that needs to be updated
    */
@@ -84,7 +84,7 @@ export class QueryBuilder<Tables, T = any> {
   }
 
   /**
-   * Delete something from the table
+   * delete something from the table
    * @param selector The table name
    * @example
    * // delete an item with 'where'
@@ -140,7 +140,7 @@ export class QueryBuilder<Tables, T = any> {
   }
 
   /**
-   * Rename a table
+   * rename a table
    * @param oldName The old table name you want to rename
    * @param newName The new name
    */
@@ -151,7 +151,7 @@ export class QueryBuilder<Tables, T = any> {
   }
 
   /**
-   * Drop a database or a table
+   * drop a database or a table
    * @param {string} name The table or database you want to drop
    * @param {"table"|"database"} type `table` or `database`
    * @param {boolean} ifExists Check if the table/database exists when dropping
@@ -170,7 +170,7 @@ export class QueryBuilder<Tables, T = any> {
   }
 
   /**
-   * Delete a column in a database table
+   * delete a column in a database table
    * @param tableName The name of the table
    * @param columnName The name of the column you want to drop
    */
@@ -187,7 +187,7 @@ export class QueryBuilder<Tables, T = any> {
   }
 
   /**
-   * Create a raw query
+   * create a raw query
    * @param query The raw query
    * @param values Values that are needed for insert, update, ..
    * @example
@@ -206,7 +206,7 @@ export class QueryBuilder<Tables, T = any> {
   }
 
   /**
-   * Create a table
+   * create a table
    * @param name The name of the table
    * @param primary The primary key
    * @param columns The columns that need to be inserted
@@ -230,7 +230,7 @@ export class QueryBuilder<Tables, T = any> {
   }
 
   /**
-   * Same as `QueryBuilder#createTable` but only create the table if it doesn't exist
+   * same as `QueryBuilder#createTable` but only create the table if it doesn't exist
    * @see [https://github.com/Dev-CasperTheGhost/mysql.ts/blob/main/docs/Query.md#create-table](https://github.com/Dev-CasperTheGhost/mysql.ts/blob/main/docs/Query.md#create-table)
    */
   createTableIfNotExists(name: string, primary: keyof T | undefined, columns: Partial<Record<keyof T, string>>) {
@@ -243,7 +243,7 @@ export class QueryBuilder<Tables, T = any> {
   }
 
   /**
-   * Add more columns to a table
+   * add more columns to a table
    * @param name The name of the table
    * @param columns The columns to add
    * @example
@@ -267,7 +267,7 @@ export class QueryBuilder<Tables, T = any> {
   }
 
   /**
-   * Reset the query string and values
+   * reset the query string and values
    */
   resetQuery() {
     this.query = "";
@@ -277,7 +277,7 @@ export class QueryBuilder<Tables, T = any> {
   }
 
   /**
-   * Execute the query
+   * execute the query
    */
   async exec(options?: Omit<mysql.QueryOptions, "sql" | "values">): Promise<T[] | undefined> {
     if (this.config.debugExec === true) {

src/QueryBuilder.ts

@@ -3,7 +3,7 @@ import { ConnectionConfig } from "./types";
 import { QueryBuilder } from "./QueryBuilder";
 
 /**
- * Create the connection to the database
+ * create the connection to the database
  * @param {ConnectionConfig} config The connection config
  * @see [https://github.com/mysqljs/mysql#connection-options](https://github.com/mysqljs/mysql#connection-options)
  * @returns The connection

src/index.ts

@@ -4,12 +4,12 @@ export interface ConnectionConfig extends MySQLConnectionConfig {
   reconnect?: boolean;
 
   /**
-   * This will show the full query & values when a query is executed with the `QueryBuilder#exec` method
+   * this will show the full query & values when a query is executed with the `QueryBuilder#exec` method
    */
   debugExec?: boolean;
 
   /**
-   * When no results are found for a query:
+   * when no results are found for a query:
    *
    * `false` = return `undefined`
    *
@@ -33,22 +33,22 @@ export interface StatisticsPacket {
 
 export interface ChangeUserOptions {
   /**
-   * The name of the new user (defaults to the previous one)
+   * the name of the new user (defaults to the previous one)
    */
   user?: string;
 
   /**
-   * The password of the new user (defaults to the previous one)
+   * the password of the new user (defaults to the previous one)
    */
   password?: string;
 
   /**
-   * The new charset (defaults to the previous one)
+   * the new charset (defaults to the previous one)
    */
   charset?: string;
 
   /**
-   * The new database (defaults to the previous one)
+   * the new database (defaults to the previous one)
    */
   database?: string;
 }