@iobroker/repochecker 3.2.3 → 3.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -21
- package/README.md +240 -181
- package/index.js +79 -73
- package/lib/M000_PackageJson.js +172 -78
- package/lib/M100_IOPackageJson.js +646 -457
- package/lib/M250_Npm.js +34 -25
- package/lib/M300_Testing.js +7 -1
- package/lib/M400_Repository.js +130 -45
- package/lib/M500_Code.js +21 -18
- package/lib/M500__JsonConfig.js +197 -190
- package/lib/M600_Readme.js +25 -8
- package/lib/M700_License.js +21 -7
- package/lib/M800_Github.js +21 -7
- package/lib/M900_GitNpmIgnore.js +34 -31
- package/lib/common.js +4 -4
- package/lib/config.js +34 -47
- package/package.json +8 -6
package/lib/M000_PackageJson.js
CHANGED
|
@@ -13,94 +13,100 @@ const common = require('./common.js');
|
|
|
13
13
|
|
|
14
14
|
// Note: node version specify rules for engines clase and do NOT reflect the recommended node version for users
|
|
15
15
|
const recommendedNodeVersion = '18'; // This is the minimum node version that should be required at engines clause
|
|
16
|
-
const requiredNodeVersion = '18';
|
|
16
|
+
const requiredNodeVersion = '18'; // This is the minimum node version that must be required at engines clause
|
|
17
17
|
|
|
18
18
|
/* TODO: configuration should be moved to context */
|
|
19
19
|
|
|
20
20
|
const dependenciesPackageJson = {
|
|
21
21
|
'@iobroker/adapter-core': {
|
|
22
22
|
required: '3.1.4',
|
|
23
|
-
recommended: '3.2.
|
|
23
|
+
recommended: '3.2.3',
|
|
24
24
|
},
|
|
25
25
|
};
|
|
26
26
|
|
|
27
27
|
const devDependenciesPackageJson = {
|
|
28
28
|
'@iobroker/testing': {
|
|
29
29
|
required: '4.1.3',
|
|
30
|
-
recommended: '
|
|
30
|
+
recommended: '5.0.0',
|
|
31
31
|
onlyWWW: false,
|
|
32
32
|
},
|
|
33
33
|
};
|
|
34
34
|
|
|
35
35
|
const blacklistedDependenciesPackageJson = {
|
|
36
|
-
|
|
36
|
+
npm: {
|
|
37
37
|
msg: "'npm'must not be listed as dependency at package.json. Please remove and create new release.",
|
|
38
|
-
err: true
|
|
38
|
+
err: true,
|
|
39
39
|
},
|
|
40
40
|
'iobroker.js-controller': {
|
|
41
41
|
msg: "'iobroker.js-controller' must not be listed as dependency at package.json.Please remove and create new release.",
|
|
42
|
-
err: true
|
|
42
|
+
err: true,
|
|
43
43
|
},
|
|
44
44
|
'@iobroker/adapter-dev': {
|
|
45
|
-
msg: "'@iobroker/adapter-dev' must not be listed as dependency at package.json. Please
|
|
46
|
-
err: true
|
|
45
|
+
msg: "'@iobroker/adapter-dev' must not be listed as dependency at package.json. Please move to dependencies and create a new release.",
|
|
46
|
+
err: true,
|
|
47
47
|
},
|
|
48
48
|
'@iobroker/dev-server': {
|
|
49
|
-
msg: "'@iobroker/dev-server' must not be listed as dependency at package.json. Please
|
|
50
|
-
err: true
|
|
49
|
+
msg: "'@iobroker/dev-server' must not be listed as dependency at package.json. Please move to dependencies and create a new release.",
|
|
50
|
+
err: true,
|
|
51
51
|
},
|
|
52
52
|
'@iobroker/plugin-sentry': {
|
|
53
53
|
msg: "'@iobroker/plugin-sentry' must not be listed as dependency at package.json as it will crash js-controller 7 systems. Please remove and create new release.",
|
|
54
|
-
err: true
|
|
54
|
+
err: true,
|
|
55
55
|
},
|
|
56
56
|
'@iobroker/repochecker': {
|
|
57
57
|
msg: "'@iobroker/repochecker' must not be listed as dependency at package.json. Please remove and create new release.",
|
|
58
|
-
err: true
|
|
58
|
+
err: true,
|
|
59
59
|
},
|
|
60
60
|
'@alcalzone/release-script': {
|
|
61
|
-
msg: "'@alcalzone/release-script' must not be listed as dependency at package.json. Please
|
|
62
|
-
err: true
|
|
61
|
+
msg: "'@alcalzone/release-script' must not be listed as dependency at package.json. Please move to dependencies and create a new release.",
|
|
62
|
+
err: true,
|
|
63
63
|
},
|
|
64
64
|
'@alcalzone/release-script-plugin-iobroker': {
|
|
65
|
-
msg: "'@alcalzone/release-script-plugin-iobroker' must not be listed as dependency at package.json. Please
|
|
66
|
-
err: true
|
|
65
|
+
msg: "'@alcalzone/release-script-plugin-iobroker' must not be listed as dependency at package.json. Please move to dependencies and create a new release.",
|
|
66
|
+
err: true,
|
|
67
67
|
},
|
|
68
68
|
'@alcalzone/release-script-plugin-license': {
|
|
69
|
-
msg: "'@alcalzone/release-script-plugin-license' must not be listed as dependency at package.json. Please
|
|
70
|
-
err: true
|
|
69
|
+
msg: "'@alcalzone/release-script-plugin-license' must not be listed as dependency at package.json. Please move to dependencies and create a new release.",
|
|
70
|
+
err: true,
|
|
71
71
|
},
|
|
72
72
|
'@alcalzone/release-script-plugin-package': {
|
|
73
|
-
msg: "'@alcalzone/release-script-plugin-package' must not be listed as dependency at package.json. Please
|
|
74
|
-
err: true
|
|
73
|
+
msg: "'@alcalzone/release-script-plugin-package' must not be listed as dependency at package.json. Please move to dependencies and create a new release.",
|
|
74
|
+
err: true,
|
|
75
75
|
},
|
|
76
76
|
'@alcalzone/release-script-plugin-manual-review': {
|
|
77
|
-
msg: "'@alcalzone/release-script-plugin-manual-review' must not be listed as dependency at package.json. Please
|
|
78
|
-
err: true
|
|
77
|
+
msg: "'@alcalzone/release-script-plugin-manual-review' must not be listed as dependency at package.json. Please move to dependencies and create a new release.",
|
|
78
|
+
err: true,
|
|
79
79
|
},
|
|
80
80
|
'@alcalzone/release-script-plugin-version': {
|
|
81
|
-
msg: "'@alcalzone/release-script-plugin-version' must not be listed as dependency at package.json. Please
|
|
82
|
-
err: true
|
|
81
|
+
msg: "'@alcalzone/release-script-plugin-version' must not be listed as dependency at package.json. Please move to dependencies and create a new release.",
|
|
82
|
+
err: true,
|
|
83
|
+
},
|
|
84
|
+
request: {
|
|
85
|
+
msg: "'request' package is deprecated and no longer maintained. Please consider migrating to package 'axios'.",
|
|
86
|
+
err: false,
|
|
83
87
|
},
|
|
84
88
|
};
|
|
85
89
|
|
|
86
90
|
const blacklistedDevDependenciesPackageJson = {
|
|
87
|
-
|
|
91
|
+
npm: {
|
|
88
92
|
msg: "'npm'must not be listed as devDependency at package.json. Please remove.",
|
|
89
|
-
err: true
|
|
93
|
+
err: true,
|
|
90
94
|
},
|
|
91
95
|
'iobroker.js-controller': {
|
|
92
96
|
msg: "'iobroker.js-controller' must not be listed as devDependency at package.json. Please remove.",
|
|
93
|
-
err: true
|
|
97
|
+
err: true,
|
|
94
98
|
},
|
|
95
99
|
'@iobroker/plugin-sentry': {
|
|
96
100
|
msg: "'@iobroker/plugin-sentry' must not be listed as devDependency at package.json. Please remove.",
|
|
97
|
-
err: true
|
|
101
|
+
err: true,
|
|
102
|
+
},
|
|
103
|
+
'@iobroker/adapter-core': {
|
|
104
|
+
msg: "'@iobroker/adapter-core' must not be listed as devDependency at package.json. Please move to dependencies and create a new release.",
|
|
105
|
+
err: true,
|
|
98
106
|
},
|
|
99
107
|
};
|
|
100
108
|
|
|
101
|
-
const blacklistPackageJson = {
|
|
102
|
-
|
|
103
|
-
};
|
|
109
|
+
const blacklistPackageJson = {};
|
|
104
110
|
|
|
105
111
|
async function getPackageJson(context) {
|
|
106
112
|
console.log('\ngetPackageJson');
|
|
@@ -127,7 +133,9 @@ async function checkPackageJson(context) {
|
|
|
127
133
|
}
|
|
128
134
|
|
|
129
135
|
if (context.githubUrlOriginal.includes('/iobroker.')) {
|
|
130
|
-
context.errors.push(
|
|
136
|
+
context.errors.push(
|
|
137
|
+
'[E003] Repository must have name ioBroker.adaptername, but now io"b"roker is in lowercase',
|
|
138
|
+
);
|
|
131
139
|
} else {
|
|
132
140
|
context.checks.push('Repository has name ioBroker.adaptername (not iobroker.adaptername)');
|
|
133
141
|
}
|
|
@@ -150,7 +158,9 @@ async function checkPackageJson(context) {
|
|
|
150
158
|
}
|
|
151
159
|
|
|
152
160
|
if (adapterName.match(/[^-_a-z\d]/)) {
|
|
153
|
-
context.errors.push(
|
|
161
|
+
context.errors.push(
|
|
162
|
+
`[E006] Invalid characters found in adapter name "${adapterName}". Only lowercase chars, digits, "-" and "_" are allowed`,
|
|
163
|
+
);
|
|
154
164
|
} else {
|
|
155
165
|
context.checks.push(`No invalid characters found in "${adapterName}"`);
|
|
156
166
|
}
|
|
@@ -169,9 +179,13 @@ async function checkPackageJson(context) {
|
|
|
169
179
|
}
|
|
170
180
|
|
|
171
181
|
if (context.packageJson.name !== `iobroker.${adapterName.toLowerCase()}`) {
|
|
172
|
-
context.errors.push(
|
|
182
|
+
context.errors.push(
|
|
183
|
+
`[E020] Name of adapter in package.json must be lowercase and be equal to "iobroker.${adapterName.toLowerCase()}". Now is "${context.packageJson.name}"`,
|
|
184
|
+
);
|
|
173
185
|
} else {
|
|
174
|
-
context.checks.push(
|
|
186
|
+
context.checks.push(
|
|
187
|
+
`Name of adapter in package.json must be lowercase and be equal to "iobroker.${adapterName.toLowerCase()}".`,
|
|
188
|
+
);
|
|
175
189
|
}
|
|
176
190
|
|
|
177
191
|
if (!context.packageJson.version) {
|
|
@@ -187,7 +201,9 @@ async function checkPackageJson(context) {
|
|
|
187
201
|
}
|
|
188
202
|
|
|
189
203
|
if (context.packageJson.licenses) {
|
|
190
|
-
context.errors.push(
|
|
204
|
+
context.errors.push(
|
|
205
|
+
'[E021] "licenses" in package.json are deprecated. Please remove and use "license": "NAME" field.',
|
|
206
|
+
);
|
|
191
207
|
} else {
|
|
192
208
|
context.checks.push('No "licenses" found in package.json');
|
|
193
209
|
}
|
|
@@ -199,7 +215,9 @@ async function checkPackageJson(context) {
|
|
|
199
215
|
}
|
|
200
216
|
|
|
201
217
|
if (context.packageJson._args) {
|
|
202
|
-
context.errors.push(
|
|
218
|
+
context.errors.push(
|
|
219
|
+
'[E014] NPM information found in package.json. Please remove all attributes starting with "_"',
|
|
220
|
+
);
|
|
203
221
|
} else {
|
|
204
222
|
context.checks.push('No npm generated attributes found in package.json');
|
|
205
223
|
}
|
|
@@ -211,7 +229,9 @@ async function checkPackageJson(context) {
|
|
|
211
229
|
|
|
212
230
|
// check if license valid
|
|
213
231
|
if (!context.cfg.allowedLicenses.includes(context.packageJson.license)) {
|
|
214
|
-
context.errors.push(
|
|
232
|
+
context.errors.push(
|
|
233
|
+
`[E016] ${context.packageJson.license} found in package.json is no valid SPDX license. Please use one of listed here: https://spdx.org/licenses/`,
|
|
234
|
+
);
|
|
215
235
|
} else {
|
|
216
236
|
context.checks.push('"license" is valid in package.json');
|
|
217
237
|
}
|
|
@@ -228,25 +248,31 @@ async function checkPackageJson(context) {
|
|
|
228
248
|
context.githubApiData.git_url, // git://github.com/klein0r/ioBroker.luftdaten.git
|
|
229
249
|
context.githubApiData.ssh_url, // git@github.com:klein0r/ioBroker.luftdaten.git
|
|
230
250
|
context.githubApiData.clone_url, // https://github.com/klein0r/ioBroker.luftdaten.git
|
|
231
|
-
`git+${context.githubApiData.clone_url}
|
|
251
|
+
`git+${context.githubApiData.clone_url}`, // git+https://github.com/klein0r/ioBroker.luftdaten.git
|
|
232
252
|
];
|
|
233
253
|
|
|
234
254
|
// https://docs.npmjs.com/cli/v7/configuring-npm/package-json#repository
|
|
235
255
|
if (context.packageJson.repository && typeof context.packageJson.repository === 'object') {
|
|
236
256
|
if (context.packageJson.repository.type !== 'git') {
|
|
237
|
-
context.errors.push(
|
|
257
|
+
context.errors.push(
|
|
258
|
+
`[E018] Invalid repository type in package.json: ${context.packageJson.repository.type}. It should be git`,
|
|
259
|
+
);
|
|
238
260
|
} else {
|
|
239
261
|
context.checks.push('Repository type is valid in package.json: git');
|
|
240
262
|
}
|
|
241
263
|
|
|
242
264
|
if (!allowedRepoUrls.includes(context.packageJson.repository.url)) {
|
|
243
|
-
context.errors.push(
|
|
265
|
+
context.errors.push(
|
|
266
|
+
`[E019] Invalid repository URL in package.json: ${context.packageJson.repository.url}. Expected: ${context.githubApiData.ssh_url} or ${context.githubApiData.clone_url}`,
|
|
267
|
+
);
|
|
244
268
|
} else {
|
|
245
269
|
context.checks.push('Repository URL is valid in package.json');
|
|
246
270
|
}
|
|
247
271
|
} else if (context.packageJson.repository && typeof context.packageJson.repository === 'string') {
|
|
248
272
|
if (!allowedRepoUrls.includes(context.packageJson.repository)) {
|
|
249
|
-
context.errors.push(
|
|
273
|
+
context.errors.push(
|
|
274
|
+
`[E019] Invalid repository URL in package.json: ${context.packageJson.repository}. Expected: ${context.githubApiData.ssh_url} or ${context.githubApiData.clone_url}`,
|
|
275
|
+
);
|
|
250
276
|
} else {
|
|
251
277
|
context.checks.push('Repository URL is valid in package.json');
|
|
252
278
|
}
|
|
@@ -317,10 +343,14 @@ async function checkPackageJson(context) {
|
|
|
317
343
|
|
|
318
344
|
if (!context.ioPackageJson.common.onlyWWW) {
|
|
319
345
|
if (!context.packageJson.engines) {
|
|
320
|
-
context.errors.push(
|
|
346
|
+
context.errors.push(
|
|
347
|
+
`[E026] "{'engines': {'node'>='${requiredNodeVersion}'}}" is required at package.json, "{'engines':{'node'>='${recommendedNodeVersion}'}}" is recommended`,
|
|
348
|
+
);
|
|
321
349
|
} else {
|
|
322
350
|
if (!context.packageJson.engines.node) {
|
|
323
|
-
context.errors.push(
|
|
351
|
+
context.errors.push(
|
|
352
|
+
`[E026] "{'engines': {'node'>='${requiredNodeVersion}'}}" is required at package.json, "{'engines':{'node'>='${recommendedNodeVersion}'}}" is recommended`,
|
|
353
|
+
);
|
|
324
354
|
} else {
|
|
325
355
|
context.checks.push('engines attribute containing node requirements exist.');
|
|
326
356
|
// 'engines': { 'node': '>= 18' }
|
|
@@ -329,18 +359,28 @@ async function checkPackageJson(context) {
|
|
|
329
359
|
const nodeVal = context.packageJson.engines.node;
|
|
330
360
|
const match = nodeVal.match(/^(?<cmp>[<>=~]+)?\s*(?<vers>\d+(\.\d+(\.\d+)?)?(-\w+\.\d+)?)/m);
|
|
331
361
|
if (!match) {
|
|
332
|
-
context.warnings.push(
|
|
362
|
+
context.warnings.push(
|
|
363
|
+
`[W027] Engines clause at at package.json ({'engines' : { 'node' : '${nodeVal}' } }") is not parseable.`,
|
|
364
|
+
);
|
|
333
365
|
} else {
|
|
334
366
|
common.debug(`node check: ${JSON.stringify(match.groups)}`);
|
|
335
367
|
if (match.groups.cmp !== '>' && match.groups.cmp !== '>=') {
|
|
336
|
-
context.warnings.push(
|
|
368
|
+
context.warnings.push(
|
|
369
|
+
`[W028] Minimum node.js version ${recommendedNodeVersion} recommended. Please adapt "{'engines' : { 'node' >= '${match.groups.vers}' } }" at package.json.`,
|
|
370
|
+
);
|
|
337
371
|
} else {
|
|
338
372
|
if (!compareVersions.compare(match.groups.vers, requiredNodeVersion, '>=')) {
|
|
339
|
-
context.errors.push(
|
|
373
|
+
context.errors.push(
|
|
374
|
+
`[E029] Node.js ${requiredNodeVersion} is required as minimum, node.js ${recommendedNodeVersion} is recommended. Please adapt "{'engines' : { 'node' >= '${match.groups.vers}' } }" at package.json.`,
|
|
375
|
+
);
|
|
340
376
|
} else if (!compareVersions.compare(match.groups.vers, recommendedNodeVersion, '>=')) {
|
|
341
|
-
context.warnings.push(
|
|
377
|
+
context.warnings.push(
|
|
378
|
+
`[W028] Minimum node.js version ${recommendedNodeVersion} recommended. Please adapt "{'engines' : { 'node' >= '${match.groups.vers}' } }" at package.json.`,
|
|
379
|
+
);
|
|
342
380
|
} else {
|
|
343
|
-
context.checks.push(
|
|
381
|
+
context.checks.push(
|
|
382
|
+
`Correct node.js version ${match.groups.vers} requested by "engines" attribute at package.json.`,
|
|
383
|
+
);
|
|
344
384
|
}
|
|
345
385
|
}
|
|
346
386
|
}
|
|
@@ -355,13 +395,19 @@ async function checkPackageJson(context) {
|
|
|
355
395
|
const requiredVersion = dependenciesPackageJson[dependency].required;
|
|
356
396
|
const recommendedVersion = dependenciesPackageJson[dependency].recommended;
|
|
357
397
|
let dependencyVersion = context.packageJson.dependencies[`${dependency}`] || '';
|
|
358
|
-
dependencyVersion = dependencyVersion.replace(/[\^~]/, '');
|
|
398
|
+
dependencyVersion = dependencyVersion.replace(/[\^~]/, '').trim();
|
|
359
399
|
if (!dependencyVersion) {
|
|
360
|
-
context.errors.push(
|
|
400
|
+
context.errors.push(
|
|
401
|
+
`[E032] No dependency declared for ${dependency}. Please add "${dependency}":"${recommendedVersion}" to dependencies at package.json`,
|
|
402
|
+
);
|
|
361
403
|
} else if (!compareVersions.compare(dependencyVersion, requiredVersion, '>=')) {
|
|
362
|
-
context.errors.push(
|
|
404
|
+
context.errors.push(
|
|
405
|
+
`[E033] ${dependency} ${dependencyVersion} specified. ${requiredVersion} is required as minimum, ${recommendedVersion} is recommended. Please update dependencies at package.json`,
|
|
406
|
+
);
|
|
363
407
|
} else if (!compareVersions.compare(dependencyVersion, recommendedVersion, '>=')) {
|
|
364
|
-
context.warnings.push(
|
|
408
|
+
context.warnings.push(
|
|
409
|
+
`[W034] ${dependency} ${dependencyVersion} specified. ${recommendedVersion} is recommended. Please consider updating dependencies at package.json`,
|
|
410
|
+
);
|
|
365
411
|
} else {
|
|
366
412
|
context.checks.push('dependency ${dependency} ${dependencyVersion} is ok');
|
|
367
413
|
}
|
|
@@ -372,17 +418,25 @@ async function checkPackageJson(context) {
|
|
|
372
418
|
}
|
|
373
419
|
|
|
374
420
|
for (const dependency in devDependenciesPackageJson) {
|
|
375
|
-
if (
|
|
421
|
+
if (devDependenciesPackageJson[dependency].onlyWWW === false && context.ioPackageJson.common.onlyWWW) {
|
|
422
|
+
continue;
|
|
423
|
+
}
|
|
376
424
|
const requiredVersion = devDependenciesPackageJson[dependency].required;
|
|
377
425
|
const recommendedVersion = devDependenciesPackageJson[dependency].recommended;
|
|
378
426
|
let dependencyVersion = context.packageJson.devDependencies[`${dependency}`] || '';
|
|
379
427
|
dependencyVersion = dependencyVersion.replace(/[\^~]/, '');
|
|
380
428
|
if (!dependencyVersion) {
|
|
381
|
-
context.errors.push(
|
|
429
|
+
context.errors.push(
|
|
430
|
+
`[E035] No devDependency declared for ${dependency}. Please add "${dependency}":"${recommendedVersion}" to devDependencies at package.json`,
|
|
431
|
+
);
|
|
382
432
|
} else if (!compareVersions.compare(dependencyVersion, requiredVersion, '>=')) {
|
|
383
|
-
context.errors.push(
|
|
433
|
+
context.errors.push(
|
|
434
|
+
`[E036] ${dependency} ${dependencyVersion} specified. ${requiredVersion} is required as minimum, ${recommendedVersion} is recommended. Please update devDependencies at package.json`,
|
|
435
|
+
);
|
|
384
436
|
} else if (!compareVersions.compare(dependencyVersion, recommendedVersion, '>=')) {
|
|
385
|
-
context.warnings.push(
|
|
437
|
+
context.warnings.push(
|
|
438
|
+
`[W037] ${dependency} ${dependencyVersion} specified. ${recommendedVersion} is recommended. Please consider updating devDependencies at package.json`,
|
|
439
|
+
);
|
|
386
440
|
} else {
|
|
387
441
|
context.checks.push('devDependency ${dependency} ${dependencyVersion} is ok');
|
|
388
442
|
}
|
|
@@ -396,34 +450,56 @@ async function checkPackageJson(context) {
|
|
|
396
450
|
'@alcalzone/release-script-plugin-license',
|
|
397
451
|
'@alcalzone/release-script-manual-review',
|
|
398
452
|
'@iobroker/adapter-dev',
|
|
399
|
-
'@iobroker/testing'
|
|
453
|
+
'@iobroker/testing',
|
|
400
454
|
];
|
|
401
455
|
for (const dependency in context.packageJson.dependencies) {
|
|
402
|
-
if (!context.packageJson.dependencies[dependency].
|
|
456
|
+
if (!context.packageJson.dependencies[dependency].match(/^(\^|~|>|>=|<|<=)?\d+\.\d+\.\d+$/gm)) {
|
|
457
|
+
context.errors.push(
|
|
458
|
+
`[E054] malformed dependency detected "${dependency}":${context.packageJson.dependencies[dependency]}". Please fix at package.json.`,
|
|
459
|
+
);
|
|
460
|
+
} else if (
|
|
461
|
+
!context.packageJson.dependencies[dependency].startsWith('^') &&
|
|
403
462
|
!context.packageJson.dependencies[dependency].startsWith('~') &&
|
|
404
463
|
!context.packageJson.dependencies[dependency].startsWith('>')
|
|
405
464
|
) {
|
|
406
465
|
if (context.packageJson.dependencies[dependency].toLowerCase().includes('github.com')) {
|
|
407
|
-
context.warnings.push(
|
|
466
|
+
context.warnings.push(
|
|
467
|
+
`[W043] dependency should not require a github version. Please change "${dependency}:${context.packageJson.dependencies[dependency]}"`,
|
|
468
|
+
);
|
|
408
469
|
} else if (enforcedDependencies.includes(dependency)) {
|
|
409
|
-
context.errors.push(
|
|
470
|
+
context.errors.push(
|
|
471
|
+
`[E044] dependency must not require a specific version. Use "~1.2.3" or "^1.2.3" syntax. Please update "${dependency}:${context.packageJson.dependencies[dependency]}"`,
|
|
472
|
+
);
|
|
410
473
|
} else {
|
|
411
|
-
context.warnings.push(
|
|
474
|
+
context.warnings.push(
|
|
475
|
+
`[W047] dependency should not require a specific version. Use "~1.2.3" or "^1.2.3" syntax. Please update "${dependency}:${context.packageJson.dependencies[dependency]}"`,
|
|
476
|
+
);
|
|
412
477
|
}
|
|
413
478
|
}
|
|
414
479
|
}
|
|
415
480
|
|
|
416
481
|
for (const dependency in context.packageJson.devDependencies) {
|
|
417
|
-
if (!context.packageJson.devDependencies[dependency].
|
|
482
|
+
if (!context.packageJson.devDependencies[dependency].match(/^(\^|~|>|>=|<|<=)?\d+\.\d+\.\d+$/gm)) {
|
|
483
|
+
context.errors.push(
|
|
484
|
+
`[E055] malformed dependency detected "${dependency}":${context.packageJson.devDependencies[dependency]}". Please fix at package.json.`,
|
|
485
|
+
);
|
|
486
|
+
} else if (
|
|
487
|
+
!context.packageJson.devDependencies[dependency].startsWith('^') &&
|
|
418
488
|
!context.packageJson.devDependencies[dependency].startsWith('~') &&
|
|
419
489
|
!context.packageJson.devDependencies[dependency].startsWith('>')
|
|
420
490
|
) {
|
|
421
491
|
if (context.packageJson.devDependencies[dependency].toLowerCase().includes('github.com')) {
|
|
422
|
-
context.warnings.push(
|
|
492
|
+
context.warnings.push(
|
|
493
|
+
`[W045] devDependency should not require github versions. Please change "${dependency}:${context.packageJson.devDependencies[dependency]}"`,
|
|
494
|
+
);
|
|
423
495
|
} else if (enforcedDependencies.includes(dependency)) {
|
|
424
|
-
context.errors.push(
|
|
496
|
+
context.errors.push(
|
|
497
|
+
`[E046] devDependency must not require a specific version. Use "~1.2.3" or "^1.2.3" syntax. Please update "${dependency}:${context.packageJson.devDependencies[dependency]}"`,
|
|
498
|
+
);
|
|
425
499
|
} else {
|
|
426
|
-
context.warnings.push(
|
|
500
|
+
context.warnings.push(
|
|
501
|
+
`[W048] devDependency should not require a specific version. Use "~1.2.3" or "^1.2.3" syntax. Please update "${dependency}:${context.packageJson.devDependencies[dependency]}"`,
|
|
502
|
+
);
|
|
427
503
|
}
|
|
428
504
|
}
|
|
429
505
|
}
|
|
@@ -461,22 +537,39 @@ async function checkPackageJson(context) {
|
|
|
461
537
|
const ignoredKeywords = ['iobroker', 'smart home', 'smarthome', 'home automation', 'template'];
|
|
462
538
|
const recommendedKeywords = ['ioBroker'];
|
|
463
539
|
common.debug(`package.keywords: "${context.packageJson.keywords.join(', ')}"`);
|
|
464
|
-
common.debug(
|
|
465
|
-
|
|
466
|
-
|
|
540
|
+
common.debug(
|
|
541
|
+
`filtered: "${context.packageJson.keywords.filter(keyword => !ignoredKeywords.includes(keyword.toLowerCase()))}"`,
|
|
542
|
+
);
|
|
543
|
+
if (
|
|
544
|
+
context.packageJson.keywords.filter(keyword => !ignoredKeywords.includes(keyword.toLowerCase())).length ===
|
|
545
|
+
0
|
|
546
|
+
) {
|
|
547
|
+
context.errors.push(
|
|
548
|
+
`[E049] "keywords" within package.json must contain some keywords besides "${context.packageJson.keywords.join(', ')}" related to adapter`,
|
|
549
|
+
);
|
|
467
550
|
}
|
|
468
551
|
if (!recommendedKeywords.filter(keyword => context.packageJson.keywords.includes(keyword)).length > 0) {
|
|
469
|
-
context.warnings.push(
|
|
552
|
+
context.warnings.push(
|
|
553
|
+
`[W040] "keywords" within package.json should contain "${recommendedKeywords.join(', ')}"`,
|
|
554
|
+
);
|
|
470
555
|
}
|
|
471
|
-
if (
|
|
472
|
-
|
|
556
|
+
if (
|
|
557
|
+
forbiddenKeywords.filter(keyword =>
|
|
558
|
+
context.packageJson.keywords.map(k => k.toLowerCase()).includes(keyword),
|
|
559
|
+
).length > 0
|
|
560
|
+
) {
|
|
561
|
+
context.warnings.push(
|
|
562
|
+
`[W041] "keywords" within package.json should not contain "${forbiddenKeywords.join(', ')}"`,
|
|
563
|
+
);
|
|
473
564
|
}
|
|
474
565
|
|
|
475
566
|
context.checks.push('"keywords" found in package.json and refers to an array');
|
|
476
567
|
}
|
|
477
568
|
|
|
478
569
|
if (context.packageJson.globalDependencies) {
|
|
479
|
-
context.errors.push(
|
|
570
|
+
context.errors.push(
|
|
571
|
+
'[E042] "globalDependencies" is misplaced at package.json. Did you mean "common.globalDependencies" at io-package.json?',
|
|
572
|
+
);
|
|
480
573
|
} else {
|
|
481
574
|
context.checks.push('"globalDependencies" not found in package.json');
|
|
482
575
|
}
|
|
@@ -546,8 +639,9 @@ exports.checkPackageJson = checkPackageJson;
|
|
|
546
639
|
// [047] dependency should not require a specific version. Use "~1.2.3" or "^1.2.3" syntax. Please update "${dependency}:${context.packageJson.dependencies[dependency]}"
|
|
547
640
|
// [048] devDependency should not require a specific version. Use "~1.2.3" or "^1.2.3" syntax. Please update "${dependency}:${context.packageJson.devDependencies[dependency]}"
|
|
548
641
|
// [049] "keywords" within package.json must contain some keywords besides "${context.packageJson.keywords.join(', ')}" related to adapter
|
|
549
|
-
// [
|
|
550
|
-
// [
|
|
551
|
-
// [
|
|
552
|
-
// [
|
|
553
|
-
|
|
642
|
+
// [050] ${blacklistedDependenciesPackageJson[blacklist].msg}
|
|
643
|
+
// [051] ${blacklistedDependenciesPackageJson[blacklist].msg}.
|
|
644
|
+
// [052] ${blacklistedDevDependenciesPackageJson[blacklist].msg}
|
|
645
|
+
// [053] ${blacklistedDevDependenciesPackageJson[blacklist].msg}
|
|
646
|
+
// [054] malformed dependency detected "${dependency}":${context.packageJson.dependencies[dependency]}". Please fix at package.json.`
|
|
647
|
+
// [055] malformed dependency detected "${dependency}":${context.packageJson.devDependencies[dependency]}". Please fix at package.json.`
|