diff --git a/services/node/node-base.js b/services/node/node-base.js index 2af26cb1069dcdd95e4274df9c413d0226ea2b7a..a0b9e91275710e98f034319dc501cbb5e940d206 100644 --- a/services/node/node-base.js +++ b/services/node/node-base.js @@ -15,6 +15,12 @@ module.exports = class NodeVersionBase extends NPMBase { static get examples() { const type = this.type + const documentation = ` + <p> + ${this.documentation} + The node version support is retrieved from the <code>engines.node</code> section in package.json. + </p> +` const prefix = `node-${type}` return [ { @@ -25,6 +31,7 @@ module.exports = class NodeVersionBase extends NPMBase { nodeVersionRange: '>= 6.0.0', }), keywords, + documentation, }, { title: `${prefix} (scoped)`, @@ -34,6 +41,7 @@ module.exports = class NodeVersionBase extends NPMBase { nodeVersionRange: '>= 6.0.0', }), keywords, + documentation, }, { title: `${prefix} (tag)`, @@ -44,6 +52,7 @@ module.exports = class NodeVersionBase extends NPMBase { tag: 'latest', }), keywords, + documentation, }, { title: `${prefix} (scoped with tag)`, @@ -54,6 +63,7 @@ module.exports = class NodeVersionBase extends NPMBase { tag: 'latest', }), keywords, + documentation, }, { title: `${prefix} (scoped with tag, custom registry)`, @@ -65,6 +75,7 @@ module.exports = class NodeVersionBase extends NPMBase { tag: 'latest', }), keywords, + documentation, }, ] } diff --git a/services/node/node-current.service.js b/services/node/node-current.service.js index 27ace3ba4cf3d7bb407155d2e4415dae4de86574..62ea26c4b521d3482cefe237542ddb83dfb47b21 100644 --- a/services/node/node-current.service.js +++ b/services/node/node-current.service.js @@ -19,4 +19,8 @@ module.exports = class NodeCurrentVersion extends NodeVersionBase { static get colorResolver() { return versionColorForRangeCurrent } + + static get documentation() { + return `This badge indicates whether the package supports the <b>latest</b> release of node` + } } diff --git a/services/node/node-lts.service.js b/services/node/node-lts.service.js index 73477191eb36d79767ea52cc8e0c0e7be679c55c..cdef9af0470bdcf85a3fccdbf8f42a521518075d 100644 --- a/services/node/node-lts.service.js +++ b/services/node/node-lts.service.js @@ -19,4 +19,8 @@ module.exports = class NodeLtsVersion extends NodeVersionBase { static get colorResolver() { return versionColorForRangeLts } + + static get documentation() { + return `This badge indicates whether the package supports <b>all</b> LTS node versions` + } }