badge for required node.js version for npm

[dougwilson]

hi! i semi-tried to add this, but since i use windows, it was not easy :) i would like to have a badge that would display the engine.node string as a badge. we talked about it a bit here: jshttp/jshttp.github.io#45 this information is available from the npm API, just like the version is. people can specify all kinds of things in there, so i would say echoing out the string should mostly work, but it would be neat if it was smart and had colors based on how many versions you are supporting.

[espadrine]

That'd be lovely.

I found a way to get to the current node version through http://nodejs.org/dist/latest/SHASUMS.txt.
Color-wise, I'd say yellow if it doesn't support the current node version, and green if it does.

By the way, I like your care for color blindness.

[espadrine]

So here's what I have:

• URL: /node/v/gh-badges.svg
• Color:
  • current node version supported: green
  • nightly node version supported: orange
  • outdated node version supported: yellow

What do you think?

[dougwilson]

here is the colors i've been using the most recently:

• minimum version 0.11, then orange. we could say, minimum version is greater than the latest version
• minimum version is 0.10, then green. range includes the latest (0.10.31).
• minimum version is 0.8, then brightgreen. only if the range includes the latest (see previous rule)

i like the outdated version idea so like if the version range does not include latest version (with the exception of if the range's minimum is above the latest (which would be orange)

[espadrine]

This is a game changer.

A totally new product, fitting in a completely new product range.

We have been restless in our pursuit of detail.

[dougwilson]

sweet, now i don't have to manage the badges manually :)

[dougwilson]

thank you sooo much, @espadrine

[espadrine]

And it's live! The website stayed live during the update! I feel like I outperformed an Apple engineer!

I'm harsh.

Anyway, here it is ☺

[dougwilson]

Sweet. So @rlidwka pointed out the following badge should be giving orange:

[espadrine]

Why should it be orange? It specifies a version range which includes the current node version.

[dougwilson]

The current node version is 0.10.31. The range there says >= 0.11.13. 0.10.31 falls below the given range in this case and 0.10.31 does not satisfy it.

[dougwilson]

So from the code in 2dd89e6 it looks like every single badge is going to be green (technically, whatever color the first badge was that was fetched after that cache expired).

[dougwilson]

i haven't actually run any code, but looking at how regularUpdate is written, it seems to me the call is supposed to be the following:

        regularUpdate('http://nodejs.org/dist/latest/SHASUMS.txt',
          (24 * 3600 * 1000),
          function(shasums) {
            var firstLine = shasums.slice(0, shasums.indexOf('\n'));
            var version = firstLine.split('  ')[1].split('-')[1];
            return version;
          }, function(err, version) {
            if (err != null) { sendBadge(format, badgeData); return; }
            if (semver.satisfies(version, versionRange)) {
              badgeData.colorscheme = 'brightgreen';
            } else if (semver.gtr(version, versionRange)) {
              badgeData.colorscheme = 'yellow';
            } else {
              badgeData.colorscheme = 'orange';
            }
            sendBadge(format, badgeData);
        });

[espadrine]

Hum, that is very odd… I do get orange on localhost.

As for your suggested modification, it is irrelevant. Using constants avoids recomputing the semver information every time.

There is possibly a bug with the regularUpdate function, but it is way too late for me to figure it out.

[dougwilson]

Here is one that clearly should be yellow, but is green:

[dougwilson]

As for your suggested modification, it is irrelevant

ok? i mean, the function(shasums) { is only the cache for fetching the url http://nodejs.org/dist/latest/SHASUMS.txt as regularUpdate is written. so if the first badge is green, regularUpdate is storing AGE_CURRENT in the http://nodejs.org/dist/latest/SHASUMS.txt cache, though it seems like it's supposed to be storing 0.10.31 (the current version), rather than whatever the first badge's age happened to be.

Using constants avoids recomputing the semver information every time.

does't the top-level cache function call cache the badge?

[espadrine]

so if the first badge is green, regularUpdate is storing AGE_CURRENT in the http://nodejs.org/dist/latest/SHASUMS.txt cache

Aaaah how strange that obvious things stop being obvious at 2am. Thanks and a thousand apologies!

[dougwilson]

Thanks and a thousand apologies!

No problem. I can't thank you enough for taking the time to implement this in the first place :)