search

Team-Silver-Sphere / SquadJS

Squad Server Script Framework
Boost Software License 1.0
167 stars 128 forks source link

[ReadMe] Update NodeJS Version in Readme #292

Open DrKittens opened 1 year ago

DrKittens commented 1 year ago

Description of Issue

SquadJS's readme lists NodeJS v14 as a prerequisite, this information is problematic as NodeJS 14's End of Life is today so the inherit recommendation of Node v14 is problematic to end users.

I believe this should be updated to either not describe an explicit version or mention the current LTS release (currently node 18)

Errors or Screenshots of Issue

https://endoflife.date/nodejs

Squad Information

If potentially relevant, please provide regarding the state of the Squad server at the time of error, e.g. the current layer.

System Information

Thomas-Smyth commented 1 year ago

The current suggestion was made based on the compatibility of sqlite3 at the time. Research should be conducted to find what versions are required by sqlite3, if any.

reck1610 commented 1 year ago

sqlite3 version 5.0.0 was compatible with NodeJS 11, 12, 13 and 14 as stated here: https://www.npmjs.com/package/sqlite3/v/5.0.0

The current version is 5.1.6 which can be found here: https://www.npmjs.com/package/sqlite3/v/5.1.6

The compatibility statement for NodeJS 11, 12, 13 and 14 has been removed. The only mention of specific NodeJS versions is the one below.

sqlite3 v5+ was rewritten to use Node-API so prebuilt binaries do not need to be built for specific Node versions. sqlite3 currently builds for both Node-API v3 and v6. Check the Node-API version matrix to ensure your Node version supports one of these. The prebuilt binaries should be supported on Node v10+.

I have been running SquadJS with NodeJS v18.16.0 since I had to upgrade 2 months ago. I have a sqlite database configured and everything worked so far.

DrKittens commented 1 year ago

Going by the info provided above about why the version is recommended:

The NPM info for sqlitev5.1.6 below:

https://www.npmjs.com/package/sqlite3/v/5.1.6

Notes that Node-API v3 is supported.

The Node-API version matrix below

https://nodejs.dev/en/api/v18/n-api/#node-api-version-matrix

Notes that v3 is supported by all releases >v10

I believe it is safe to remove that version specific readme warning and recommend the latest Node LTS be deployed until either node-api deprecates v3.0 from a future release or nodejs sqlite drops support for api v3

naxhh commented 7 months ago

as of today, you can't run the project with node 14. some of the dependencies are requiring 16 or above