microsoft / microsoft/tsdoc

Upgrade Node.js and `node-sass` dependencies

Open
#350 1 comment 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

I tried following the instructions on Building the projects, but noticed two blockers:

  • The rush.json declares Node.js v14 as the highest supported version for the repo, while it has now dropped out of maintenance. It could probably easily be expanded to include v18 (the currently active LTS version).
  • tsdoc-playground declares a dependency on node-sass in version 4.14.1, which was published 3+ years ago and therefore doesn't have native prebuilds for Apple Silicon (M1). Making it start building the binary on install, which requires python@2. It think it would be great if node-sass could just be updated to v8.0.0.

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 with rush.json and the tsdoc-playground package declaration referenced by the issue, then review the building instructions for the supported Node.js range. Update the declared Node.js support and node-sass dependency as requested, and verify that the project installs and builds without requiring Python 2.

Written by the indexing model from the issue text.

Assessment

Tech stack
node.js, typescript
Domain
build-system, tooling
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.