Merge pull request #56 from leapfrogtechnology/prettier

Setup prettier and integrate format checking in the CI

Author: mesaugat

.nycrc.json

@@ -1,18 +1,10 @@
 {
   "extends": "@istanbuljs/nyc-config-typescript",
-  "include": [
-    "src"
-  ],
-  "require": [
-    "ts-node/register"
-  ],
+  "include": ["src"],
+  "require": ["ts-node/register"],
   "cache": false,
   "sourceMap": true,
   "all": true,
   "instrument": true,
-  "reporter": [
-    "lcov",
-    "text",
-    "text-summary"
-  ]
+  "reporter": ["lcov", "text", "text-summary"]
 }

.prettierignore

@@ -0,0 +1,7 @@
+lib/
+node_modules
+coverage
+.nyc_output
+.vscode
+.github
+CHANGELOG.md

.travis.yml

@@ -6,6 +6,8 @@ node_js:
   - 8
 
 before_script:
+  - yarn format:check
+  - yarn lint
   - yarn build
 
 script:

examples/node-app-pg/src/index.js

@@ -13,13 +13,9 @@ const { connections } = require('../connections.sync-db.json');
 
     const tables = await db.raw('SELECT * FROM utils.vw_table_names');
     const users = await db.raw('SELECT * FROM utils.vw_user_names');
-    const [{ result: product }] = await db.raw(
-      'SELECT utils.product(6, 7) AS result;'
-    );
+    const [{ result: product }] = await db.raw('SELECT utils.product(6, 7) AS result;');
     const [{ result: sum }] = await db.raw('SELECT dbo.sum(6, 7) AS result;');
-    const [{ result: square }] = await db.raw(
-      'SELECT dbo.square(6) AS result;'
-    );
+    const [{ result: square }] = await db.raw('SELECT dbo.square(6) AS result;');
     const [{ result: date }] = await db.raw('EXEC utils.get_date;');
 
     console.log(

examples/node-mssql-programmatic-use/src/index.js

@@ -7,7 +7,6 @@ const { connections } = require('../connections.sync-db.json');
 
 (async () => {
   try {
-
     // Getting knex instance of mssql database with id db1.
     const db = knex({
       client: 'mssql',
@@ -21,8 +20,14 @@ const { connections } = require('../connections.sync-db.json');
     const [{ result: square }] = await db.raw('SELECT dbo.square(6) AS result;');
     const [{ result: date }] = await db.raw('EXEC utils.get_date;');
 
-    console.log('\nList of table names in the database:\n', tables.map(({ name }) => name));
-    console.log('\nList of user names in the database:\n', users.map(({ name }) => name));
+    console.log(
+      '\nList of table names in the database:\n',
+      tables.map(({ name }) => name)
+    );
+    console.log(
+      '\nList of user names in the database:\n',
+      users.map(({ name }) => name)
+    );
     console.log('\nCalculations:\n', {
       'Sum of 6 and 7': sum,
       'Product of 6 and 7': product,

package.json

@@ -43,7 +43,9 @@
     "test:coverage": "nyc mocha --forbid-only \"test/**/*.test.ts\"",
     "watch": "tsc --watch",
     "changelog": "./release.sh changelog",
-    "release": "./release.sh bump"
+    "release": "./release.sh bump",
+    "format": "prettier --write . '**/*.{ts,js,md,yaml,json}'",
+    "format:check": "prettier --check . '**/*.{ts,js,md,yaml,json}'"
   },
   "dependencies": {
     "@istanbuljs/nyc-config-typescript": "^0.1.3",
@@ -71,6 +73,7 @@
     "codecov": "^3.5.0",
     "mocha": "^5",
     "nyc": "^14.1.1",
+    "prettier": "1.19.1",
     "ts-node": "^8",
     "tslint": "^6.0.0",
     "tslint-config-leapfrog": "^1.0.3",

src/domain/ConnectionConfig.ts

@@ -3,17 +3,16 @@ import * as Knex from 'knex';
 /**
  * Database connection configuration.
  */
-type KnexConnections = Knex.ConnectionConfig
-  & Knex.MariaSqlConnectionConfig
-  & Knex.MySqlConnectionConfig
-  & Knex.MsSqlConnectionConfig
-  & Knex.SocketConnectionConfig
-  & Knex.Sqlite3ConnectionConfig;
+type KnexConnections = Knex.ConnectionConfig &
+  Knex.MariaSqlConnectionConfig &
+  Knex.MySqlConnectionConfig &
+  Knex.MsSqlConnectionConfig &
+  Knex.SocketConnectionConfig &
+  Knex.Sqlite3ConnectionConfig;
 
-type ConnectionConfig = KnexConnections
-  & {
-    id?: string;
-    client: string;
-  };
+type ConnectionConfig = KnexConnections & {
+  id?: string;
+  client: string;
+};
 
 export default ConnectionConfig;

src/domain/RawBingingParams.ts

@@ -13,7 +13,8 @@ type RawBindingParams = (
   | string[]
   | number[]
   | boolean[]
-  | Knex.QueryBuilder)[];
+  | Knex.QueryBuilder
+)[];
 
 export interface ValueMap {
   [key: string]: Value | Knex.QueryBuilder;

test/env.test.ts

@@ -23,7 +23,7 @@ describe('UTIL: env', () => {
       expect(result).to.equal('Foo bar');
     });
 
-    it('should substitute an empty string in-place of the variable if the variable isn\'t defined.', () => {
+    it('should substitute an empty string in-place of the variable if the variable is not defined.', () => {
       expect(expandEnvVars('${TEST_UNDEFINED_VARIABLE}')).to.equal('');
       expect(expandEnvVars('Substituted value = "${TEST_UNDEFINED_VARIABLE}"')).to.equal('Substituted value = ""');
     });

test/tsconfig.json

@@ -3,7 +3,5 @@
   "compilerOptions": {
     "noEmit": true
   },
-  "references": [
-    {"path": ".."}
-  ]
+  "references": [{ "path": ".." }]
 }