Site build error under Windows

[chalin]

Originally posted by @Chinwendu20 in #2094 (comment):

Trying to submit a PR, after cloning the repo and running an npm install, I get this error:

I have posted this on the slack group, would be grateful for any help that I get

[chalin]

@svrnm added:

https://cloud-native.slack.com/archives/C02UN96HZH6/p1671184942392839 leaving the discussion on the npm install here for reference.

[chalin]

AFAIK, this is an issue under Windows only. The site builds fine under, e.g., GitPod.

[cartermp]

FWIW I did notice this in gitpod as well several months ago, but I think it had to do with something on their end.

[chalin]

Note to self: consider fixing this on the Docsy / docsy-example side first (because the scripts are simpler).

[svrnm]

During Outreachy we figured out some improvements for developing on windows, we need to add that to the documentation still, cc @theletterf

[snehaio]

Hi @svrnm ,I’d like to contribute to opentelemetry.io, but I’m having trouble setting up the repository locally on Windows. I also tried using WSL, but the issue persists. Could you please assist me with this?

[svrnm]

Hi @svrnm ,I’d like to contribute to opentelemetry.io, but I’m having trouble setting up the repository locally on Windows. I also tried using WSL, but the issue persists. Could you please assist me with this?

linking to @theletterf's recommendation:

https://cloud-native.slack.com/archives/C02UN96HZH6/p1727881787891549?thread_ts=1727805453.507049&cid=C02UN96HZH6

Folks, most script won't work when running npm on Windows. That's because they use Bash.
If you're on Windows, I strongly recommend that you use Ubuntu through WSL2 as explained in this guide: https://documentation.ubuntu.com/wsl/en/latest/guides/install-ubuntu-wsl2/

I am not a windows user myself, so I can not confirm if this helps or not, but please give it a try.

[chalin]

Originally posted by @trask in #5980 (comment)

Next time maybe consider locally (and temporarily) replacing npx prettier${PRETTIER_AT_VERS} by npx prettier@latest.

this worked! thanks

@trask - would it help (under a Windows environment) if I put npx prettier${PRETTIER_AT_VERS} in a bash script and called that instead?

[trask]

where does PRETTIER_AT_VERS come from when not on Windows? I only see it referenced in GitHub workflows

[chalin]

The variable is only set viA the workflow, as a hack to only get the Prettier package rather than all NPM package dependencies when running the format check workflow.

[trask]

I see, so when you run it on Mac, even when PRETTIER_AT_VERS isn't set, it's replaced (with empty) in the package.json file, while when I run it on Windows it's not getting replaced in the package.json file for some reason, and so I get the error

Invalid tag name "prettier${PRETTIER_AT_VERS}" of package "prettier${PRETTIER_AT_VERS}"

[trask]

I guess I didn't quite follow your proposal above

would it help (under a Windows environment) if I put npx prettier${PRETTIER_AT_VERS} in a bash script and called that instead?

I'm happy to test anything