feat: Prettify URLs

[franky47]

Don't URL-encode safe characters, and fix the array parser logic.

Proposed encoding, compared with built-in solutions:

┌──────┬──────────────────┬────────────────┬────────────────────┐
│ char │ encodeQueryValue │ encodeURI      │ encodeURIComponent │
├──────┼──────────────────┼────────────────┼────────────────────┤
│  !   │   !              │   !            │   !                │
│  "   │          %22     │          %22   │          %22       │
│  #   │          %23     │   #            │          %23       │
│  $   │   $              │   $            │          %24       │
│  %   │          %25     │          %25   │          %25       │
│  &   │          %26     │   &            │          %26       │
│  '   │          %27     │   '            │   '                │
│  (   │   (              │   (            │   (                │
│  )   │   )              │   )            │   )                │
│  *   │   *              │   *            │   *                │
│  +   │          %2B     │   +            │          %2B       │
│  ,   │   ,              │   ,            │          %2C       │
│  -   │   -              │   -            │   -                │
│  .   │   .              │   .            │   .                │
│  /   │   /              │   /            │          %2F       │
│  :   │   :              │   :            │          %3A       │
│  ;   │   ;              │   ;            │          %3B       │
│  <   │          %3C     │          %3C   │          %3C       │
│  =   │   =              │   =            │          %3D       │
│  >   │          %3E     │          %3E   │          %3E       │
│  ?   │   ?              │   ?            │          %3F       │
│  @   │   @              │   @            │          %40       │
│  [   │   [              │          %5B   │          %5B       │
│  \   │   \              │          %5C   │          %5C       │
│  ]   │   ]              │          %5D   │          %5D       │
│  ^   │   ^              │          %5E   │          %5E       │
│  _   │   _              │   _            │   _                │
│  `   │          %60     │          %60   │          %60       │
│  {   │   {              │          %7B   │          %7B       │
│  |   │   |              │          %7C   │          %7C       │
│  }   │   }              │          %7D   │          %7D       │
│  ~   │   ~              │   ~            │   ~                │
└──────┴──────────────────┴────────────────┴────────────────────┘

Explanation:

• + is encoded as %2B in order not to be confused with a space according to RFC-3986. Equally, spaces will be changed to + (not shown here)
• % are encoded to avoid being interpreted as incomplete escape sequences
• # is encoded to avoid being interpreted as the URL hash and breaking the query string
• & is encoded to avoid being interpreted as a query entry separator
• ", ' and backtick are encoded to avoid breaking URLs when pasted as-is in editors that detect them and emit an anchor tag (social networks, messaging apps).

Compared to encodeURI, the following characters are un-encoded: [\]^{|}. Brackets are particularly useful to keep "pretty" in order to identify arrays or objects when using the JSON parser.

Closes #355.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
next-usequerystate	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 23, 2023 3:25pm

[sladjanstojcic]

When do we think this could go live? I am doing a project with this and literary want to replace it with a diff library due to encoding/ugly URLs lol

[franky47]

Can you give 1.9.0-beta.1 a try and see if the encoding works out for you?

[sladjanstojcic]

Can you give 1.9.0-beta.1 a try and see if the encoding works out for you?

Will do, later today or tomorrow morning.

[sladjanstojcic]

@franky47 I tried it and everything works, will use it to finish the project.

[franky47]

@sladjanstojcic Thanks for your feedback, 1.9.0 should be landing soon.

[github-actions]

🎉 This PR is included in version 1.9.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀