microsoft / microsoft/tsdoc

Unable to add tsdoc to project

Open
#439 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
5k
Forks
162
Avg merge
17h 24m
Merged PRs (30d)
8

Description

hey
After trying to add tsdoc to a project, always throws error:
it has a problem with crypto-browserify commit hash
exact log:

yarn add -D tsdoc @microsoft/tsdoc-config
➤ YN0000: · Yarn 4.7.0
➤ YN0000: ┌ Resolution step
➤ YN0001: │ Error: crypto-browserify@git+https://github.com/dominictarr/crypto-browserify.git#95c5d505:
Couldn't resolve "95c5d505" as either a commit, a tag, or a head - if a commit, use the 40-characters commit hash
at A (C:\Users{username}\AppData\Local\node\corepack\v1\yarn\4.7.0\yarn.js:529:6907)
at LH (C:\Users{username}\AppData\Local\node\corepack\v1\yarn\4.7.0\yarn.js:529:7240)
at process.processTicksAndRejections (node:internal/process/task_queues:105:5)

step to reproduce:
1.

yarn add -D tsdoc

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the failure with yarn add -D tsdoc using Yarn 4.7.0 and compare the dependency resolution for crypto-browserify. Trace where the 95c5d505 reference is introduced; done means the documented installation command completes without the commit-resolution error.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.