feat: refactor sql`` template tag from pg-async

Author: langpavel

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 > Write SQL queries for 🐘 Postgres in safe way
 
-[![Build Status](https://travis-ci.com/the-gear/sql-fragment.svg?branch=master)](https://travis-ci.org/the-gear/sql-fragment)
+[![Build Status](https://travis-ci.com/the-gear/sql-fragment.svg?branch=master)](https://travis-ci.com/the-gear/sql-fragment)
 [![NPM version](https://img.shields.io/npm/v/sql-fragment.svg)](https://www.npmjs.com/package/sql-fragment)
 ![Downloads](https://img.shields.io/npm/dm/sql-fragment.svg)
 [![Standard Version](https://img.shields.io/badge/release-standard%20version-brightgreen.svg)](https://github.com/conventional-changelog/standard-version)

README.md

@@ -5,7 +5,7 @@ const config = {
   preset: 'ts-jest',
   rootDir: '.',
   testMatch: [
-    '<rootDir>/src/**/__tests__/**/*.ts?(x)',
+    '<rootDir>/src/**/__tests__/**/*.(spec|test).ts?(x)',
     '<rootDir>/src/**/?(*.)+(spec|test).ts?(x)',
   ],
   modulePathIgnorePatterns: ['dist'],

jest.config.js

@@ -4,12 +4,14 @@
   "description": "Write SQL queries for 🐘 Postgres in safe way",
   "keywords": [
     "SQL",
+    "sql tag",
     "sql template string",
+    "sql tagged template string",
     "sql query",
     "postgres",
     "pg"
   ],
-  "main": "./bundles/index.umd.js",
+  "main": "./lib/index.js",
   "module": "./esm5/index.js",
   "es2015": "./esm2015/index.js",
   "typings": "./types/index.d.ts",
@@ -38,24 +40,22 @@
   "husky": {
     "hooks": {
       "commit-msg": "commitlint --config config/commitlint.config.js -E HUSKY_GIT_PARAMS",
-      "pre-commit": "lint-staged"
+      "pre-commit": "yarn run lint:fix && lint-staged"
     }
   },
   "lint-staged": {
     "**/*.{ts,tsx,js,jsx,css,scss,sass,less,md}": [
       "prettier --write",
       "git add"
-    ],
-    "src/**/*.{ts,tsx}": [
-      "yarn run lint:fix",
-      "git add"
     ]
   },
   "devDependencies": {
     "@commitlint/cli": "^7.3.2",
     "@commitlint/config-conventional": "^7.3.1",
+    "@types/invariant": "^2.2.29",
     "@types/jest": "^23.3.12",
     "@types/node": "^8.10.*",
+    "@types/pg": "^7.4.11",
     "@types/prettier": "^1.15.2",
     "@types/webpack-config-utils": "^2.3.0",
     "brotli-size": "^0.0.3",
@@ -68,6 +68,7 @@
     "jest-watch-typeahead": "^0.2.0",
     "kleur": "^3.0.1",
     "lint-staged": "^8.1.0",
+    "pg": "^7.8.0",
     "prettier": "^1.15.3",
     "pretty-bytes": "^5.1.0",
     "rollup": "^1.1.0",
@@ -92,13 +93,16 @@
     "webpack-config-utils": "^2.3.1"
   },
   "peerDependencies": {
+    "pg": "^7.8.0",
     "tslib": "^1.9.0"
   },
-  "dependencies": {},
+  "dependencies": {
+    "invariant": "^2.2.4"
+  },
   "scripts": {
     "cleanup": "shx rm -rf dist",
     "prebuild": "yarn run cleanup && yarn run verify",
-    "build": "tsc && tsc --target es2018 --outDir dist/esm2015 && rollup -c && rollup -c --environment NODE_ENV:production",
+    "build": "tsc && tsc --module esnext --target es5 --outDir dist/esm5 && tsc --target es2018 --outDir dist/esm2015 && rollup -c && rollup -c --environment NODE_ENV:production",
     "postbuild": "node scripts/copy.js && yarn run size",
     "docs": "typedoc -p . --theme minimal --target 'es6' --excludeNotExported --excludePrivate --ignoreCompilerErrors --exclude \"**/src/**/__tests__/*.*\" --out docs src/",
     "test": "jest",
@@ -125,4 +129,4 @@
     "size:umd": "node scripts/file-size.js ./dist/bundles/index.umd.min.js",
     "size:fesm": "node scripts/file-size.js ./dist/bundles/index.esm.min.js"
   }
-}
+}

package.json

@@ -4,7 +4,6 @@ import nodeResolve from 'rollup-plugin-node-resolve';
 import json from 'rollup-plugin-json';
 import commonjs from 'rollup-plugin-commonjs';
 import replace from 'rollup-plugin-replace';
-import { uglify } from 'rollup-plugin-uglify';
 import { terser } from 'rollup-plugin-terser';
 import { getIfUtils, removeEmpty } from 'webpack-config-utils';
 
@@ -40,23 +39,23 @@ const PATHS = {
 /**
  * @type {string[]}
  */
-const external = Object.keys(pkg.peerDependencies) || [];
+const external = [...Object.keys(pkg.peerDependencies), 'pg', 'pg-types'];
 
 /**
  *  @type {Plugin[]}
  */
 const plugins = /** @type {Plugin[]} */ ([
+  // Allow node_modules resolution, so you can use 'external' to control
+  // which external modules to include in the bundle
+  // https://github.com/rollup/rollup-plugin-node-resolve#usage
+  nodeResolve(),
+
   // Allow json resolution
   json(),
 
   // Allow bundling cjs modules (unlike webpack, rollup doesn't understand cjs)
   commonjs(),
 
-  // Allow node_modules resolution, so you can use 'external' to control
-  // which external modules to include in the bundle
-  // https://github.com/rollup/rollup-plugin-node-resolve#usage
-  nodeResolve(),
-
   // Resolve source maps to the original source
   sourceMaps(),
 
@@ -72,7 +71,9 @@ const plugins = /** @type {Plugin[]} */ ([
  */
 const CommonConfig = {
   input: {},
-  output: {},
+  output: {
+    exports: 'named',
+  },
   inlineDynamicImports: true,
   // Indicate here external modules you don't wanna include in your bundle (i.e.: 'lodash')
   external,
@@ -85,12 +86,13 @@ const UMDconfig = {
   ...CommonConfig,
   input: resolve(PATHS.entry.esm5, 'index.js'),
   output: {
+    ...CommonConfig.output,
     file: getOutputFileName(resolve(PATHS.bundles, 'index.umd.js'), ifProduction()),
     format: 'umd',
     name: LIB_NAME,
     sourcemap: true,
   },
-  plugins: removeEmpty(/** @type {Plugin[]} */ ([...plugins, ifProduction(uglify())])),
+  plugins: removeEmpty(/** @type {Plugin[]} */ ([...plugins, ifProduction(terser())])),
 };
 
 /**
@@ -101,6 +103,7 @@ const FESMconfig = {
   input: resolve(PATHS.entry.esm2015, 'index.js'),
   output: [
     {
+      ...CommonConfig.output,
       file: getOutputFileName(resolve(PATHS.bundles, 'index.esm.js'), ifProduction()),
       format: 'es',
       sourcemap: true,

rollup.config.js

@@ -52,7 +52,7 @@ function getDtsHeader(pkgName, version, author, repoUrl, tsVersion) {
 /**
  *
  * @param {string} path
- * @param {string | Blob} data
+ * @param {string | Buffer} data
  */
 function prependFileSync(path, data) {
   const existingFileContent = readFileSync(path, {

scripts/build.js

@@ -0,0 +1,3 @@
+declare module 'pg/lib/utils' {
+  export function prepareValue(value: unknown): unknown;
+}

src/@types/pg.d.ts

@@ -0,0 +1,57 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`sql tag composes well 1`] = `
+-- name: undefined
+VALUES ($1, $2, $3, $4), ($5, $6, $7, $8)
+-- values: Array [
+  1,
+  2,
+  3,
+  4,
+  2,
+  3,
+  2,
+  3,
+]
+`;
+
+exports[`sql tag should accept $id transform 1`] = `
+-- name: undefined
+SELECT * from "table"
+-- values: Array []
+`;
+
+exports[`sql tag should accept parametrized string 1`] = `
+-- name: undefined
+SELECT $1 as i, $2 as s
+-- values: Array [
+  1,
+  "string value",
+]
+`;
+
+exports[`sql tag should accept parametrized string: JSON serialized 1`] = `
+Object {
+  "name": undefined,
+  "text": "SELECT $1 as i, $2 as s",
+  "values": Array [
+    1,
+    "string value",
+  ],
+}
+`;
+
+exports[`sql tag should accept single string 1`] = `
+-- name: undefined
+SELECT * FROM foo
+-- values: Array []
+`;
+
+exports[`sql tag should mix transforms and variables correctly 1`] = `
+-- name: undefined
+SELECT $1 as "col1", $2 as "col2" from "table"
+-- values: Array [
+  1,
+  2,
+]
+`;

src/__tests__/__snapshots__/sql.spec.ts.snap

@@ -0,0 +1,13 @@
+// tslint:disable:no-unsafe-any
+import { SqlFragment } from '../sql-fragment';
+
+expect.addSnapshotSerializer({
+  test(value) {
+    return value && value instanceof SqlFragment;
+  },
+  print(value, serialize, indent) {
+    return [`-- name: ${value.name}`, value.text, `-- values: ${serialize(value.values)}`].join(
+      '\n',
+    );
+  },
+});