Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proper docs for windows option?? #226

Open
webketje opened this issue Nov 25, 2021 · 0 comments
Open

Proper docs for windows option?? #226

webketje opened this issue Nov 25, 2021 · 0 comments

Comments

@webketje
Copy link

The documented posixSlashes (or outdated unixify) options do nothing.
The only way the docs provide a way not to convert the backslashes into forward slashes is by providing a custom format function.
But that is awkward to use as the docs discourage replacing backslashes with forward slashes explicitly.

What should be happening?

  • Remove any mentions to posixSlashes and unixify in the docs
  • Add docs for the windows option

This issue has come up twice on picomatch and there is even a commit that fixes it
micromatch/picomatch@dbe5d92, however it seems not to be included in the master branch.

I lost an hour debugging this thinking there was something wrong at my end, and it's all the more strange that the picomatch changelog mentions a switch from unixify to windows since 2019 (!) but nothing about posixSlashes?

FWIW I thought posixSlashes was a much more declarative name for the option.
PS: there's a typo in the examples under posixSlashes that says require ('picomatch')

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant