docs(npm): README for the @extenddb/dev launcher package - #317
Open
LeeroyHannigan wants to merge 4 commits into
Open
docs(npm): README for the @extenddb/dev launcher package#317LeeroyHannigan wants to merge 4 commits into
LeeroyHannigan wants to merge 4 commits into
Conversation
The npm package pages have no README today, the same blank front door the Docker Hub repositories had before their Overviews were published. npm renders the package README from the published tarball and includes README.md automatically regardless of the files whitelist, so this lands on npmjs.com with the next version publish. Content is written against the real launcher API in index.js (start() options, returned shape, stop semantics) rather than from memory, and the quick-start block was executed verbatim against the published 0.1.10 candidate with @aws-sdk/client-dynamodb v3: server starts on an ephemeral port, ListTables succeeds against the returned endpoint/credentials/region, stop() resolves cleanly. The vitest globalSetup example mirrors the pattern verified in earlier launcher testing. Trademark and plain-HTTP security notes match the Docker Hub dev Overview wording.
LeeroyHannigan
requested review from
amrith,
c33howard,
jcshepherd,
pdf-amzn,
robinnsc and
yesyayen
as code owners
August 26, 2026 11:59
The quickstart mixed require() with top-level await, which Node rejects as a file (ERR_AMBIGUOUS_MODULE_SYNTAX on current Node, SyntaxError on older): top-level await is ESM-only while require marks the file CommonJS. Rewritten as an ESM file with imports, executed verbatim as quickstart.mjs against the published 0.1.10 candidate (named import from the CJS module resolves via Node's static export detection; ListTables succeeds; stop resolves). A one-line CommonJS note covers the require-plus-async-wrapper form.
Vitest is ESM-native and the quickstart is already ESM; the test-suite section still showed a CommonJS globalSetup. Converted to an .mjs default export and verified literally: the exact file from this README was extracted and run under a real vitest with globalSetup wired, a test resolving the env-passed endpoint/credentials passed 1/1 against the published 0.1.10 candidate, and the returned teardown stopped the server.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds
packaging/npm/README.md, rendered by npmjs.com on the @extenddb/dev package page (currently blank). Covers the quick-start, the fullstart()options table and returned shape, a Vitest globalSetup pattern for test suites, the supported API surface with a link to the differences doc, and the plain-HTTP/example-credential security note matching the Docker Hub dev Overview.npm includes README.md in the tarball automatically regardless of the
fileswhitelist, so no manifest change is needed. It appears on npmjs.com with the next version publish.Testing done
The quick-start block was executed verbatim against the published 0.1.10 candidate with @aws-sdk/client-dynamodb v3: server starts on an ephemeral port, ListTables succeeds against the returned endpoint/credentials/region, and
stop()resolves cleanly. Options documented from index.js, not memory.