sqlx-ts 0.1.2

package/.eslintignore

@@ -0,0 +1 @@
+node_modules/*

package/.eslintrc.js

@@ -0,0 +1,19 @@
+module.exports = {
+  "env": {
+    "browser": true,
+    "es2021": true,
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module",
+  },
+  "plugins": [
+    "@typescript-eslint",
+  ],
+  "rules": {},
+};

package/README.md

@@ -0,0 +1,148 @@
+<h1 align="center">SQLx-ts</h1>
+
+<div align="center">
+    <a href='https://coveralls.io/github/JasonShin/sqlx-ts?branch=main'><img src='https://coveralls.io/repos/github/JasonShin/sqlx-ts/badge.svg?branch=main' alt='Coverage Status' /></a>
+</div>
+
+<div align="center">
+ <strong>
+   🧰 The Typescript/Javascript SQL Toolkit
+ </strong>
+</div>
+
+<br />
+
+<div align="center">
+Built to free Node developers from ORMs' unpredictably generated SQL queries
+</div>
+
+<br />
+
+SQLx-ts is a CLI application featuring compile-time checked queries without a DSL and prevents broken SQL queries being run during runtime.
+
+- **Compile time checked queries** - never ship a broken SQL query to production
+- **TypeScript type generations** - generates type definitions based on the raw SQLs and you can use them with any MySQL or PostgreSQL driver
+- **Database Agnostic** - support for [PostgreSQL](http://postgresql.org/) and [MySQL](https://www.mysql.com/)
+- **TypeScript and JavaScript** - supports for both [TypeScript](https://www.typescriptlang.org/) and JavaScript
+
+<br>
+<div align="center">
+    <strong>
+    📔 <a href="https://jasonshin.github.io/sqlx-ts/">Official Documentation</a>
+    </strong>
+</div>
+<br>
+
+### Installation
+
+##### Install sqlx-ts npm module (recommended)
+
+If you are using npm
+```bash
+$ npm install sqlx-ts
+```
+
+If you are using yarn
+```bash
+$ yarn add sqlx-ts
+```
+
+You can also install sqlx-ts globally
+```bash
+$ npm install -g sqlx-ts
+```
+
+Installing sqlx-ts using npm also installed `sqlx-ts` binary of the same version as the npm module.
+Verify the installation by running
+
+```bash
+$ npx sqlx-ts --version
+```
+
+And to use sqlx-ts in your code
+
+In TypeScript based projects:
+
+```typescript
+import { sql } from 'sqlx-ts'
+
+// ...
+const query = sql`SELECT * FROM some_table;`
+// ...
+```
+
+
+In Babel based projects:
+
+```javascript
+import { sql } from 'sqlx-ts'
+const query = sql`SELECT * FROM some_table;`
+
+// ... or
+
+const { sql } = require('sqlx-ts')
+const query = sql`SELECT * FROM some_table;`
+```
+
+##### Installing binary separately
+
+You may choose to install sqlx-ts separately instead of using `npm i`
+
+###### Using install.sh
+
+The binary name for sqlx-ts is `sqlx-ts`.
+
+[Archives of precompiled binaries of sqlx-ts are available for windows, macOS and Linux](https://github.com/JasonShin/sqlx-ts/releases). Linux and Windows binaries are static executables. Users of platforms not explicitly mentioned below are advised to download one of these archives.
+
+If you're a **macOS** user, then you can install sqlx-ts from via install.sh:
+
+```bash
+# macos & ARM CPU
+$ curl -LSfs https://jasonshin.github.io/sqlx-ts/install.sh | sh -s -- --os darwin --cpu arm64
+# macos & X64 CPU
+$ curl -LSfs https://jasonshin.github.io/sqlx-ts/install.sh | sh -s -- --os darwin --cpu x64
+```
+
+If you're a **Windows** user, then you can install sqlx-ts from via install.sh:
+
+```bash
+# windows & x32
+$ curl -LSfs https://jasonshin.github.io/sqlx-ts/install.sh | sh -s -- --os win32 --cpu x32
+# windows & x64
+$ curl -LSfs https://jasonshin.github.io/sqlx-ts/install.sh | sh -s -- --os win32 --cpu x32
+```
+
+If you're a **Linux** user, then you can install sqlx-ts from via install.sh:
+
+```bash
+# linux & x32
+$ curl -LSfs https://jasonshin.github.io/sqlx-ts/install.sh | sh -s -- --os linux --cpu x32
+# linux & x64
+$ curl -LSfs https://jasonshin.github.io/sqlx-ts/install.sh | sh -s -- --os linux --cpu x64
+# linux & arm
+$ curl -LSfs https://jasonshin.github.io/sqlx-ts/install.sh | sh -s -- --os linux --cpu arm64
+```
+
+To install a specific artifact, [go to the release page to find the exact name of the artifact](https://github.com/JasonShin/sqlx-ts/releases)
+
+```bash
+$ curl -LSfs https://jasonshin.github.io/sqlx-ts/install.sh | sh -s -- --artifact sqlx-ts-v0.1.0-macos-arm.zip
+```
+
+Upgrading to a new version can be done by grabbing the next version of the sqlx-ts artifact and use `--force` command from install.sh
+
+```bash
+$ curl -LSfs https://jasonshin.github.io/sqlx-ts/install.sh | \
+    sh -s -- --artifact ssqlx-ts-v0.1.0-macos-arm.zip --force
+```
+
+For more advanced usage, please check `--help` command of install.sh
+
+```bash
+$ curl -LSfs https://jasonshin.github.io/sqlx-ts/install.sh | \
+    sh -s -- --help
+```
+
+### Motivation
+
+I would like to bring the powerful compile-time safety ideas to Node.js. [sqlx](https://github.com/launchbadge/sqlx) is a great example of this, as it provides compile-time check of SQLs within your Rust code and Rust itself provides a great environment for tools like sqlx. sqlx-ts is greatly inspired by [sqlx](https://github.com/launchbadge/sqlx), but solves additional problems of generating TypeScript interfaces based on the SQL queries that are present in your code.

package/dist/index.d.ts

@@ -0,0 +1 @@
+export declare function sql<T extends TemplateStringsArray>(query: T): string;

package/dist/index.js

@@ -0,0 +1,7 @@
+"use strict";
+exports.__esModule = true;
+exports.sql = void 0;
+function sql(query) {
+    return query[0];
+}
+exports.sql = sql;

package/jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+};

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "sqlx-ts",
+  "version": "0.1.2",
+  "description": "sqlx-ts ensures your raw SQLs are compile-time checked",
+  "main": "dist/index.js",
+  "maintainers": [
+    "visualbbasic@gmail.com"
+  ],
+  "author": "Jason Shin <visualbbasic@gmail.com>",
+  "license": "MIT",
+  "bin": "./sqlx-ts",
+  "scripts": {
+    "postinstall": "node postinstall.js",
+    "compile": "npx tsc -p tsconfig.json",
+    "lint": "npx eslint --ext .ts src",
+    "lint:fix": "npx eslint --ext .ts src --fix",
+    "test": "npx jest",
+    "prepublishOnly": "cp ../README.md . && npm i && npm run compile"
+  },
+  "devDependencies": {
+    "@types/jest": "^27.4.1",
+    "@typescript-eslint/eslint-plugin": "^5.19.0",
+    "@typescript-eslint/parser": "^5.19.0",
+    "eslint": "^8.13.0",
+    "jest": "^27.5.1",
+    "ts-jest": "^27.1.4",
+    "typescript": "^4.6.3"
+  }
+}

package/postinstall.js

@@ -0,0 +1,8 @@
+let execSync = require('child_process').execSync
+let tag = require('./package.json').version
+
+const os = process.platform
+const cpu = process.arch
+
+execSync(`curl -LSfs https://jasonshin.github.io/sqlx-ts/install.sh | bash -s -- --os ${os} --cpu ${cpu} --tag ${tag} -f`, { stdio: 'inherit' })
+console.info('sqlx-ts installation successful')

package/src/index.spec.ts

@@ -0,0 +1,27 @@
+import { sql } from "./index";
+
+test("should return single line", () => {
+  const rawSql = sql`SELECT * FROM test;`;
+
+  expect(rawSql).toBe("SELECT * FROM test;");
+});
+
+test("should return multiple lines", () => {
+  const rawSql = sql`
+        SELECT *
+        FROM test
+        WHERE createdAt > 2019-1-1;
+    `;
+
+  expect(rawSql).toBe(`
+        SELECT *
+        FROM test
+        WHERE createdAt > 2019-1-1;
+    `);
+});
+
+test("should return empty", () => {
+  const rawSql = sql``;
+
+  expect(rawSql).toBe("");
+});

package/src/index.ts

@@ -0,0 +1,3 @@
+export function sql<T extends TemplateStringsArray>(query: T): string {
+  return query[0];
+}

package/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "include": ["src/**/*.ts"],
+  "exclude": ["src/**/*.spec.ts"],
+  "compilerOptions": {
+    "outDir": "dist",
+    "declaration": true,
+    "strict": true,
+    "esModuleInterop": true
+  }
+}