Skip to content

feat: add sanitize-html → neosanitize replacement#780

Open
PuruVJ wants to merge 5 commits into
e18e:mainfrom
PuruVJ:add-sanitize-html-neosanitize
Open

feat: add sanitize-html → neosanitize replacement#780
PuruVJ wants to merge 5 commits into
e18e:mainfrom
PuruVJ:add-sanitize-html-neosanitize

Conversation

@PuruVJ

@PuruVJ PuruVJ commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds sanitize-html to the preferred manifest, with:

  • neosanitize/legacy as a direct, drop-in replacement — a byte-identical port of sanitize-html 2.x (same API, same options, same output), so migration is just an import swap.
  • neosanitize (root module) as the recommended alternative — a fast, browser-faithful WHATWG parser (100% html5lib tokenizer conformance) with a deny-by-default policy, using a builder-pattern API.

Includes a docs/modules/sanitize-html.md page with migration examples for both engines.

Migration

// Zero-change drop-in
import sanitizeHtml from 'sanitize-html'      // before
import sanitizeHtml from 'neosanitize/legacy' // after

Notes

  • Placed in preferred (performance/footprint replacement — not native, not a micro-utility).
  • Both replacements are represented as documented entries; the mapping points to the new e18e doc page.
  • pnpm lint passes (JSON schema, sort order, doc-path checks, Prettier).
    Closes [Replacement]: neosanitize #781

Add sanitize-html to the preferred manifest with neosanitize/legacy as a
drop-in replacement and the neosanitize root module (fast WHATWG parser,
deny-by-default) as the recommended alternative. Includes docs page.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@PuruVJ

PuruVJ commented Jul 6, 2026

Copy link
Copy Markdown
Contributor Author

Retargeting to my fork instead.

PuruVJ and others added 3 commits July 6, 2026 23:28
The root module uses Sanitizer.builder(...).build(), not a
sanitize(dirty, options) call. Correct the docs example.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Show how to swap the neosanitize parser via .parser() on the builder,
with parse5 (spec conformance) and htmlparser2 (speed) adapters.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

@gameroman gameroman left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need an issue with the template first

Removed legacy neosanitize module from preferred.json
@PuruVJ PuruVJ requested a review from gameroman July 6, 2026 18:48
@PuruVJ

PuruVJ commented Jul 6, 2026

Copy link
Copy Markdown
Contributor Author

Socket IO already using this lib internally, if the 10k rule isn't a hard-limit for usage: https://x.com/puruvjdev/status/2074181968624066813

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Replacement]: neosanitize

2 participants