Gitbook build stopped to work in node 12.18.3

Question

Gitbook build stopped to work in node 12.18.3

mikyjpeg opened this issue 4 years ago · comments

Since the new version of node, when running gitbook build it fails with the following error:

Installing GitBook 3.2.3

/home/travis/.nvm/versions/node/v12.18.3/lib/node_modules/gitbook-cli/node_modules/npm/node_modules/graceful-fs/polyfills.js:287
      if (cb) cb.apply(this, arguments)
                 ^
TypeError: cb.apply is not a function
    at /home/travis/.nvm/versions/node/v12.18.3/lib/node_modules/gitbook-cli/node_modules/npm/node_modules/graceful-fs/polyfills.js:287:18
    at FSReqCallback.oncomplete (fs.js:169:5)

The command "gitbook install" failed and exited with 1 during .

The command still works fine when using 12.18.2

Kin Wang commented 3 years ago

Still +1

Minh Nguyen commented 2 years ago

1

周思伟 · Answer 1 · Thu Jul 30 2020 14:53:50 GMT+0800 (China Standard Time)

Yes, I have the same problem. My node version is v14.6.0

SadSock · Answer 2 · Sun Aug 02 2020 03:30:58 GMT+0800 (China Standard Time)

I have the same problem.

RJ Beers · Answer 3 · Mon Aug 03 2020 12:18:30 GMT+0800 (China Standard Time)

I believe the issue was resolved by isaacs/node-graceful-fs@168bdb8, but gitbook-cli has outdated dependencies which pull in versions of graceful-fs without the fix.

hitzhangjie · Answer 4 · Mon Aug 03 2020 21:28:35 GMT+0800 (China Standard Time)

I have the same problem, too.

please help.

node version is v14.6.0.

M. Greyson Christoforo · Answer 5 · Wed Aug 05 2020 20:42:01 GMT+0800 (China Standard Time)

In light of
https://github.com/GitbookIO/gitbook#%EF%B8%8F-deprecation-warning
We probably need to fork gitbook-cli to maintain it. Who wants to do it?

周思伟 · Answer 6 · Thu Aug 06 2020 08:50:37 GMT+0800 (China Standard Time)

@greyltc That sounds good. You can unify one person to fork and then maintain it through the open source community

周思伟 · Answer 7 · Thu Aug 06 2020 10:10:09 GMT+0800 (China Standard Time)

@rjbeers Thank you very much. You're right.

if you run gitbook serve has error and your gitbook-cli is installed globally.
Find the NPM global installation directory and into dir node_modules/gitbook-cli/node_modules/npm/node_modules Execute the order

npm install graceful-fs@latest --save

if you run gitbook install has error
Go to user directory and into dir .gitbook/versions/3.2.3/node_modules/npm Execute the order

npm install graceful-fs@latest --save

Zach Buckner · Answer 8 · Tue Aug 11 2020 04:41:56 GMT+0800 (China Standard Time)

@greyltc I noticed a new fork -- greyltc@2b39017 . Thanks! Are you planning to publish your fork as an npm package? Let me know if I can be any help. Our team depends on gitbook-cli, so I'd love to find a path forward.

M. Greyson Christoforo · Answer 9 · Tue Aug 11 2020 18:38:11 GMT+0800 (China Standard Time)

@zzaacchh
I rely on gitbook-cli as well and it's very unfortunate and frustrating that upstream support for it has been dropped (but hey, you can't always have your cake and eat it too!) and I would love a path forward too.
I would plan to publish my fork so that the community can have a working gitbook-cli, but I can't get it to work.

The NPM dependancy system seems to be a real nightmare. Any help is welcome.

Zach Buckner · Answer 10 · Fri Aug 14 2020 10:14:20 GMT+0800 (China Standard Time)

Thanks, @greyltc . I'm planning to hire someone on upwork to help fork and repackage. Any chance you'd be up for pitching in on the cost for that?

M. Greyson Christoforo · Answer 11 · Sat Aug 15 2020 03:04:14 GMT+0800 (China Standard Time)

The stuff I use gitbook-cli for is free, open and, non-revenue-generating, so unfortunately I don't have much other than a little of my time to offer. And that's not so valuble here because I don't know shit about javascript!

Abhishek Sharma · Answer 12 · Fri Aug 28 2020 23:16:15 GMT+0800 (China Standard Time)

I was reached out by @zzaacchh. I’m happy to support this project for free! Forked.

Xiaole Meng · Answer 13 · Sat Aug 29 2020 16:58:33 GMT+0800 (China Standard Time)

I believe the issue was resolved by isaacs/node-graceful-fs@168bdb8, but gitbook-cli has outdated dependencies which pull in versions of graceful-fs without the fix.

yeah it helps !!! my node version is v14.5.0
thanks !!

Hong Shik Kim (Branden) · Answer 14 · Tue Sep 01 2020 13:56:32 GMT+0800 (China Standard Time)

I ended up to use nvm to use nodejs 10 lts. I updated dependency of graceful-fs globally and locally but it won't help.

Rafał Wyszomirski · Answer 15 · Tue Sep 15 2020 22:23:37 GMT+0800 (China Standard Time)

I had the same issue but using different package. It was mentioned before that selective dependency resolution can help with that:

"resolutions": {
  "**/graceful-fs": "^4.2.4"
}

I am installing my deps with yarn and this fixed the issue. I think it's a good idea to double check if the version installed in node_modules is actually 4.2.4 - maybe a lock file or cache keeps installing other version.

Jiawen Geng · Answer 16 · Mon Mar 22 2021 17:11:29 GMT+0800 (China Standard Time)

I make my own fork, if you are interested, just use npm i -g gengjiawen/gitbook-cli should work.

I also develop an github action for generate books, please refer to: https://github.com/gengjiawen/koajs-design-note.

Hanjin Lee · Answer 17 · Fri Jun 18 2021 10:24:07 GMT+0800 (China Standard Time)

I had same problem.
I think seems to be dependancy problem with latest version for graceful-fs.
Change the graceful-fs version solves the problem.

My environment is :

OS : macOS Big Sur
node : v12.22.1
npm : v6.14.12
gitbook-cli : gitbook-cli@2.3.2
graceful-fs : 4.1.4

try this :

$ npm i -g gitbook-cli
$ cd /usr/local/lib/node_modules/gitbook-cli
$ npm i graceful-fs@4.1.4 --save
$ cd /usr/local/lib/node_modules/gitbook-cli/node_modules/npm
$ npm i graceful-fs@4.1.4 --save
$ cd {your gitbook directory}
$ gitbook init
$ gitbook serve

info: 7 plugins are installed
info: loading plugin "livereload"... OK
info: loading plugin "highlight"... OK
info: loading plugin "search"... OK
info: loading plugin "lunr"... OK
info: loading plugin "sharing"... OK
info: loading plugin "fontsettings"... OK
info: loading plugin "theme-default"... OK
info: found 1 pages
info: found 0 asset files
info: >> generation finished with success in 0.2s !

Starting server ...
Serving book on http://localhost:4000

SaetByeol Ahn · Answer 18 · Mon Jun 28 2021 17:22:44 GMT+0800 (China Standard Time)

I had same problem.
I think seems to be dependancy problem with latest version for graceful-fs.
Change the graceful-fs version solves the problem.

My environment is :

OS : macOS Big Sur

node : v12.22.1

npm : v6.14.12

gitbook-cli : gitbook-cli@2.3.2

graceful-fs : 4.1.4

try this :

$ npm i -g gitbook-cli
$ cd /usr/local/lib/node_modules/gitbook-cli
$ npm i graceful-fs@4.1.4 --save
$ cd /usr/local/lib/node_modules/gitbook-cli/node_modules/npm
$ npm i graceful-fs@4.1.4 --save
$ cd {your gitbook directory}
$ gitbook init
$ gitbook serve

info: 7 plugins are installed
info: loading plugin "livereload"... OK
info: loading plugin "highlight"... OK
info: loading plugin "search"... OK
info: loading plugin "lunr"... OK
info: loading plugin "sharing"... OK
info: loading plugin "fontsettings"... OK
info: loading plugin "theme-default"... OK
info: found 1 pages
info: found 0 asset files
info: >> generation finished with success in 0.2s !
Starting server ...
Serving book on http://localhost:4000

It works for me :) Thanks 😋 @jinifor

npm : v7.18.1
node : v16.4.0

LaurieLY · Answer 19 · Wed Jul 21 2021 19:30:39 GMT+0800 (China Standard Time)

I had same problem.
I think seems to be dependancy problem with latest version for graceful-fs.
Change the graceful-fs version solves the problem.

My environment is :

OS : macOS Big Sur

node : v12.22.1

npm : v6.14.12

gitbook-cli : gitbook-cli@2.3.2

graceful-fs : 4.1.4

try this :

$ npm i -g gitbook-cli
$ cd /usr/local/lib/node_modules/gitbook-cli
$ npm i graceful-fs@4.1.4 --save
$ cd /usr/local/lib/node_modules/gitbook-cli/node_modules/npm
$ npm i graceful-fs@4.1.4 --save
$ cd {your gitbook directory}
$ gitbook init
$ gitbook serve

info: 7 plugins are installed
info: loading plugin "livereload"... OK
info: loading plugin "highlight"... OK
info: loading plugin "search"... OK
info: loading plugin "lunr"... OK
info: loading plugin "sharing"... OK
info: loading plugin "fontsettings"... OK
info: loading plugin "theme-default"... OK
info: found 1 pages
info: found 0 asset files
info: >> generation finished with success in 0.2s !
Starting server ...
Serving book on http://localhost:4000

It works for me too !!! Thanks @jinifor

Ruslan · Answer 20 · Tue Aug 03 2021 22:29:49 GMT+0800 (China Standard Time)

Workaround for me in node:v14.16.0

$ yarn global add gitbook-cli@2.2.0
$ gitbook fetch 3.2.3

lianghuipinglz · Answer 21 · Mon Nov 15 2021 10:31:21 GMT+0800 (China Standard Time)

My node version is v14.0.0
"gitbook install" can success

Svetlin Nakov · Answer 22 · Mon Nov 22 2021 05:38:00 GMT+0800 (China Standard Time)

Just replace the crashing file polyfills.js with this one:
https://raw.githubusercontent.com/isaacs/node-graceful-fs/168bdb8f0bb3174e8499d4bc5878deead4172c39/polyfills.js

This works like a charm in Node.js v16.13.0.

Svetlin Nakov · Answer 23 · Mon Nov 22 2021 05:41:50 GMT+0800 (China Standard Time)

These are the detailed steps to fix the problem (temporary, just to execute gitbook install and gitbook build):

Install `gitbook-cli` globally (if not already installed)

npm -g install gitbook-cli

Go to your NPM global modules directory (find its location by typing `npm -g list`)

Linux: cd /usr/lib/node_modules
Windows: cd %AppData%/npm/node_modules

Go to the `graceful-fs` folder

cd gitbook-cli/node_modules/npm/node_modules/graceful-fs

Delete the old incompatible file `polyfills.js`, which causes `TypeError: cb.apply is not a function`

rm polyfills.js

Download a fixed newer version of `polyfills.js` from GitHub

wget https://raw.githubusercontent.com/isaacs/node-graceful-fs/168bdb8f0bb3174e8499d4bc5878deead4172c39/polyfills.js

Haikun Huang · Answer 24 · Thu Nov 25 2021 03:54:41 GMT+0800 (China Standard Time)

I had same problem. I think seems to be dependancy problem with latest version for graceful-fs. Change the graceful-fs version solves the problem.

My environment is :

OS : macOS Big Sur

node : v12.22.1

npm : v6.14.12

gitbook-cli : gitbook-cli@2.3.2

graceful-fs : 4.1.4

try this :

$ npm i -g gitbook-cli $ cd /usr/local/lib/node_modules/gitbook-cli $ npm i graceful-fs@4.1.4 --save $ cd /usr/local/lib/node_modules/gitbook-cli/node_modules/npm $ npm i graceful-fs@4.1.4 --save $ cd {your gitbook directory} $ gitbook init $ gitbook serve

info: 7 plugins are installed
info: loading plugin "livereload"... OK
info: loading plugin "highlight"... OK
info: loading plugin "search"... OK
info: loading plugin "lunr"... OK
info: loading plugin "sharing"... OK
info: loading plugin "fontsettings"... OK
info: loading plugin "theme-default"... OK
info: found 1 pages
info: found 0 asset files
info: >> generation finished with success in 0.2s !
Starting server ...
Serving book on http://localhost:4000

Great!! It works for me.

Masumi Kawasaki · Answer 25 · Sun Jan 30 2022 08:14:58 GMT+0800 (China Standard Time)

#110 (comment)
This works for me too. I'm using M1 mac + homebrew and changed the PATH, so I need to make the following changes.

npm i -g gitbook-cli
cd /opt/homebrew/lib/node_modules/gitbook-cli
npm i graceful-fs@4.1.4 --save
cd /opt/homebrew/lib/node_modules/gitbook-cli/node_modules/npm
npm i graceful-fs@4.1.4 --save
cd {your gitbook directory}
gitbook init
gitbook serve

小甲鱼 · Answer 26 · Tue Mar 01 2022 18:18:20 GMT+0800 (China Standard Time)

I had same problem. I think seems to be dependancy problem with latest version for graceful-fs. Change the graceful-fs version solves the problem.

My environment is :

OS : macOS Big Sur

node : v12.22.1

npm : v6.14.12

gitbook-cli : gitbook-cli@2.3.2

graceful-fs : 4.1.4

try this :

$ npm i -g gitbook-cli $ cd /usr/local/lib/node_modules/gitbook-cli $ npm i graceful-fs@4.1.4 --save $ cd /usr/local/lib/node_modules/gitbook-cli/node_modules/npm $ npm i graceful-fs@4.1.4 --save $ cd {your gitbook directory} $ gitbook init $ gitbook serve

info: 7 plugins are installed
info: loading plugin "livereload"... OK
info: loading plugin "highlight"... OK
info: loading plugin "search"... OK
info: loading plugin "lunr"... OK
info: loading plugin "sharing"... OK
info: loading plugin "fontsettings"... OK
info: loading plugin "theme-default"... OK
info: found 1 pages
info: found 0 asset files
info: >> generation finished with success in 0.2s !
Starting server ...
Serving book on http://localhost:4000

thank you! it is working...

wanghao · Answer 27 · Thu Mar 17 2022 20:10:49 GMT+0800 (China Standard Time)

These are the detailed steps to fix the problem (temporary, just to execute gitbook install and gitbook build):

Install gitbook-cli globally (if not already installed)

npm -g install gitbook-cli

Go to your NPM global modules directory (find its location by typing npm -g list)

Linux: cd /usr/lib/node_modules Windows: cd %AppData%/npm/node_modules

Go to the graceful-fs folder

cd gitbook-cli/node_modules/npm/node_modules/graceful-fs

Delete the old incompatible file polyfills.js, which causes TypeError: cb.apply is not a function

rm polyfills.js

Download a fixed newer version of polyfills.js from GitHub

wget https://raw.githubusercontent.com/isaacs/node-graceful-fs/168bdb8f0bb3174e8499d4bc5878deead4172c39/polyfills.js

that's helpful! I finally manage to install gitbook with node v16.14.1

嘉辉 · Answer 28 · Mon Apr 18 2022 19:25:48 GMT+0800 (China Standard Time)

node -v 16.14.2 npm -v 8.5.0
node -v 17.9.0 npm -v 8.7.0

cd C:\Users\admin\AppData\Roaming\npm\node_modules\gitbook-cli\node_modules\npm\node_modules
I tried to install graceful-fs@latest(graceful-fs@4.2.10), but when I finished, the Gitbook was gone. Finally, graceful-fs@4.2.0 was installed to fix the problem

Find the global installation directory for NPM: (prefix)
C:\Users\admin\AppData\Roaming\npm\node_modules\gitbook-cli\node_modules\npm\node_modules>npm config ls
; "builtin" config from C:\Users\admin\AppData\Roaming\npm\node_modules\npm\npmrc

prefix = "C:\Users\admin\AppData\Roaming\npm"

; "user" config from C:\Users\admin.npmrc

registry = "https://registry.npm.taobao.org/"

; node bin location = C:\Program Files\nodejs\node.exe
; node version = v17.9.0
; npm local prefix = C:\Users\admin\AppData\Roaming\npm\node_modules\gitbook-cli\node_modules\npm
; npm version = 8.7.0
; cwd = C:\Users\admin\AppData\Roaming\npm\node_modules\gitbook-cli\node_modules\npm\node_modules
; HOME = C:\Users\admin
; Run npm config ls -l to show all defaults.

Marc Spinozza · Answer 29 · Sun Jul 03 2022 22:05:53 GMT+0800 (China Standard Time)

To anyone still having this issue, I have setup an devcontainer environment with gitbook configured and working fine. The gitbook fix is based on @jinifor contribution above #110 (comment)

devcontainer-gitbook

Hope it can help someone!

Akihiko.KIgure · Answer 30 · Sun Sep 18 2022 17:06:36 GMT+0800 (China Standard Time)

I have the same problem.
my pc develop enviroment

macOS Monterey v12.6
$ node -v 
v16.17.0
$ npm -v
8.15.0
$ yarn -v
1.22.19
$ ruby -v
ruby 2.6.8p205 (2021-07-07 revision 67951) [universal.arm64e-darwin21]

#110 (comment)
I replaced the polyfills.js as per the instructions in the comments, but the result was the same

Svetlin Nakov · Answer 31 · Tue Sep 20 2022 00:32:58 GMT+0800 (China Standard Time)

I use GitHub Actions script to build and deploy my gitbook-based books. This is the script. It works successfully in the last 3 years: https://github.com/SoftUni/Programming-Basics-Book-JS-EN/blob/master/.github/workflows/gitbook-deploy.yml

Jiacai Liu · Answer 32 · Sun Oct 30 2022 17:22:25 GMT+0800 (China Standard Time)

It seems this project hasn't got any update since 2017, it's time to move on something else, some alternatives:

https://rust-lang.github.io/mdBook/guide/installation.html

Tianjia Zhang · Answer 33 · Tue Feb 14 2023 15:16:35 GMT+0800 (China Standard Time)

I have the same problem, too.

please help.

node version is v18.14.0.

mahula · Answer 34 · Fri Oct 27 2023 22:05:39 GMT+0800 (China Standard Time)

This problem still exists.
Any workaround or solutions instead of usin NodeJS <=12.18.2?

Gitbook build stopped to work in node 12.18.3

Install gitbook-cli globally (if not already installed)

Go to your NPM global modules directory (find its location by typing npm -g list)

Go to the graceful-fs folder

Delete the old incompatible file polyfills.js, which causes TypeError: cb.apply is not a function

Download a fixed newer version of polyfills.js from GitHub

Install gitbook-cli globally (if not already installed)

Go to your NPM global modules directory (find its location by typing npm -g list)

Go to the graceful-fs folder

Delete the old incompatible file polyfills.js, which causes TypeError: cb.apply is not a function

Download a fixed newer version of polyfills.js from GitHub

Install `gitbook-cli` globally (if not already installed)

Go to your NPM global modules directory (find its location by typing `npm -g list`)

Go to the `graceful-fs` folder

Delete the old incompatible file `polyfills.js`, which causes `TypeError: cb.apply is not a function`

Download a fixed newer version of `polyfills.js` from GitHub

Install `gitbook-cli` globally (if not already installed)

Go to your NPM global modules directory (find its location by typing `npm -g list`)

Go to the `graceful-fs` folder

Delete the old incompatible file `polyfills.js`, which causes `TypeError: cb.apply is not a function`

Download a fixed newer version of `polyfills.js` from GitHub