implement semver --increment to remove dependency #45

davidchambers · 2017-12-01T23:08:44Z

I've wanted to do this for some time. The complexity of the code we add to the project by removing the dependency is offset by the incidental complexity we remove from the project by doing so. This change inadvertently closes #2 as we no longer need to determine our location on the file system.

We have no test suite, in part because I'd like to keep the source code in a single file which makes it difficult to test individual functions without triggering the script's side effects. I wrote a throwaway program to assert that the new inc function produces the same results as semver --increment (using semver@5.3.0) for 1792 inputs. Here's the test matrix I used:

for x in 0 1 9 10 ; do
  for y in 0 1 9 10 ; do
    for z in 0 1 9 10 ; do
      for suff in '' -rc.0 -rc.11.22.33.xx -beta.0 ; do
        version="$x.$y.$z$suff"
        for increment in major minor patch premajor preminor prepatch prerelease ; do
          # compare `inc` with `semver --increment`
        done
      done
    done
  done
done

I think this covers all the edge cases. Please let me know if you think of one I missed. :)

davidchambers · 2017-12-01T23:09:01Z

package.json

-  "bundledDependencies": [
-    "semver"
-  ]
+  "dependencies": {}


davidchambers · 2017-12-01T23:10:14Z

xyz

+        Specify the label to be used in the version number when publishing
+        a pre-release version (e.g. 'beta' is the label in '2.0.0-beta.0').
+        'rc' is assumed if this option is omitted.
+


This addition shows that we have never fully supported the pre{major,minor,patch,release} increments.

@Avaq, do you agree with rc as the default value?

davidchambers · 2017-12-01T23:10:39Z

xyz

-  path="$(readlink "$path")"
-  [[ $path == /* ]] || path="$dir/$path"
-done
-dir="$(cd -P "$(dirname "$path")" && pwd)"


I'm happy to see this code go!

davidchambers · 2017-12-01T23:11:34Z

xyz

+  local prerelease_label="$1" increment="$2" version="$3"
+  local number='0|[1-9][0-9]*'
+  local part="$number|[-0-9A-Za-z]+"
+  local pattern="^($number)[.]($number)[.]($number)(-(($part)([.]($part))*))?$"


This should match the grammar.

You've missed the build part. Not sure if that's really relevant though.

You've missed the build part.

That's true. I've never used it. Have you, Aldwin?

I've never used it either.

Let's omit build. I don't understand how it is used, and I'm not aware of xyz users actually using it. If in the future there is demand for build, we're free to change our minds. :)

davidchambers · 2017-12-01T23:13:22Z

xyz

+    patch)                      [[ -n $suff ]] || z+=1 ;;
+    premajor)                                     x+=1 ; y=0 ; z=0 ;;
+    preminor)                                     y+=1 ; z=0 ;;
+    prepatch)                                     z+=1 ;;


The majority of the algorithm is implemented in the six lines above. It reads better to me than the mutation-laden JavaScript implementation. ;)

davidchambers · 2017-12-01T23:15:48Z

xyz

@@ -90,29 +138,25 @@ while (($# > 0)) ; do
      exit
      ;;
    -v|--version)
-      node -p "require('$dir/package.json').version"
+      node -p 'require("xyz/package.json").version'


This change means ./xyz --version no longer works (from this project's root directory), but I don't consider this a problem. Not having to determine our location on the file system is a win.

davidchambers · 2017-12-01T23:16:45Z

xyz

-  major|minor|patch|premajor|preminor|prepatch|prerelease) ;;
-  *) echo "Invalid --increment" >&2 ; exit 1 ;;
-esac
-


The --increment value is validated in inc, so this paragraph is no longer necessary.

davidchambers commented Dec 1, 2017

View reviewed changes

package.json

"bundledDependencies": [

"semver"

]

"dependencies": {}

Copy link

Owner Author

davidchambers Dec 1, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉

Avaq reacted with hooray emoji

davidchambers commented Dec 1, 2017

View reviewed changes

implement semver --increment to remove dependency

5e3a62e

davidchambers force-pushed the semver branch from 1626ad5 to 5e3a62e Compare December 5, 2017 12:14

davidchambers merged commit b4481b6 into master Dec 5, 2017

davidchambers deleted the semver branch December 5, 2017 12:28

snyk-bot mentioned this pull request Oct 26, 2019

[Snyk] Upgrade xyz from 1.0.0 to 3.0.0 ajesse11x/webpack#4

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

implement semver --increment to remove dependency #45

implement semver --increment to remove dependency #45

davidchambers commented Dec 1, 2017

davidchambers Dec 1, 2017

davidchambers Dec 1, 2017

davidchambers Dec 1, 2017

davidchambers Dec 1, 2017

davidchambers Dec 1, 2017

Avaq Dec 4, 2017

davidchambers Dec 4, 2017

Avaq Dec 5, 2017

davidchambers Dec 5, 2017

davidchambers Dec 1, 2017

davidchambers Dec 1, 2017

davidchambers Dec 1, 2017

implement semver --increment to remove dependency #45

implement semver --increment to remove dependency #45

Conversation

davidchambers commented Dec 1, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment