chore: update deps and fix linting/formatting (#72)

BREAKING - no longer explicitly support node 6

.eslintrc.json

@@ -0,0 +1,23 @@
+{
+    "extends": ["brad"],
+    "parserOptions": {
+        "project": "./tsconfig.json"
+    },
+    "settings": {
+        "import/parsers": {
+            "@typescript-eslint/parser": [".ts", ".tsx"]
+        },
+        "import/resolver": {
+            "typescript": {}
+        }
+    },
+    "overrides": [
+        {
+            "files": ["test/**/*"],
+            "rules": {
+                "@typescript-eslint/no-non-null-assertion": "off",
+                "@typescript-eslint/no-explicit-any": "off"
+            }
+        }
+    ]
+}

.prettierignore

@@ -0,0 +1,3 @@
+.rpt2_cache
+dist
+node_modules

.prettierrc

@@ -0,0 +1,11 @@
+{
+    "arrowParens": "avoid",
+    "bracketSpacing": true,
+    "jsxBracketSameLine": true,
+    "proseWrap": "preserve",
+    "semi": true,
+    "singleQuote": true,
+    "tabWidth": 4,
+    "trailingComma": "all",
+    "useTabs": false
+}

.travis.yml

@@ -2,16 +2,20 @@ dist: trusty
 sudo: required
 language: node_js
 node_js:
-  - '10'
-  - '8'
-  - '6'
+    - '10'
+    - '8'
 services:
-  - mysql
+    - mysql
 before_install:
-  - mysql -e 'CREATE DATABASE IF NOT EXISTS mysqldump_test;'
+    - mysql -e 'CREATE DATABASE IF NOT EXISTS mysqldump_test;'
 install: yarn
 script:
-  - yarn build
-  - yarn setup-travis
-  - yarn test
-  - yarn test-prod
+    # setup travis first so test config exists
+    - yarn setup-travis
+    - yarn format-check
+    - yarn typecheck
+    # need to build before linting so the dist folder exists
+    - yarn build
+    - yarn lint
+    - yarn test
+    - yarn test-prod

.vscode/launch.json

@@ -11,7 +11,8 @@
             "name": "Launch Program",
             "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/ts-node",
             "args": [
-                "-P", "${workspaceRoot}/tsconfig.json",
+                "-P",
+                "${workspaceRoot}/tsconfig.json",
                 // launch main
                 "${workspaceRoot}/test/scripts/launch.ts"
             ],
@@ -22,16 +23,9 @@
             "request": "launch",
             "name": "Debug Test current test",
             "program": "${workspaceRoot}/node_modules/.bin/jest",
-            "args": [
-                "--config", "jest.json",
-                "e2e"
-            ],
-            "runtimeArgs": [
-                "--nolazy"
-            ],
-            "outFiles": [
-                "${workspaceRoot}/dist/tsbuild/**/*"
-            ],
+            "args": ["--config", "jest.json", "e2e"],
+            "runtimeArgs": ["--nolazy"],
+            "outFiles": ["${workspaceRoot}/dist/tsbuild/**/*"],
             "sourceMaps": true,
             "console": "integratedTerminal",
             "internalConsoleOptions": "neverOpen"

.vscode/settings.json

@@ -1,3 +1,10 @@
 {
-    "typescript.tsdk": "node_modules/typescript/lib"
-}
+    "typescript.tsdk": "node_modules/typescript/lib",
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "prettier.requireConfig": true,
+    "prettier.singleQuote": true,
+    "prettier.tabWidth": 4,
+    "prettier.trailingComma": "all",
+    "prettier.jsxBracketSameLine": true
+}

README.md

@@ -6,15 +6,20 @@ Create a backup of a MySQL database.
 
 ## Installation
 
+```bash
+$ npm install mysqldump
 ```
-yarn add mysqldump
-// or
-npm install mysqldump
+
+If you're using this package in typescript, you should also
+
+```bash
+$ npm install @types/node
 ```
 
 ## Usage
+
 ```typescript
-import mysqldump from 'mysqldump'
+import mysqldump from 'mysqldump';
 // or const mysqldump = require('mysqldump')
 
 // dump the result straight to a file
@@ -26,7 +31,7 @@ mysqldump({
         database: 'my_database',
     },
     dumpToFile: './dump.sql',
-})
+});
 
 // return the dump from the function and not to a file
 const result = await mysqldump({
@@ -36,10 +41,13 @@ const result = await mysqldump({
         password: '123456',
         database: 'my_database',
     },
-})
+});
 ```
+
 ## Result
+
 The returned result contains the dump property, which is split into schema and data.
+
 ```TS
 export default interface DumpReturn {
     /**
@@ -68,7 +76,9 @@ export default interface DumpReturn {
 ```
 
 ## Options
+
 All the below options are documented in the [typescript declaration file](./dist/mysqldump.d.ts):
+
 ```TS
 export interface ConnectionOptions {
 	/**
@@ -342,7 +352,7 @@ export default function main(inputOptions: Options): Promise<DumpReturn>;
 export as namespace mysqldump;
 ```
 
----------------------------------
+---
 
 The MIT [License](./LICENSE.md)
 
@@ -351,6 +361,7 @@ The MIT [License](./LICENSE.md)
 ### Installation
 
 Make sure to first install all the required development dependencies:
+
 ```
 yarn
 // or

dist/mysqldump.d.ts

@@ -163,8 +163,14 @@ export interface DataDumpOptions {
 	format?: boolean;
 	/**
 	 * Include file headers in output
+	 * Defaults to true.
 	 */
 	verbose?: boolean;
+	/**
+	 * Use a read lock during the data dump (see: https://dev.mysql.com/doc/refman/5.7/en/replication-solutions-backups-read-only.html)
+	 * Defaults to false.
+	 */
+	lockTables?: boolean;
 	/**
 	 * Dump data from views.
 	 * Defaults to false.
@@ -310,3 +316,5 @@ export interface DumpReturn {
 export default function main(inputOptions: Options): Promise<DumpReturn>;
 
 export as namespace mysqldump;
+
+export {};

jest.json

@@ -1,17 +1,10 @@
 {
-    "moduleFileExtensions": [
-        "ts",
-        "tsx",
-        "js"
-    ],
+    "moduleFileExtensions": ["ts", "tsx", "js"],
     "transform": {
         "^.+\\.tsx?$": "ts-jest"
     },
     "testRegex": "(/__tests__/.*|\\.(test|spec))\\.ts$",
-    "moduleDirectories": [
-        "src",
-        "node_modules"
-    ],
+    "moduleDirectories": ["src", "node_modules"],
     "globals": {
         "ts-jest": {
             "babelConfig": true,
@@ -20,13 +13,8 @@
     },
     "rootDir": ".",
 
-    "collectCoverageFrom": [
-        "src/**/*"
-    ],
-    "coverageReporters": [
-        "html",
-        "text-summary"
-    ],
+    "collectCoverageFrom": ["src/**/*"],
+    "coverageReporters": ["html", "text-summary"],
     "coverageDirectory": "<rootDir>/coverage",
     "coveragePathIgnorePatterns": [
         "/node_modules/",