forked from badges/shields
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathnode-base.js
More file actions
120 lines (111 loc) · 3.45 KB
/
Copy pathnode-base.js
File metadata and controls
120 lines (111 loc) · 3.45 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
import NPMBase from '../npm/npm-base.js'
const keywords = ['npm']
export default class NodeVersionBase extends NPMBase {
static category = 'platform-support'
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 [
{
title: `${prefix}`,
pattern: ':packageName',
namedParams: { packageName: 'passport' },
staticPreview: this.renderStaticPreview({
nodeVersionRange: '>= 6.0.0',
}),
keywords,
documentation,
},
{
title: `${prefix} (scoped)`,
pattern: '@:scope/:packageName',
namedParams: { scope: 'stdlib', packageName: 'stdlib' },
staticPreview: this.renderStaticPreview({
nodeVersionRange: '>= 6.0.0',
}),
keywords,
documentation,
},
{
title: `${prefix} (tag)`,
pattern: ':packageName/:tag',
namedParams: { packageName: 'passport', tag: 'latest' },
staticPreview: this.renderStaticPreview({
nodeVersionRange: '>= 6.0.0',
tag: 'latest',
}),
keywords,
documentation,
},
{
title: `${prefix} (scoped with tag)`,
pattern: '@:scope/:packageName/:tag',
namedParams: { scope: 'stdlib', packageName: 'stdlib', tag: 'latest' },
staticPreview: this.renderStaticPreview({
nodeVersionRange: '>= 6.0.0',
tag: 'latest',
}),
keywords,
documentation,
},
{
title: `${prefix} (scoped with tag, custom registry)`,
pattern: '@:scope/:packageName/:tag',
namedParams: { scope: 'stdlib', packageName: 'stdlib', tag: 'latest' },
queryParams: { registry_uri: 'https://registry.npmjs.com' },
staticPreview: this.renderStaticPreview({
nodeVersionRange: '>= 6.0.0',
tag: 'latest',
}),
keywords,
documentation,
},
]
}
static renderStaticPreview({ tag, nodeVersionRange }) {
// Since this badge has an async `render()` function, but `get examples()` has to
// be synchronous, this method exists. It should return the same value as the
// real `render()`. There's a unit test to check that.
return {
label: tag ? `${this.defaultBadgeData.label}@${tag}` : undefined,
message: nodeVersionRange,
color: 'brightgreen',
}
}
static async render({ tag, nodeVersionRange }) {
// Atypically, the `render()` function of this badge is `async` because it needs to pull
// data from the server.
const label = tag ? `${this.defaultBadgeData.label}@${tag}` : undefined
if (nodeVersionRange === undefined) {
return {
label,
message: 'not specified',
color: 'lightgray',
}
} else {
return {
label,
message: nodeVersionRange,
color: await this.colorResolver(nodeVersionRange),
}
}
}
async handle(namedParams, queryParams) {
const { scope, packageName, tag, registryUrl } =
this.constructor.unpackParams(namedParams, queryParams)
const { engines } = await this.fetchPackageData({
scope,
packageName,
registryUrl,
tag,
})
const { node: nodeVersionRange } = engines || {}
return this.constructor.render({ tag, nodeVersionRange })
}
}