@prairielearn/postgres 2.0.3 → 2.1.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @prairielearn/postgres
 
+## 2.1.0
+
+### Minor Changes
+
+- 1de33d9: Add `formatQueryWithErrorPosition` function
+
 ## 2.0.3
 
 ### Patch Changes

package/dist/error.d.ts

@@ -0,0 +1 @@
+export declare function formatQueryWithErrorPosition(query: string, position: number | null | undefined): string;

package/dist/error.js

@@ -0,0 +1,19 @@
+export function formatQueryWithErrorPosition(query, position) {
+    if (position == null)
+        return query;
+    const prevNewline = Math.max(0, query.lastIndexOf('\n', position) + 1);
+    let nextNewline = query.indexOf('\n', position);
+    if (nextNewline < 0)
+        nextNewline = query.length;
+    const gap = ' '.repeat(Math.max(0, position - prevNewline - 1));
+    return (query.substring(0, nextNewline) +
+        '\n' +
+        gap +
+        '^\n' +
+        gap +
+        '|\n' +
+        gap +
+        '+ ERROR POSITION SHOWN ABOVE\n' +
+        query.substring(nextNewline));
+}
+//# sourceMappingURL=error.js.map

package/dist/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,4BAA4B,CAAC,KAAa,EAAE,QAAmC;IAC7F,IAAI,QAAQ,IAAI,IAAI;QAAE,OAAO,KAAK,CAAC;IAEnC,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IACvE,IAAI,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAChD,IAAI,WAAW,GAAG,CAAC;QAAE,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC;IAChD,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,GAAG,WAAW,GAAG,CAAC,CAAC,CAAC,CAAC;IAChE,OAAO,CACL,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,WAAW,CAAC;QAC/B,IAAI;QACJ,GAAG;QACH,KAAK;QACL,GAAG;QACH,KAAK;QACL,GAAG;QACH,gCAAgC;QAChC,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC,CAC7B,CAAC;AACJ,CAAC","sourcesContent":["export function formatQueryWithErrorPosition(query: string, position: number | null | undefined) {\n  if (position == null) return query;\n\n  const prevNewline = Math.max(0, query.lastIndexOf('\\n', position) + 1);\n  let nextNewline = query.indexOf('\\n', position);\n  if (nextNewline < 0) nextNewline = query.length;\n  const gap = ' '.repeat(Math.max(0, position - prevNewline - 1));\n  return (\n    query.substring(0, nextNewline) +\n    '\\n' +\n    gap +\n    '^\\n' +\n    gap +\n    '|\\n' +\n    gap +\n    '+ ERROR POSITION SHOWN ABOVE\\n' +\n    query.substring(nextNewline)\n  );\n}\n"]}

package/dist/error.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/error.test.js

@@ -0,0 +1,9 @@
+import { assert } from 'chai';
+import { formatQueryWithErrorPosition } from './error.js';
+describe('formatQueryWithErrorPosition', () => {
+    it('formats a query', () => {
+        const formattedQuery = formatQueryWithErrorPosition('SELECT\n  foo bar baz\nFROM table;', 18);
+        assert.equal(formattedQuery, 'SELECT\n  foo bar baz\n          ^\n          |\n          + ERROR POSITION SHOWN ABOVE\n\nFROM table;');
+    });
+});
+//# sourceMappingURL=error.test.js.map

package/dist/error.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.test.js","sourceRoot":"","sources":["../src/error.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAE9B,OAAO,EAAE,4BAA4B,EAAE,MAAM,YAAY,CAAC;AAE1D,QAAQ,CAAC,8BAA8B,EAAE,GAAG,EAAE;IAC5C,EAAE,CAAC,iBAAiB,EAAE,GAAG,EAAE;QACzB,MAAM,cAAc,GAAG,4BAA4B,CAAC,oCAAoC,EAAE,EAAE,CAAC,CAAC;QAC9F,MAAM,CAAC,KAAK,CACV,cAAc,EACd,wGAAwG,CACzG,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { assert } from 'chai';\n\nimport { formatQueryWithErrorPosition } from './error.js';\n\ndescribe('formatQueryWithErrorPosition', () => {\n  it('formats a query', () => {\n    const formattedQuery = formatQueryWithErrorPosition('SELECT\\n  foo bar baz\\nFROM table;', 18);\n    assert.equal(\n      formattedQuery,\n      'SELECT\\n  foo bar baz\\n          ^\\n          |\\n          + ERROR POSITION SHOWN ABOVE\\n\\nFROM table;',\n    );\n  });\n});\n"]}

package/dist/index.d.ts

@@ -2,4 +2,5 @@ export { type PoolClient } from 'pg';
 export { loadSql, loadSqlEquiv } from './loader.js';
 export { PostgresPool, PostgresPoolConfig } from './pool.js';
 export * from './default-pool.js';
+export { formatQueryWithErrorPosition } from './error.js';
 export { makePostgresTestUtils, type PostgresTestUtils, type PostgresTestUtilsOptions, } from './test-utils.js';

package/dist/index.js

@@ -1,5 +1,6 @@
 export { loadSql, loadSqlEquiv } from './loader.js';
 export { PostgresPool } from './pool.js';
 export * from './default-pool.js';
+export { formatQueryWithErrorPosition } from './error.js';
 export { makePostgresTestUtils, } from './test-utils.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,YAAY,EAAsB,MAAM,WAAW,CAAC;AAE7D,cAAc,mBAAmB,CAAC;AAElC,OAAO,EACL,qBAAqB,GAGtB,MAAM,iBAAiB,CAAC","sourcesContent":["export { type PoolClient } from 'pg';\n\nexport { loadSql, loadSqlEquiv } from './loader.js';\nexport { PostgresPool, PostgresPoolConfig } from './pool.js';\n\nexport * from './default-pool.js';\n\nexport {\n  makePostgresTestUtils,\n  type PostgresTestUtils,\n  type PostgresTestUtilsOptions,\n} from './test-utils.js';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,YAAY,EAAsB,MAAM,WAAW,CAAC;AAE7D,cAAc,mBAAmB,CAAC;AAElC,OAAO,EAAE,4BAA4B,EAAE,MAAM,YAAY,CAAC;AAE1D,OAAO,EACL,qBAAqB,GAGtB,MAAM,iBAAiB,CAAC","sourcesContent":["export { type PoolClient } from 'pg';\n\nexport { loadSql, loadSqlEquiv } from './loader.js';\nexport { PostgresPool, PostgresPoolConfig } from './pool.js';\n\nexport * from './default-pool.js';\n\nexport { formatQueryWithErrorPosition } from './error.js';\n\nexport {\n  makePostgresTestUtils,\n  type PostgresTestUtils,\n  type PostgresTestUtilsOptions,\n} from './test-utils.js';\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prairielearn/postgres",
-  "version": "2.0.3",
+  "version": "2.1.0",
   "type": "module",
   "main": "./dist/index.js",
   "repository": {

package/src/error.test.ts

@@ -0,0 +1,13 @@
+import { assert } from 'chai';
+
+import { formatQueryWithErrorPosition } from './error.js';
+
+describe('formatQueryWithErrorPosition', () => {
+  it('formats a query', () => {
+    const formattedQuery = formatQueryWithErrorPosition('SELECT\n  foo bar baz\nFROM table;', 18);
+    assert.equal(
+      formattedQuery,
+      'SELECT\n  foo bar baz\n          ^\n          |\n          + ERROR POSITION SHOWN ABOVE\n\nFROM table;',
+    );
+  });
+});

package/src/error.ts

@@ -0,0 +1,19 @@
+export function formatQueryWithErrorPosition(query: string, position: number | null | undefined) {
+  if (position == null) return query;
+
+  const prevNewline = Math.max(0, query.lastIndexOf('\n', position) + 1);
+  let nextNewline = query.indexOf('\n', position);
+  if (nextNewline < 0) nextNewline = query.length;
+  const gap = ' '.repeat(Math.max(0, position - prevNewline - 1));
+  return (
+    query.substring(0, nextNewline) +
+    '\n' +
+    gap +
+    '^\n' +
+    gap +
+    '|\n' +
+    gap +
+    '+ ERROR POSITION SHOWN ABOVE\n' +
+    query.substring(nextNewline)
+  );
+}

package/src/index.ts

@@ -5,6 +5,8 @@ export { PostgresPool, PostgresPoolConfig } from './pool.js';
 
 export * from './default-pool.js';
 
+export { formatQueryWithErrorPosition } from './error.js';
+
 export {
   makePostgresTestUtils,
   type PostgresTestUtils,