microsoft / microsoft/TypeScript-TmLanguage
"Install dependencies" needs additional command line options
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 471
- Forks
- 149
- PR merge metrics
- No merged PRs in 30d
Description
TS and JS Grammar Extension version: 0.0.50 / latest
In README.md, it is documented that to install dependencies, npm install is all that is required. However, I've found that on my Windows 10 machine with Visual Studio 2017, I have to type npm install -g windows-build-tools in a PowerShell running with administrator privileges or oniguruma fails to be installed.
It appears that after I get it to build one time, I don't have to pass those extra arguments to npm.
I found my solution when someone else had a similar problem on superuser.com. I'm logging this here to help others having the same problem, and as a suggestion that the README.md be updated to include the extra arguments needed on Windows 10.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Update README.md's dependency-installation instructions for the reported Windows 10 case. Start by reviewing the existing npm install guidance and the oniguruma failure described in the issue; done means the README clearly documents the additional administrator PowerShell command and when it is needed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100