qlcodes 1.1.2 → 1.1.4

package/README.md

@@ -2,24 +2,16 @@
 
 A small utility that unifies SQL codes describing states (SQLSTATE) from different DBMS into a single, normalized structure through a curated dataset constructed at build time.
 
-The module is built from authoritative vendor documentation (IBM, PostgreSQL, Oracle) and generates static reference data at build time. Find references bellow.
-
-## References
-
-- IBM
-  [Listing of SQLSTATE values](https://www.ibm.com/docs/en/i/7.6.0?topic=codes-listing-sqlstate-values#cc__classcode00)
-  (Last Updated: 2025-09-29)
-
-- Postgres codes
-  [Appendix A. PostgreSQL Error Codes](https://www.postgresql.org/docs/10/static/errcodes-appendix.html)
-  (V.10)
+The module is built from authoritative vendor documentation (IBM, PostgreSQL, Oracle) and generates static reference data at build time. [Find references bellow](/#user-content-references).
 
+## SQLSTATES coverage
 
-- Oracle
-  [Oracle appendix](https://docs.oracle.com/cd/E15817_01/appdev.111/b31228/appd.htm)
-  11g Release 1 (11.1)
+The project aims to cover sql states for most of RDBMS [drivers supported by **Typeorm** such as Google Spanner](https://typeorm.io/docs/drivers/google-spanner).
+Find bellow the actual coverage:
 
----
+🕓 MySQL | 🕓 MariaDB | ✅ PostgreSQL | 🕓 CockroachDB (Postgres-compatible)
+🕓 Microsoft SQL Server | ✅ Oracle | 🕓 SQLite | 🕓 SAP HANA | 🕓 Google Spanner | ✅ IBM*
+>( \* ) IBM defines and publishes SQLSTATE codes as part of the SQL standard, so their The codes should covere IBM products such as DB2, IBM Informix, IBM Netezza, IBM i (AS/400) .
 
 ## Installation
 
@@ -116,6 +108,7 @@ Output:
 ## API
 
 `lens(code: string): QLLens`
+
 |Parameters|Returns|
 |-|-|
 |**code** SQLSTATE status code | A structured status description|
@@ -151,25 +144,46 @@ $ npm install
 > unless you know what you know what you are doing.
 
 3) Rebuild the module
+
 ```bash
 $ npm run build
 ```
 
 ### Quality of life
+
 You may pass argument to the build script to enforce a few behaviours to help you seing through the process...
+
 |argument|effect|
 |-|-|
 |`--debug`|prevents the cleanup of middle stage file created during the data processing|
 |`--make-keys`|allows the creation of keys when a description is given...through the 'generate' step (`generate.cjs`)|
 
-
-
 Use your customized build via a local dependency or a forked package.
 
 ---
-## Showcase 
+
+## Showcase
+
 [in stackblitz](https://stackblitz.com/edit/stackblitz-starters-vjcs3q7x?file=index.js)
+
+---
+
+## References
+
+- IBM
+  [Listing of SQLSTATE values](https://www.ibm.com/docs/en/i/7.6.0?topic=codes-listing-sqlstate-values#cc__classcode00)
+  (Last Updated: 2025-09-29)
+
+- Postgres codes
+  [Appendix A. PostgreSQL Error Codes](https://www.postgresql.org/docs/10/static/errcodes-appendix.html)
+  (V.10)
+
+- Oracle
+  [Oracle appendix](https://docs.oracle.com/cd/E15817_01/appdev.111/b31228/appd.htm)
+  11g Release 1 (11.1)
+
 ---
 
 ## License
+
 [MIT 2025](https://github.com/ManuUseGitHub/QLCodes?tab=MIT-1-ov-file#readme)

package/build.sh

@@ -99,7 +99,7 @@ node generate.cjs --flag "oracle"> "$DIR/output3.txt"
 echo -e "$CHECK done"
 
 echo -e "${BLUE}Composition of the JSON file at $DIR/qlCodes.json${NC}"
-echo {} | node compose.mjs --file "$DIR/output1.txt"|\
+node compose.mjs --file "$DIR/output1.txt"|\
 node compose.mjs --file "$DIR/output2.txt" |\
 node compose.mjs --file "$DIR/output3.txt" |\
 node pretty.mjs --file "$DIR/qlCodes.json"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qlcodes",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "main": "src/index.mjs",
   "scripts": {
     "build": "chmod +x ./build.sh; ./build.sh"
@@ -23,5 +23,10 @@
   ],
   "repository": {
     "url": "git+https://github.com/ManuUseGitHub/QLCodes.git"
+  },
+  "dependencies": {
+    "onstdin": "^1.0.0",
+    "reargv": "^1.0.2",
+    "to-snake-case": "^1.0.0"
   }
 }

package/src/compose.mjs

@@ -1,7 +1,7 @@
 import fs from "fs";
-import { onStdIn } from "./utils/io.mjs";
+import { onstdin } from "onstdin";
 import { CODE_RE, CLASS_RE, COMMENT_RE } from "./regex.mjs";
-import { reargv } from "./utils/args.mjs";
+import { reargv } from "reargv";
 const argv = reargv();
 function flushBuffer(buffer, currentClass, currentCode) {
 	if (!buffer.length) return buffer;
@@ -95,10 +95,11 @@ const debugInFile = (file, data = null) => {
 if (argv.options.file || argv.files.length) {
 	const file = argv.options.file || argv.files[0];
 
-	onStdIn((content) => {
+	onstdin((content) => {
 		const isDebug = process.env.DEBUG;
 		let states;
 		try {
+			debugInFile(file, `content!${content}!`);
 			states = JSON.parse(content ? content : "{}");
 		} catch {
 			states = {};

package/src/fileTransformer/sanitize.mjs

@@ -1,6 +1,6 @@
-import { onStdIn } from "../utils/io.mjs";
+import { onstdin } from "onstdin";
 
-onStdIn((input) => {
+onstdin((input) => {
 	console.log(
 		input
 			.replaceAll("SQLSTATE Value;Meaning", "")

package/src/fileTransformer/sanitize2.mjs

@@ -1,7 +1,7 @@
 import { insertHeadersAndFormat } from "../utils/codeName.mjs";
-import { onStdIn } from "../utils/io.mjs";
+import { onstdin } from "onstdin";
 
-onStdIn((input) => {
+onstdin((input) => {
 	console.log(
 		insertHeadersAndFormat(
 			input

package/src/fileTransformer/stopNamedKeys.mjs

@@ -1,6 +1,6 @@
-import { onStdIn } from "../utils/io.mjs";
+import { onstdin } from "onstdin";
 
-onStdIn((input) => {
+onstdin((input) => {
 	console.log(
 		input
 			.replaceAll(/ use_of_| the_| an_| a_|for_the_|_the|of_the_/gm, "")

package/src/generate.cjs

@@ -1,8 +1,8 @@
 const fs = require("fs");
 const { ERROR_CODE_HEADER_RGX } = require("./regex.mjs");
 const { newCode } = require("./utils/codeName.mjs");
-const { reargv } = require("./utils/args.mjs");
-const { onStdIn } = require("./utils/io.mjs");
+const { onstdin } = require("onstdin");
+const { reargv } = require("reargv");
 
 const argv = reargv();
 
@@ -36,7 +36,7 @@ if (argv.options.file || argv.files.length) {
 	const file = argv.options.file || argv.files[0];
 	console.log(processCSVLines(fs.readFileSync(file, "utf8")));
 } else {
-	onStdIn((csv) => {
+	onstdin((csv) => {
 		console.log(processCSVLines(csv));
 	});
 }

package/src/pretty.mjs

@@ -1,6 +1,6 @@
 import fs from "fs";
-import { reargv } from "./utils/args.mjs";
-import { onStdIn } from "./utils/io.mjs";
+import { onstdin } from "onstdin";
+import { reargv } from "reargv";
 
 const isDebug = process.env.DEBUG === "true";
 const argv = reargv();
@@ -8,7 +8,7 @@ const argv = reargv();
 if (argv.options.file || argv.files.length) {
 	const file = argv.options.file || argv.files[0];
 
-	onStdIn((content) => {
+	onstdin((content) => {
 		fs.writeFile(
 			file,
 			JSON.stringify(JSON.parse(content), null, isDebug ? 2 : undefined),

package/src/readFile.mjs

@@ -1,4 +1,4 @@
 import fs from "fs";
-import { reargv } from "./utils/args.mjs";
+import { reargv } from "reargv";
 
 console.log(fs.readFileSync(reargv().files[0], "utf8"));

package/src/utils/codeName.mjs

@@ -1,5 +1,5 @@
-import { reargv } from "./args.mjs";
-import { toSnakeCase } from "./str.mjs";
+import { reargv } from "reargv";
+import toSnakeCase from "to-snake-case";
 
 const argv = reargv();
 

package/src/utils/args.mjs

@@ -1,32 +0,0 @@
-export const reargv = () => {
-	const args = process.argv.slice(2);
-	const argvs = { misc: [], options: {}, files: [] };
-	const len = args.length;
-	let jump = 0;
-	for (const [i, arg] of args.entries()) {
-		if (jump) {
-			jump--;
-			continue;
-		}
-		if (arg.startsWith("--")) {
-            const option = arg.replace(/^-+/g, "");
-			if (i + 1 < len) {
-				const nextArg = args[i + 1];
-				if (!nextArg.startsWith("--")) {
-					argvs.options[option] = args[i + 1];
-					jump++;
-				} else {
-					argvs.options[option] = true;
-					jump++;
-				}
-			} else {
-				argvs.options[option] = true;
-			}
-		} else if (/(\.(?:[a-zA-Z]+)+)$/.test(arg)) {
-			argvs.files.push(arg);
-		} else {
-			argvs.misc.push(arg);
-		}
-	}
-	return argvs;
-};

package/src/utils/io.mjs

@@ -1,11 +0,0 @@
-export const onStdIn = (cb) => {
-	let input = "";
-	process.stdin.setEncoding("utf8");
-	process.stdin.on("data", (chunk) => {
-		input += chunk;
-	});
-
-	process.stdin.on("end", () => {
-		cb(input);
-	});
-};

package/src/utils/str.mjs

@@ -1,5 +0,0 @@
-export const toSnakeCase = (text) =>
-	text
-		.toLowerCase()
-		.replace(/[^a-z0-9]+/g, "_")
-		.replace(/^_|_$/g, "");