mathiasbynens / mathiasbynens/punycode.js

Indicate nameprep support

Open
#40 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
1.7k
Forks
170
PR merge metrics
No merged PRs in 30d

Description

IDN labels are supposed to be normalized using nameprep before being converted into punycode. nameprep is what enables case-insensitive comparisons of IDN labels, the removal of invalid characters, detection of bidirectional strings, and more.

Does punycode.js support normalization via nameprep? No.

Add documentation to warn users.

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 by locating the project's user-facing documentation and review the nameprep requirement in RFC 3491. Add a clear warning that punycode.js does not provide nameprep normalization, including its implications for IDN labels, then verify the documentation accurately reflects the limitation.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.