vuejs / vuejs/docs

docs: sanitize-url doesn't support `import` (esm)

Open
#3,214 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Vue
Stars
3.2k
Forks
5k
Avg merge
14d 17h
Merged PRs (30d)
1

Description

Issue

In https://vuejs.org/guide/best-practices/security.html#url-injection there's a reference to sanitize-url which doesn't support import (esm)

Solution:

Create a fork and updated it to use import
https://www.npmjs.com/package/@sofuxro/sanitize-url

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the URL Injection section of the security guide at vuejs.org/guide/best-practices/security.html#url-injection and inspect its sanitize-url reference. Compare the documented package with @sofuxro/sanitize-url, then update the documentation so the referenced package supports import (ESM); done means the guide points to the intended compatible package.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.