docs: enrich READMEs + npm keywords - #2
Merged
Conversation
Adds targeted, non-spammy keywords across the three published packages: the attack class (nosql-injection, operator-injection, prototype-pollution), the ecosystem (mongo, mongoose), the framework majors (express4/5, fastify4/5), and discovery terms (sanitizer, input-validation, web-security, owasp).
Package READMEs (express/fastify): add a concrete login-bypass attack example, a compatibility matrix (framework 4.x+5.x, Node, modules, types), a fuller badge row, ESM/TypeScript usage snippets, and a table of contents. Root README: add a table of contents, a CI-verified compatibility matrix, and Contributing/Security sections pointing at CONTRIBUTING.md and SECURITY.md.
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
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 & why
Documentation and npm-discoverability pass. No code or config changes — READMEs and
keywordsonly.Changes
Keywords (
packages/*/package.json)nosql-injection,operator-injection,prototype-pollution), the ecosystem (mongo,mongoose), the framework majors (express4/5,fastify4/5), and discovery terms (sanitizer,input-validation,web-security,owasp).READMEs
Verification
require()andimportwere both tested empirically against all three packages (default + named imports resolve; functional smoke test{ $ne: '' }→{ ne: '' }passes through the ESM default import). The "CommonJS + ESM" claim in the compatibility tables is verified, not assumed. ESM works via Node's CJS interop over the single CommonJS build — there is no separate.mjsoutput.