dbcat 0.0.8 → 0.0.10

package/README.md

@@ -65,6 +65,28 @@ Pipe to `less -R` for scrollable output with colors:
 bunx dbcat ./data.db --full | less -R
 ```
 
+### Git diffable
+
+Do these things to make git use `dbcat` to diff your sqlite databases:
+
+```sh
+# .gitattributes
+*.sqlite binary diff=dbcat
+*.db binary diff=dbcat
+```
+
+```sh
+git config diff.lockb.textconv "bunx dbcat --full"
+git config diff.lockb.binary true
+```
+
+And now you should be able to use
+
+```sh
+git diff ./data.db
+```
+
+
 ## Requirements
 
 [Bun](https://bun.sh) v1.3+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dbcat",
-  "version": "0.0.8",
+  "version": "0.0.10",
   "description": "A simple CLI to view database tables. Supports PostgreSQL, MySQL, and SQLite.",
   "author": "RiskyMH",
   "license": "MIT",

package/src/index.ts

@@ -9,19 +9,24 @@ import { join } from "node:path";
 const SQLITE_EXTENSIONS = [".db", ".sqlite", ".sqlite3", ".db3", ".s3db"];
 const REMOTE_PROTOCOLS = ["http://", "https://", "s3://"];
 
-export function createConnection(input?: string): InstanceType<typeof Bun.SQL> {
+export function createConnection(
+  input?: string,
+  options?: { readonly?: boolean }
+): InstanceType<typeof Bun.SQL> {
+  const opts = { readonly: true, ...options };
+
   if (!input) {
-    return new Bun.SQL();
+    return new Bun.SQL(opts);
   }
 
   if (
     !input.includes("://") &&
     SQLITE_EXTENSIONS.some((ext) => input.endsWith(ext))
   ) {
-    return new Bun.SQL(`sqlite://${input}`);
+    return new Bun.SQL(`sqlite://${input}`, opts);
   }
 
-  return new Bun.SQL(input);
+  return new Bun.SQL(input, opts);
 }
 
 async function downloadToTmp(url: string): Promise<string> {
@@ -141,7 +146,7 @@ function displayQueryResult(rows: Record<string, unknown>[]) {
 }
 
 async function readStdin(): Promise<string | null> {
-  if (process.stdin.isTTY) {
+  if (process.stdin.isTTY || Bun.stdin.size === 0) {
     return null;
   }
 
@@ -157,11 +162,14 @@ function parseArgs() {
   const args = process.argv.slice(2);
   let input: string | undefined;
   let full = false;
+  let help = false
   let json: false | "plain" | "color" = false;
 
   for (const arg of args) {
     if (arg === "--full" || arg === "-f") {
       full = true;
+    } else if (arg === "--help" || arg === "-h") {
+      help = true;
     } else if (arg === "--json") {
       json = "plain";
     } else if (arg === "--json=color") {
@@ -171,7 +179,7 @@ function parseArgs() {
     }
   }
 
-  return { input, full, json };
+  return { input, full, json, help };
 }
 
 const DEFAULT_LIMIT = 100;
@@ -199,9 +207,9 @@ function outputJson(data: unknown, color: boolean) {
 }
 
 async function main() {
-  const { input, full, json } = parseArgs();
+  const { input, full, json, help } = parseArgs();
 
-  if (!input && !process.env.DATABASE_URL) {
+  if ((!input && !process.env.DATABASE_URL) || help) {
     showUsageAndExit();
   }
 
@@ -238,7 +246,7 @@ async function main() {
 
   let sql: InstanceType<typeof Bun.SQL>;
   try {
-    sql = createConnection(connectionInput);
+    sql = createConnection(connectionInput, { readonly: Bun.stdin.size == 0 });
   } catch (error) {
     console.error("Failed to connect:");
     console.error(error instanceof Error ? error.message : String(error));