search

ricmoo / flatworm

A very simple documentation generation tool.
MIT License
18 stars 5 forks source link

update deprecated function: createRequireFromPath #3

Open JL2718 opened 3 years ago

JL2718 commented 3 years ago

First commit is relevant change. Subsequent is just rebuilding docs.

ricmoo commented 3 years ago

There is no need to update the docs with a PR, or the lib. I will generate that when I merge and publish. The docs are also not really maintained within this repo anymore, as I keep them on docs.ethers.io. I should probably delete them from this repo and just link there.

It’s useful for a PR to show the minimum changes. :)

I probably won’t make this change yet, as it will break the compatibility of Flatworm with older node versions. Is there a reason you need this change?

JL2718 commented 3 years ago

Actually no; I was just trying to add toBigInt() to the docs in ethers, and noticed that they were generated from flatworm, so it seemed that 'npm run build-docs' had to be run to keep it consistent, which failed due to the deprecated function in modules. I don't need either of those PRs for my own purposes, so feel free to reject/ignore.

ricmoo commented 3 years ago

What version of node are you using that flatworm was failing on? Or was it just giving deprecation warnings?

JL2718 commented 3 years ago

failing with 16.5.0 createRequireFromPath is removed from modules

ricmoo commented 3 years ago

Ah, it must be something to do w/ Node 16 then. It works in 12 and 14 fine. I'm sure I'll run into this issue soon then.

Thanks for the heads up. :)