Giters

webhintio / hint

💡 A hinting engine for the web

Home Page:https://webhint.io/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[Docs Bug] Test development environment documentation so a first time contributor can get started quickly

rowlando opened this issue · comments

commented

📚 Test development environment documentation so a first time contributor can get started quickly

Description

When I follow the development environment step-by-step instructions I cannot run yarn build. It fails with No matches found: "clean:*".

I installed Node v19.4.0 via NVM on MacOS. I installed Yarn 2, the latest stable version using Corepack, as suggested in the docs.

Step 4 of instructions gives me this:

No matches found: "clean:*"

I think this might be related to mysticatea/npm-run-all#230.

In package.json I skip over the issue by changing:

"clean": "npm-run-all clean:*",

to

"clean": "npm run clean:packages && npm run clean:root".

then run the build and I get a bit further:

node_modules/@types/cacheable-request/index.d.ts:26:42 - error TS2709: Cannot use namespace 'ResponseLike' as a type.

I'd love to start contributing by fixing the good first issues but this is a barrier at the moment. I'm not sure if the documentation needs to be more specific or if the documentation hasn't been tested for a while.

commented

Hi @rowlando,

Thanks for reporting this. Just tried it with the following versions and seems to be working for me, can you try the step-by-step process with the following versions (on windows):

Let me know if this works and I can put a on the docs to be more specific on the required versions.

commented

Yeap, works with Yarn Classic, so worth updating docs.

Re: Yarn 2 or 3. The No matches found: "clean:*" error is related to this and has a fix - see mysticatea/npm-run-all#200

Not sure about node_modules/@types/cacheable-request/index.d.ts:26:42 - error TS2709: Cannot use namespace 'ResponseLike' as a type. error.