feat: add escape sequence for terminal characters

[mochja]

allows filtering properties that contains special characters ,*()/

use \ (backslash) for escaping such characters:

• foo\/bar, will filter JSON property that matches foo/bar

fixes #164

[mochja]

I think this would introduce breaking change for keys that contain *, e.g.: foo* will now have to be escaped foo\\*, this is due to * character not being considered as a terminal character.

Please let me know if you consider this as an issue.

[nemtsov]

@mochja 🙌 — that's a beautiful PR! Thank you so much for your contribution. I think the escaping looks solid: both in a functional test and statically. The only piece that I'm unsure about is making * a terminal. I have a strong feeling there's a reason you converted it, but I'm not sure what test would fail if you didn't. Can you talk a bit about what issue that solves, please?

[nemtsov]

@mochja heads up—since I was in the code, I did a bit of cleaning and (a) renamed the master branch to main (so you may need to update your local), (b) switched away from the defunct travis-ci.org to GH-actions (so you'll now notice a tiny linting issue in this PR), (c) fixed all the dev-dependencies security issues. So, please rebase off the latest main branch.

[mochja]

@mochja 🙌 — that's a beautiful PR! Thank you so much for your contribution. I think the escaping looks solid: both in a functional test and statically. The only piece that I'm unsure about is making * a terminal. I have a strong feeling there's a reason you converted it, but I'm not sure what test would fail if you didn't. Can you talk a bit about what issue that solves, please?

Thank you!

It allows for escaping * symbol, so you can properly mask object that has star as a key. I believe it can be done differently as well, but will require special handling of the star. I felt like that is really an edge case that is not worth additional complexity.

[mochja]

@nemtsov I reverted the change for making * as a terminal, also fixed issue with escaping backslash keys.

[nemtsov]

This looks really solid. The only blocker I have is the double-escaping of the reverse solidus, which I mentioned below. I opened a PR with your changes in it, and a fix here: #167 — if that looks good to you, I'll merge it. If you want to make some more changes, please feel free to rebase on top of that or implement it your own way, and I'll review. Thank you!

[nemtsov]

@mochja q: the !name.length is for stars that follow characters (e.g. a*), what about stars that precede them (e.g. *a)? Is it intentional that you must escape them now?

(e.g. $ echo '{"*a":1}' | node ./bin/json-mask.js '*a' doesn't work and creates a compiled mask: { '*': { type: 'object', properties: { a: [Object] }, filter: true } } and yet $ echo '{"a*":1}' | node ./bin/json-mask.js 'a*' does work and has a mask: { 'a*': { type: 'object' } })

[mochja]

good catch, this part would have to reworked for this to work, maybe we could use something from #167?

[nemtsov]

Made a few adjustments and I think it's working fully in #167
How does it look to you @mochja ?

[nemtsov]

@mochja this has been published in v2.0.0 (https://github.com/nemtsov/json-mask/releases/tag/v2.0.0)
Thank you for an awesome contribution!