microsoft / tsdoc

A doc comment standard for TypeScript
https://tsdoc.org/
MIT License
4.7k stars 130 forks source link

api-doc install fails #292

Closed jhunterkohler closed 3 years ago

jhunterkohler commented 3 years ago

After cloning the repository I ran the npm install as stated in the readme (inside the api-demo folder).

$ npm install --no-package-lock

The install did not work, see pastebins at the bottom.

I suspect that this has something to do with versioning of either Node.js or g++. I am currently running the following:

 g++-10:  gcc version 10.2.0 (Homebrew GCC 10.2.0_4)
 node: v16.0.0
 npm: 7.11.0
 OS: macOS 11.2.3 20D91 x86_64
 Host: MacBookPro15,4
 Kernel: 20.3.0
 Shell: zsh 5.8

I don't really need help with this. Just wanted to let y'all know.

Pastebins

octogonz commented 3 years ago

@hunterkohler thanks for reporting this!

The problem is that you are using an unstable release of Node.js:

https://nodejs.org/en/about/releases/

The node-sass dependency does not publish prebuilt native binaries for unstable Node.js releases. As a result, the npm install command falls back to invoking the C++ compiler, which failed due to a misconfiguration or incompatibility on your system.

The current LTS version is Node.js v14. I confirmed that the demo builds without problems using that release. We can update the docs to clarify this.

tgmarinho commented 1 year ago

Facing issue:

~/Developer/tsdoc/api-demo (main) » npm run build                                                                                                                                                      1 ↵ tgmarinho@Thiagos-MacBook-Pro

> api-demo@0.0.0 build
> heft test --clean

Using local Heft from /Users/tgmarinho/Developer/tsdoc/api-demo/node_modules/@rushstack/heft

/Users/tgmarinho/Developer/tsdoc/api-demo/node_modules/node-sass/lib/binding.js:13
      throw new Error(errors.unsupportedEnvironment());
      ^

Error: Node Sass does not yet support your current environment: OS X Unsupported architecture (arm64) with Unsupported runtime (93)
For more information on which environments are supported please see:
https://github.com/sass/node-sass/releases/tag/v4.14.1

node v16.18.0 LTS Darwin MacBook-Pro.local 21.6.0 Darwin Kernel Version 21.6.0: Mon Aug 22 20:19:52 PDT 2022; root:xnu-8020.140.49~2/RELEASE_ARM64_T6000 arm64

ecoms-ye commented 1 year ago

the latest Node.js LTS is v18 now, and same problem when building node-sass with node-gyp

(succeed with node v14)