darrachequesne / sync-pom-version Goto Github PK

The version in a pom does not fully adhere to semantic versioning (https://semver.org/) which is required in package.json.

This means there are a lot of pom-versions for which a "trivial" sync between pom and package.json is not possible. The current sync-pom-version may in such cases break the npm build with error message

ERROR: Invalid version: xxxxxx

In general it seems that a valid pom-version is of the form /d+(./d*)?(./d*)?-qualifier, where "qualifier" actually is any valid string.

In order to make the "qualifier" acceptable to semver, I suggest that we apply the following procedure to it:

1. remove all characters NOT matching reqular expression [0-9A-Za-z-._]

2. change all characters "_" into dots "."

3. remove any trailing zeroes immediately following a dot

4. replace all occurences of multiple consecutive dots "." with a single dot

5. remove trailing dot (if found)

6. As a finalizing check for the resulting version, make sure to remove trailing "-" (if present)

example conversions:

1.44.1-SNAPSHOT_0001 converts to 1.44.1-SNAPSHOT.1
2.9-_0 converts to 2.9

A lot of maven projects follow the convention of marking their GA releases as something like "1.2.3.RELEASE". But since this doesn't match any formats specified by semver, it causes the npm build to fail.

Maven allows versioning on two sequence numbers (e.g. 1.1, 1.2 etc.) whereas NPM strictly requires three numbers (1.1.0, 1.2.0, etc.). In these cases, this tool should automatically convert the POM version, adding a ".0" as third sequence number.