Skip to content

FartLabs/sql-embedder

Repository files navigation

sql-embedder

JSR JSR score GitHub Actions

Embed SQL into TypeScript source code.

Image

sql-embedder is a tool to make developing and distributing TypeScript applications easier when you need access to SQL databases at runtime. Generates statically analyzable modules.

Usage

You can run sql-embedder directly:

# Process SQL files in current directory
deno jsr:@fartlabs/sql-embedder

# Process SQL files in a specific directory
deno jsr:@fartlabs/sql-embedder --dir ./queries
deno jsr:@fartlabs/sql-embedder -d ./queries
deno jsr:@fartlabs/sql-embedder ./queries

Installation

Per-project

Add a deno task to your deno.json for convenient use within your project:

{
  "tasks": {
    "generate": "deno jsr:@fartlabs/sql-embedder src"
  }
}

Then run:

deno task generate

Global installation

For global use across all projects, install sql-embedder as a command:

deno install -A --name sql-embedder jsr:@fartlabs/sql-embedder

Then use it anywhere:

sql-embedder ./queries

AI coding agents

Install the skill to teach AI coding agents to edit the source .sql files instead of the generated .sql.ts files:

npx skills add fartlabs/sql-embedder

Development

Format and lint the code:

deno fmt
deno lint

Demonstrate the example:

deno task generate

Developed with 🧪 @FartLabs

About

Embed SQL into TypeScript source code.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published