search

ljharb / qs

A querystring parser with nesting support
BSD 3-Clause "New" or "Revised" License
8.47k stars 731 forks source link

Is `decodeDotInKeys` meant to be disabled by default? #500

Closed wwaaijer-exh closed 4 months ago

wwaaijer-exh commented 4 months ago

Currently decodeDotInKeys is enabled by default, was this intentional?

We use qs for oAuth1 signature generation, for which it is important to keep keys as they are. By having decodeDotInKeys automatically enabled by default in 6.12.0, keys are implicitly transformed.

We did not pin the exact version of qs, just the major version. The moment 6.12.0 was released, new installations started to break. Following that reasoning, could this be considered a breaking change?

All not that bad though, just something we did not expect to happen. We're still very satisfied qs users!

As a side note, the examples in the docs show how to enable decodeDotInKeys, implying it is disabled by default.

I'm happy to create a PR to either update the default behavior or change the docs.

ljharb commented 4 months ago

I see that it is enabled by default - https://github.com/ljharb/qs/blob/main/lib/parse.js#L17C5-L17C20, and comparing https://github.com/ljharb/qs/blob/main/lib/parse.js#L132 to https://github.com/ljharb/qs/blob/v6.11.2/lib/parse.js#L157, it does seem like this is an unintentional breaking change.

A PR to restore the default and update the relevant test cases (so that the docs are correct) would be very appreciated!