Fix README typos and tweak open-sourcing configs

.eslintrc.base.js

@@ -38,6 +38,7 @@ module.exports = (projectRoot, extraRules = {}) => ({
     "typescript-enum",
     "typescript-sort-keys",
     "unused-imports",
+    "no-only-tests",
   ],
   settings: {
     react: {
@@ -109,6 +110,10 @@ module.exports = (projectRoot, extraRules = {}) => ({
     "@typescript-eslint/no-useless-constructor": ["error"],
     "@typescript-eslint/prefer-optional-chain": ["error"],
     "@typescript-eslint/consistent-type-imports": ["error"],
+    "@typescript-eslint/require-array-sort-compare": [
+      "error",
+      { ignoreStringArrays: true },
+    ],
     eqeqeq: ["error"],
     "object-shorthand": ["error", "always"],
     "@typescript-eslint/unbound-method": ["error"],
@@ -430,6 +435,9 @@ module.exports = (projectRoot, extraRules = {}) => ({
     ],
 
     quotes: ["error", "double", { avoidEscape: true }],
+
+    "no-only-tests/no-only-tests": "error",
+
     ...extraRules,
   },
 });

.prettierrc

@@ -0,0 +1,8 @@
+{
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx"],
+      "options": { "parser": "typescript" }
+    }
+  ]
+}

README.md

@@ -23,13 +23,13 @@ Each micro-shard can either be "active" or "inactive".
 The library exposes low-level API for other higher-level tools as PG functions:
 
 - `sharding_list_active_shards()`: returns the list of "active" shards
-- `sharding_ensure_exist()`: allocates a new range micro-shard
+- `sharding_ensure_exist()`: allocates a new range of micro-shards
 - `sharding_ensure_active()`: activates a range of micro-shards
 - `sharding_ensure_inactive()`: deactivates a range of micro-shards
 - `sharding_ensure_absent()`: drops a range of micro-shards
 - `sharding_do_on_each()`: a helper function to run an SQL query on all shards
-- `sharding_debug_fdw_create()`: creates "debug foreign shards schemas" for each host in the list.
-- `sharding_debug_fds_drop()`: drops all debug foreign shards schemas previously created.
+- `sharding_debug_fdw_create()`: creates "debug foreign shards schemas" for each host in the list
+- `sharding_debug_fdw_drop()`: drops all debug foreign shards schemas previously created
 - `sharding_debug_views_create()`: creates "debug views" for tables in all
   micro-shards which unions SELECTs from the same-named tables in all shards
   (not used in production, only for debugging purposes)

docker-compose.postgres.yml

@@ -1,4 +1,3 @@
-version: "3.4"
 services:
   postgres:
     image: postgres:16

docs/README.md

@@ -25,13 +25,13 @@ Each micro-shard can either be "active" or "inactive".
 The library exposes low-level API for other higher-level tools as PG functions:
 
 - `sharding_list_active_shards()`: returns the list of "active" shards
-- `sharding_ensure_exist()`: allocates a new range micro-shard
+- `sharding_ensure_exist()`: allocates a new range of micro-shards
 - `sharding_ensure_active()`: activates a range of micro-shards
 - `sharding_ensure_inactive()`: deactivates a range of micro-shards
 - `sharding_ensure_absent()`: drops a range of micro-shards
 - `sharding_do_on_each()`: a helper function to run an SQL query on all shards
-- `sharding_debug_fdw_create()`: creates "debug foreign shards schemas" for each host in the list.
-- `sharding_debug_fds_drop()`: drops all debug foreign shards schemas previously created.
+- `sharding_debug_fdw_create()`: creates "debug foreign shards schemas" for each host in the list
+- `sharding_debug_fdw_drop()`: drops all debug foreign shards schemas previously created
 - `sharding_debug_views_create()`: creates "debug views" for tables in all
   micro-shards which unions SELECTs from the same-named tables in all shards
   (not used in production, only for debugging purposes)

internal/clean.sh

@@ -1,4 +1,4 @@
 #!/bin/bash
 set -e
 
-rm -rf dist yarn.lock package-lock.json pnpm-lock.yaml *.log
+rm -rf dist yarn.lock package-lock.json pnpm-lock.yaml node_modules ./*.log

internal/with-docker-compose-up.postgres.sh

@@ -1,15 +1,20 @@
 #!/bin/bash
 set -e
 
-docker-compose -f docker-compose.postgres.yml up --quiet-pull -d
+docker compose -f docker-compose.postgres.yml up --quiet-pull -d
 
-for i in $(seq 1 20); do
-  docker-compose -f docker-compose.postgres.yml ps | grep -q healthy && break
+for _i in $(seq 1 20); do
+  docker compose -f docker-compose.postgres.yml ps | grep -q healthy && break
   sleep 1
 done
 
 export PGHOST=127.0.0.1
 export PGDATABASE=postgres
 export PGUSER=postgres
 export PGPASSWORD=postgres
-eval "$1"
+
+# Run "$1" as a bash command (possibly with && in it) and pass $2, $3, ... as
+# properly quoted arguments to it.
+cmd="$1"
+shift
+eval "$cmd \"\$@\""

jest.config.base.js

@@ -0,0 +1,13 @@
+"use strict";
+module.exports = {
+  roots: ["<rootDir>/src"],
+  testMatch: ["**/*.test.ts"],
+  clearMocks: true,
+  restoreMocks: true,
+  ...(process.env.IN_JEST_PROJECT
+    ? {}
+    : { forceExit: true, testTimeout: 30000 }),
+  transform: {
+    "\\.ts$": "ts-jest",
+  },
+};

jest.config.js

@@ -1,13 +1,2 @@
 "use strict";
-module.exports = {
-  roots: ["<rootDir>/src"],
-  testMatch: ["**/*.test.ts"],
-  clearMocks: true,
-  restoreMocks: true,
-  ...(process.env.IN_JEST_PROJECT
-    ? {}
-    : { forceExit: true, testTimeout: 30000, forceExit: true }),
-  transform: {
-    "\\.ts$": "ts-jest",
-  },
-};
+module.exports = { ...require("./jest.config.base") };

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@clickup/pg-sharding",
   "description": "Micro-shards support for PostgreSQL",
-  "version": "2.10.296",
+  "version": "2.10.297",
   "license": "MIT",
   "keywords": [
     "postgresql",
@@ -19,7 +19,7 @@
     "build": "tsc",
     "dev": "tsc --watch --preserveWatchOutput",
     "lint": "bash internal/lint.sh",
-    "test": "PGPORT=54833 bash internal/with-docker-compose-up.postgres.sh 'jest && for f in sql/__tests__/test_*.sql; do echo == $f; echo; psql -f $f; echo; echo; done'",
+    "test": "PGPORT=54833 bash internal/with-docker-compose-up.postgres.sh 'jest && for f in sql/__tests__/test_*.sql; do echo == $f; echo; psql -f $f; echo; echo; done;'",
     "psql": "PGPORT=54833 bash internal/with-docker-compose-up.postgres.sh psql",
     "docs": "bash internal/docs.sh",
     "clean": "bash internal/clean.sh",
@@ -50,6 +50,7 @@
     "eslint-import-resolver-typescript": "^3.5.5",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-lodash": "^7.4.0",
+    "eslint-plugin-no-only-tests": "^3.1.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-react": "^7.32.2",

tsconfig.json

@@ -1,4 +1 @@
-{
-  "extends": "./tsconfig.base.json",
-  "include": ["src/**/*"]
-}
+{ "extends": "./tsconfig.base.json" }