Skip to content

chore: follow-up from PR #46 — feat(pg-node): add Node.js example using @e4a/pg-js #47

@dobby-coder

Description

@dobby-coder

Non-blocking review items left unaddressed when #46 was merged. Captured here so they don't get lost.

Items

1. pg-node/README.md:11 — inline-header list style

The **Send** (…) — encrypts … / **Upload-only** (…) — same encryption … pattern hits writing-rules #48 (inline header + colon/dash + sentence) plus the em-dash overuse tell (#40). Reads cleaner as plain sentences or a small table. Stylistic only — main concern is it doesn't get copy-pasted into future example READMEs.

Original comment: #46 (comment)

2. pg-node/README.md:31 — em-dash density

~10 em-dashes across 75 lines is on the high side. A few replace cleanly with a period or parentheses (e.g. Mirrors the pg-sveltekit example's flow — drop-in starting point… → two sentences). Stylistic only.

Original comment: #46 (comment)

3. README.md:30 — stale Node version reference (root README)

Root README still advertises Node.js 20.6+ for the Node.js example, but pg-node/package.json now requires node >= 22. Recommend bumping the root README line to Node.js 22+ to match pg-node/README.md:16.

Original comment: #46 (comment)

4. pg-node/src/config.mjs:1-2 — stale Node version comment

The header comment still says Run with node --env-file=.env index.mjs … (Node 20.6+), but package.json scripts use --env-file-if-exists (Node 21.7+) and engines.node is >=22. Suggest: // from .env (Node 22+). Mirrors pg-sveltekit's config.ts. and drop the node --env-file=… snippet since the scripts already wire it up.

Original comment: #46 (comment)


Merged PR: #46

Metadata

Metadata

Assignees

No one assigned

    Labels

    choreRoutine maintenance

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions