xmake-docs icon indicating copy to clipboard operation
xmake-docs copied to clipboard

Incorrect reference to semver for version ranges

Open pombredanne opened this issue 4 months ago • 1 comments

Describe Bug

The documentation makes incorrect references to semver when these are instead node-semver version ranges, that are not part of the semver.org specification.

See https://github.com/xmake-io/xmake-docs/blob/1fbf07ea28a71883c2b1382b7e602cd639bdc7ba/docs/guide/package-management/using-official-packages.md?plain=1#L53

"Xmake's dependency package management fully supports semantic version selection, for example: "~1.6.1". For a detailed description of the semantic version, see: https://semver.org/ "

Yet using any range expression like "~", "<" or ">=" is not part of semver. It is instead part of the JavaScript "npm" package version ranges that uses this syntax as defined in the "node-semver" npm package.

See for details:

  • https://docs.npmjs.com/cli/v11/configuring-npm/package-json#dependencies
  • https://github.com/npm/node-semver#ranges

It would be best to update the references to point either to the npm documentation, or just document here the details, as there no guarantee that @uael https://github.com/uael/sv is an exact implementation of the node-semver range syntax.

pombredanne avatar Oct 26 '25 12:10 pombredanne

you can open a pr to improve it.

waruqi avatar Oct 26 '25 14:10 waruqi