Skip to content

Commit 4885110

Browse files
authored
docs: add ffi-napi to docs/README.md (#3138)
1 parent 3e1cdd4 commit 4885110

File tree

1 file changed

+6
-13
lines changed

1 file changed

+6
-13
lines changed

docs/README.md

+6-13
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Versions of `node-gyp` that are earlier than v10.x.x
1+
## Versions of `node-gyp` that are earlier than v11.x.x
22

33
Please look thru your error log for the string `gyp info using node-gyp@` and if that version number is less than the [current release of node-gyp](https://github.com/nodejs/node-gyp/releases) then __please upgrade__ using [these instructions](https://github.com/nodejs/node-gyp/blob/main/docs/Updating-npm-bundled-node-gyp.md) and then try your command again.
44

@@ -13,19 +13,12 @@ npm install --global node-sass@latest
1313
```
1414
`node-sass` projects _may_ work by downgrading to Node.js v14 but [that release is end-of-life](https://github.com/nodejs/release#release-schedule).
1515

16-
In any case, please avoid opening new `node-sass` issues on this repo because we [cannot help much](https://github.com/nodejs/node-gyp/issues?q=is%3Aissue+label%3A%22Node+Sass+--%3E+Dart+Sass%22+).
16+
In any case, please avoid opening new `node-sass` issues on this repo because we [cannot help much](https://github.com/nodejs/node-gyp/issues?q=is%3Aissue+label%3A%22Node+Sass+--%3E+Dart+Sass%22).
1717

18-
## `node-pre-gyp` is no longer maintained
18+
## `ffi-napi` is no longer maintained
1919

20-
* mapbox/node-pre-gyp#657
20+
* node-ffi-napi/node-ffi-napi#269
2121

22-
Support in the `abi_crosswalk.json` file ends at Node.js v17 but [that release is end-of-life](https://github.com/nodejs/release#release-schedule).
22+
There are a couple of workarounds (https://koffi.dev or `node-ffi-rs`) on that issue but using `ffi-napi` or its forks has proven problematic on modern versions of operating systems, Node.js, node-gyp, and Python.
2323

24-
In any case, please avoid opening new `node-pre-gyp` issues on this repo because we [cannot help much](https://github.com/nodejs/node-gyp/issues?q=is%3Aissue+label%3A%22node-pre-gyp+is+unmaintained%22).
25-
26-
Unsupported __WORKAROUND__ for versions of Node.js > v17
27-
```
28-
npm ci # mapbox/node-pre-gyp
29-
npm run update-crosswalk
30-
# npm audit # Currently fails on a `Severity: critical` issue
31-
```
24+
In any case, please avoid opening new `ffi-napi` issues on this repo because we [cannot help much](https://github.com/nodejs/node-gyp/issues?q=label%3Affi-napi).

0 commit comments

Comments
 (0)