ljharb/qs

Add the ability to enable strict RFC 3986 conformance for decoding as well as encoding

Open

#205 ouverte le 10 avr. 2017

Voir sur GitHub
 (1 commentaire) (5 réactions) (0 assignés)JavaScript (8 015 stars) (744 forks)batch import
enhancementhelp wantedparsesemver-minor: new features

Description

To achieve strict RFC 3986 conformance (specifically, '+' in query strings is a LITERAL '+' and not a placeholder for ' ' as per the W3C's URL recommendations, the following is necessary:

qs.parse(s, {
    decoder: (str) => {
        try {
            return decodeURIComponent(str);
        } catch (e) {
            return str;
        }
    },
})

For those of us who prefer strict RFC 3986 conformance, I suggest an option like:

qs.parse(s, {
    format: 'RFC3986',
})

which would be much more concise and not require knowing the implementation details of the default decode function.

Guide contributeur

Stack technique
javascriptnodejs
Domaine
apibackend
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 days
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
understanding of RFC 3986basic JavaScriptfamiliarity with qs library
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
55
Direction de recherche
To implement this feature, examine the current decode function in lib/parse.js and add a 'format' option that, when set to 'RFC3986', uses decodeURIComponent for decoding. Ensure that the default behavior (legacy mode) remains unchanged. Consider adding tests in test/parse.js to verify conformance. The issue suggests a concise API, so the solution should be localized to the parse function and its options.