@iobroker/repochecker 3.3.1 → 3.4.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.
@@ -1,4 +1,5 @@
1
1
  'use strict';
2
+
2
3
  /*
3
4
  This module is a support module for iobroker.repochecker
4
5
 
@@ -11,102 +12,203 @@ const compareVersions = require('compare-versions');
11
12
 
12
13
  const common = require('./common.js');
13
14
 
14
- // Note: node version specify rules for engines clase and do NOT reflect the recommended node version for users
15
+ /* TODO: configuration should be moved to context */
16
+
17
+ // node.js versions required and recommended
18
+ // Note: node version specify rules for engines clause and do NOT reflect the recommended node version for users
15
19
  const recommendedNodeVersion = '18'; // This is the minimum node version that should be required at engines clause
16
20
  const requiredNodeVersion = '18'; // This is the minimum node version that must be required at engines clause
17
21
 
18
- /* TODO: configuration should be moved to context */
19
-
22
+ // packages which must or should be required as dependencies
20
23
  const dependenciesPackageJson = {
21
24
  '@iobroker/adapter-core': {
22
- required: '3.1.4',
25
+ required: '3.2.3',
23
26
  recommended: '3.2.3',
27
+ onlyWWW: false,
24
28
  },
25
29
  };
26
30
 
31
+ // packages which must or should be required as devDependencies
27
32
  const devDependenciesPackageJson = {
33
+ '@iobroker/adapter-dev': {
34
+ required: '1.3.0',
35
+ recommended: '1.3.0',
36
+ onlyWWW: false,
37
+ optional: true,
38
+ suggested: true,
39
+ },
40
+ '@iobroker/legacy-testing': {
41
+ required: '2.0.2',
42
+ recommended: '2.0.2',
43
+ onlyWWW: false,
44
+ optional: true,
45
+ },
28
46
  '@iobroker/testing': {
29
47
  required: '4.1.3',
30
48
  recommended: '5.0.0',
31
49
  onlyWWW: false,
50
+ alternatives: ['@iobroker/legacy-testing'],
51
+ },
52
+ '@alcalzone/release-script': {
53
+ required: '3.8.0',
54
+ recommended: '3.8.0',
55
+ optional: true,
56
+ suggested: true,
32
57
  },
33
58
  };
34
59
 
35
- const blacklistedDependenciesPackageJson = {
60
+ // packages which must NOT be listed as dependencies in any context
61
+ const blacklistedAllDependenciesPackageJson = {
36
62
  npm: {
37
- msg: "'npm'must not be listed as dependency at package.json. Please remove and create new release.",
63
+ msg: "'npm'must not be listed as any dependency at package.json. Please remove and create new release.",
38
64
  err: true,
39
65
  },
40
66
  'iobroker.js-controller': {
41
- msg: "'iobroker.js-controller' must not be listed as dependency at package.json.Please remove and create new release.",
67
+ msg: "'iobroker.js-controller' must not be listed as any dependency at package.json. Please remove and create new release.",
42
68
  err: true,
43
69
  },
44
- '@iobroker/adapter-dev': {
45
- msg: "'@iobroker/adapter-dev' must not be listed as dependency at package.json. Please move to dependencies and create a new release.",
70
+ '@iobroker/plugin-sentry': {
71
+ msg: "'@iobroker/plugin-sentry' must not be listed as any dependency at package.json as it will crash js-controller 7 systems. Please remove and create new release.",
46
72
  err: true,
47
73
  },
48
- '@iobroker/dev-server': {
49
- msg: "'@iobroker/dev-server' must not be listed as dependency at package.json. Please move to dependencies and create a new release.",
74
+ '@iobroker/repochecker': {
75
+ msg: "'@iobroker/repochecker' must not be listed as any dependency at package.json. Please remove and create new release.",
50
76
  err: true,
51
77
  },
52
- '@iobroker/plugin-sentry': {
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.",
78
+ request: {
79
+ msg: "'request' package is deprecated and no longer maintained. Please consider migrating to package 'axios'.",
80
+ err: false,
81
+ },
82
+ };
83
+
84
+ // packages which must NOT be listed as dependencies
85
+ const blacklistedDependenciesPackageJson = {
86
+ ...blacklistedAllDependenciesPackageJson,
87
+
88
+ '@iobroker/adapter-core': {
89
+ msg: "'@iobroker/adapter-core' seems to be obsolete as dependency at package.json as 'common.onlyWWW' is set to true.",
90
+ err: false,
91
+ onlyWWW: true,
92
+ },
93
+
94
+ '@iobroker/adapter-dev': {
95
+ msg: "'@iobroker/adapter-dev' must not be listed as dependency at package.json. Please move to devDependencies and create a new release.",
54
96
  err: true,
55
97
  },
56
- '@iobroker/repochecker': {
57
- msg: "'@iobroker/repochecker' must not be listed as dependency at package.json. Please remove and create new release.",
98
+ '@iobroker/dev-server': {
99
+ msg: "'@iobroker/dev-server' must not be listed as dependency at package.json. Please move to devDependencies and create a new release.",
58
100
  err: true,
59
101
  },
60
102
  '@alcalzone/release-script': {
61
- msg: "'@alcalzone/release-script' must not be listed as dependency at package.json. Please move to dependencies and create a new release.",
103
+ msg: "'@alcalzone/release-script' must not be listed as dependency at package.json. Please move to devDependencies and create a new release.",
62
104
  err: true,
63
105
  },
64
106
  '@alcalzone/release-script-plugin-iobroker': {
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.",
107
+ msg: "'@alcalzone/release-script-plugin-iobroker' must not be listed as dependency at package.json. Please move to devDependencies and create a new release.",
66
108
  err: true,
67
109
  },
68
110
  '@alcalzone/release-script-plugin-license': {
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.",
111
+ msg: "'@alcalzone/release-script-plugin-license' must not be listed as dependency at package.json. Please move to devDependencies and create a new release.",
70
112
  err: true,
71
113
  },
72
114
  '@alcalzone/release-script-plugin-package': {
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.",
115
+ msg: "'@alcalzone/release-script-plugin-package' must not be listed as dependency at package.json. Please move to devDependencies and create a new release.",
74
116
  err: true,
75
117
  },
76
118
  '@alcalzone/release-script-plugin-manual-review': {
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.",
119
+ msg: "'@alcalzone/release-script-plugin-manual-review' must not be listed as dependency at package.json. Please move to devDependencies and create a new release.",
78
120
  err: true,
79
121
  },
80
122
  '@alcalzone/release-script-plugin-version': {
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.",
123
+ msg: "'@alcalzone/release-script-plugin-version' must not be listed as dependency at package.json. Please move to devDependencies and create a new release.",
82
124
  err: true,
83
125
  },
84
- request: {
85
- msg: "'request' package is deprecated and no longer maintained. Please consider migrating to package 'axios'.",
86
- err: false,
87
- },
88
126
  };
89
127
 
128
+ // packages which must NOT be listed as devDependencies
90
129
  const blacklistedDevDependenciesPackageJson = {
91
- npm: {
92
- msg: "'npm'must not be listed as devDependency at package.json. Please remove.",
130
+ ...blacklistedAllDependenciesPackageJson,
131
+
132
+ '@iobroker/adapter-core': {
133
+ msg: "'@iobroker/adapter-core' must not be listed as devDependency at package.json. Please move to dependencies and create a new release.",
93
134
  err: true,
94
135
  },
95
- 'iobroker.js-controller': {
96
- msg: "'iobroker.js-controller' must not be listed as devDependency at package.json. Please remove.",
97
- err: true,
136
+ axios: {
137
+ msg: "Package 'axios' listed as devDependency at package.json might be obsolete if using '@iobroker/adapter-dev'.",
138
+ err: false,
98
139
  },
99
- '@iobroker/plugin-sentry': {
100
- msg: "'@iobroker/plugin-sentry' must not be listed as devDependency at package.json. Please remove.",
140
+ };
141
+
142
+ // packages which must NOT be listed as peerDependencies
143
+ const blacklistedPeerDependenciesPackageJson = {
144
+ ...blacklistedAllDependenciesPackageJson,
145
+ ...blacklistedDependenciesPackageJson,
146
+
147
+ '@iobroker/adapter-core': {
148
+ msg: "'@iobroker/adapter-core' must not be listed as peerDependency at package.json. Please move to dependencies and create a new release.",
101
149
  err: true,
102
150
  },
151
+ };
152
+
153
+ // packages which must NOT be listed as optionalDependencies
154
+ const blacklistedOptionalDependenciesPackageJson = {
155
+ ...blacklistedAllDependenciesPackageJson,
156
+ ...blacklistedDependenciesPackageJson,
157
+
103
158
  '@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.",
159
+ msg: "'@iobroker/adapter-core' must not be listed as optionalDependency at package.json. Please move to dependencies and create a new release.",
105
160
  err: true,
106
161
  },
107
162
  };
108
163
 
109
- const blacklistPackageJson = {};
164
+ const blacklistPackageJson = {
165
+ licenses: {
166
+ msg: 'Attribute "licenses" in package.json is deprecated. Please remove and use "license": "NAME" attribute.',
167
+ err: true,
168
+ },
169
+ };
170
+
171
+ const validObjectsPackageJson = [
172
+ 'author',
173
+ 'bin',
174
+ // 'browser',
175
+ 'bugs',
176
+ 'bundleDependencies',
177
+ // 'config',
178
+ 'contributors',
179
+ 'cpu',
180
+ 'dependencies',
181
+ 'description',
182
+ 'devDependencies',
183
+ 'devEngines',
184
+ 'directories',
185
+ 'directories.bin',
186
+ 'directories.man',
187
+ 'engines',
188
+ // 'exports',
189
+ 'files',
190
+ 'funding',
191
+ 'homepage',
192
+ 'keywords',
193
+ 'libc',
194
+ 'license',
195
+ 'licenses', // deprecated
196
+ 'main',
197
+ 'man',
198
+ 'name',
199
+ 'optionalDependencies',
200
+ 'os',
201
+ 'overrides',
202
+ 'peerDependencies',
203
+ 'peerDependenciesMeta',
204
+ // 'private',
205
+ // 'publishConfig',
206
+ 'readmeFilename', // deprecated
207
+ 'repository',
208
+ 'scripts',
209
+ 'version',
210
+ 'workspaces',
211
+ ];
110
212
 
111
213
  async function getPackageJson(context) {
112
214
  console.log('\ngetPackageJson');
@@ -126,6 +228,8 @@ async function getPackageJson(context) {
126
228
  async function checkPackageJson(context) {
127
229
  console.log('\ncheckPackageJson [E001 - E099]');
128
230
 
231
+ let passed;
232
+
129
233
  if (!context.githubUrlOriginal.match(/\/iobroker\./i)) {
130
234
  context.errors.push('[E002] No "ioBroker." found in the name of repository');
131
235
  } else {
@@ -178,7 +282,49 @@ async function checkPackageJson(context) {
178
282
  context.authorName = n[1];
179
283
  }
180
284
 
181
- if (context.packageJson.name !== `iobroker.${adapterName.toLowerCase()}`) {
285
+ // check if only allowed objects exist at package.json
286
+ passed = true;
287
+ for (const objectName in context.packageJson) {
288
+ if (objectName.startsWith('_')) {
289
+ context.errors.push(
290
+ `[E014] NPM information (attribute "${objectName}") found in package.json. Please remove all attributes starting with "_"`,
291
+ );
292
+ passed = false;
293
+ } else if (!validObjectsPackageJson.includes(objectName)) {
294
+ context.errors.push(`[E058] Attribute "${objectName}" at package.json is not supported. Please remove.`);
295
+ passed = false;
296
+ }
297
+ }
298
+ if (passed) {
299
+ context.checks.push(`package.json does not contain unsupported objects.`);
300
+ }
301
+
302
+ for (const blacklist in blacklistPackageJson) {
303
+ // console.log(`checking blacklist ${blacklist}`);
304
+ let tmp = context.packageJson;
305
+ let log = '';
306
+ for (const element of blacklist.split('.')) {
307
+ log = `${log}.${element}`;
308
+ //console.log(` check ${log}`);
309
+ tmp = tmp[element];
310
+ if (!tmp) {
311
+ //console.log(` ${log} does not exist`);
312
+ break;
313
+ }
314
+ }
315
+ if (tmp) {
316
+ if (blacklistPackageJson[blacklist].err) {
317
+ context.errors.push(`[E038] ${blacklistPackageJson[blacklist].msg}`);
318
+ } else {
319
+ context.warnings.push(`[W038] ${blacklistPackageJson[blacklist].msg}`);
320
+ }
321
+ }
322
+ }
323
+ context.checks.push('blacklist for package.json checked.');
324
+
325
+ if (context.packageJson.name === undefined) {
326
+ context.errors.push(`[E008] No "name" key found in package.json.`);
327
+ } else if (context.packageJson.name !== `iobroker.${adapterName.toLowerCase()}`) {
182
328
  context.errors.push(
183
329
  `[E020] Name of adapter in package.json must be lowercase and be equal to "iobroker.${adapterName.toLowerCase()}". Now is "${context.packageJson.name}"`,
184
330
  );
@@ -189,38 +335,30 @@ async function checkPackageJson(context) {
189
335
  }
190
336
 
191
337
  if (!context.packageJson.version) {
192
- context.errors.push('[E009] No version found in the package.json');
338
+ context.errors.push('[E009] No "version" key found in the package.json');
193
339
  } else {
194
340
  context.checks.push('Version found in package.json');
195
341
  }
196
342
 
197
343
  if (!context.packageJson.description) {
198
- context.errors.push('[E010] No description found in the package.json');
344
+ context.errors.push('[E010] No "description" key found in the package.json');
199
345
  } else {
200
346
  context.checks.push('Description found in package.json');
201
347
  }
202
348
 
203
- if (context.packageJson.licenses) {
204
- context.errors.push(
205
- '[E021] "licenses" in package.json are deprecated. Please remove and use "license": "NAME" field.',
206
- );
207
- } else {
208
- context.checks.push('No "licenses" found in package.json');
209
- }
210
-
211
349
  if (!context.packageJson.author) {
212
- context.errors.push('[E013] No author found in the package.json');
350
+ context.errors.push('[E013] No "author" key found in the package.json');
213
351
  } else {
214
352
  context.checks.push('Author found in package.json');
215
353
  }
216
354
 
217
- if (context.packageJson._args) {
218
- context.errors.push(
219
- '[E014] NPM information found in package.json. Please remove all attributes starting with "_"',
220
- );
221
- } else {
222
- context.checks.push('No npm generated attributes found in package.json');
223
- }
355
+ // if (context.packageJson.licenses) {
356
+ // context.errors.push(
357
+ // '[E021] "licenses" in package.json are deprecated. Please remove and use "license": "NAME" field.',
358
+ // );
359
+ // } else {
360
+ // context.checks.push('"licenses" not found in package.json');
361
+ // }
224
362
 
225
363
  if (!context.packageJson.license) {
226
364
  context.errors.push('[E015] No license found in package.json');
@@ -238,7 +376,7 @@ async function checkPackageJson(context) {
238
376
  }
239
377
 
240
378
  if (!context.packageJson.repository) {
241
- context.errors.push('[E017] No repository found in the package.json');
379
+ context.errors.push('[E017] No "repository" key found in the package.json');
242
380
  } else {
243
381
  context.checks.push('Repository found in package.json');
244
382
 
@@ -281,67 +419,170 @@ async function checkPackageJson(context) {
281
419
  }
282
420
  }
283
421
 
422
+ if (!context.packageJson.scripts) {
423
+ context.errors.push('[E059] No "scripts" key found in the package.json');
424
+ } else {
425
+ context.checks.push('Scripts found in package.json');
426
+ }
427
+
284
428
  if (context.cfg.reservedAdapterNames.includes(adapterName)) {
285
429
  context.errors.push('[E022] Adapter name is reserved. Please rename adapter.');
286
430
  } else {
287
431
  context.checks.push('Adapter name is not reserved');
288
432
  }
289
433
 
290
- if (!context.ioPackageJson.common.onlyWWW && !context.packageJson.dependencies) {
434
+ if (!context.cfg.onlyWWW && !context.packageJson.dependencies) {
291
435
  context.errors.push('[W030] No dependencies declared at package.json. Is this really correct?');
292
436
  }
437
+
293
438
  if (!context.packageJson.devDependencies) {
294
439
  context.errors.push('[E031] No devDependencies declared at package.json. Please correct package.json');
295
440
  }
296
441
 
442
+ // check for blacklisted dependencies
443
+ passed = true;
297
444
  if (context.packageJson.dependencies) {
298
445
  for (const blacklist in blacklistedDependenciesPackageJson) {
446
+ if (
447
+ blacklistedDependenciesPackageJson[blacklist].onlyWWW !== undefined &&
448
+ blacklistedDependenciesPackageJson[blacklist].onlyWWW !== context.cfg.onlyWWW
449
+ ) {
450
+ continue;
451
+ }
452
+
299
453
  if (context.packageJson.dependencies[blacklist]) {
300
454
  if (blacklistedDependenciesPackageJson[blacklist].err) {
301
455
  context.errors.push(`[E050] ${blacklistedDependenciesPackageJson[blacklist].msg}`);
302
456
  } else {
303
- context.warnings.push(`[W051] ${blacklistedDependenciesPackageJson[blacklist].msg}`);
457
+ context.warnings.push(`[W050] ${blacklistedDependenciesPackageJson[blacklist].msg}`);
304
458
  }
459
+ passed = false;
305
460
  }
306
461
  }
307
462
  }
463
+ if (passed) {
464
+ context.checks.push(`Package.json does not contain blacklisted dependencies.`);
465
+ }
308
466
 
467
+ // check for blacklisted devDependencies
468
+ passed = true;
309
469
  if (context.packageJson.devDependencies) {
310
470
  for (const blacklist in blacklistedDevDependenciesPackageJson) {
471
+ if (
472
+ blacklistedDevDependenciesPackageJson[blacklist].onlyWWW !== undefined &&
473
+ blacklistedDevDependenciesPackageJson[blacklist].onlyWWW !== context.cfg.onlyWWW
474
+ ) {
475
+ continue;
476
+ }
477
+
311
478
  if (context.packageJson.devDependencies[blacklist]) {
312
479
  if (blacklistedDevDependenciesPackageJson[blacklist].err) {
313
- context.errors.push(`[E052] ${blacklistedDevDependenciesPackageJson[blacklist].msg}`);
480
+ context.errors.push(`[E050] ${blacklistedDevDependenciesPackageJson[blacklist].msg}`);
314
481
  } else {
315
- context.warnings.push(`[W053] ${blacklistedDevDependenciesPackageJson[blacklist].msg}`);
482
+ context.warnings.push(`[W050] ${blacklistedDevDependenciesPackageJson[blacklist].msg}`);
316
483
  }
484
+ passed = false;
317
485
  }
318
486
  }
319
487
  }
488
+ if (passed) {
489
+ context.checks.push(`Package.json does not contain blacklisted devDependencies.`);
490
+ }
320
491
 
321
- // if ((context.packageJson.dependencies && context.packageJson.dependencies.npm) || (context.packageJson.optionalDependencies && context.packageJson.optionalDependencies.npm)) {
322
- // context.errors.push('[E023] Do not include "npm" as dependency!');
323
- // } else {
324
- // context.checks.push('npm is not in dependencies');
325
- // }
492
+ // check for blacklisted peerDependencies
493
+ passed = true;
494
+ if (context.packageJson.peerDependencies) {
495
+ for (const blacklist in blacklistedPeerDependenciesPackageJson) {
496
+ if (
497
+ blacklistedPeerDependenciesPackageJson[blacklist].onlyWWW !== undefined &&
498
+ blacklistedPeerDependenciesPackageJson[blacklist].onlyWWW !== context.cfg.onlyWWW
499
+ ) {
500
+ continue;
501
+ }
326
502
 
327
- // if ((context.packageJson.dependencies && context.packageJson.dependencies['iobroker.js-controller']) ||
328
- // (context.packageJson.devDependencies && context.packageJson.devDependencies['iobroker.js-controller']) ||
329
- // (context.packageJson.optionalDependencies && context.packageJson.optionalDependencies['iobroker.js-controller'])
330
- // ) {
331
- // context.errors.push('[E025] "iobroker.js-controller" must not be listed as dependency at package.json');
332
- // } else {
333
- // context.checks.push('iobroker.js-controller is not in dependencies');
334
- // }
503
+ if (context.packageJson.peerDependencies[blacklist]) {
504
+ if (blacklistedPeerDependenciesPackageJson[blacklist].err) {
505
+ context.errors.push(`[E050] ${blacklistedPeerDependenciesPackageJson[blacklist].msg}`);
506
+ } else {
507
+ context.warnings.push(`[W050] ${blacklistedPeerDependenciesPackageJson[blacklist].msg}`);
508
+ }
509
+ passed = false;
510
+ }
511
+ }
512
+ }
513
+ if (passed) {
514
+ context.checks.push(`Package.json does not contain blacklisted peerDependencies.`);
515
+ }
335
516
 
336
- // if ((context.packageJson.dependencies && context.packageJson.dependencies['@iobroker/dev-server']) ||
337
- // (context.packageJson.optionalDependencies && context.packageJson.optionalDependencies['@iobroker/dev-server'])
338
- // ) {
339
- // context.errors.push('[E011] "@iobroker/dev-server" must not be listed as dependency at package.json');
340
- // } else {
341
- // context.checks.push('iobroker.@iobroker/dev-server is not in dependencies');
342
- // }
517
+ // check for blacklisted optionalDependencies
518
+ passed = true;
519
+ if (context.packageJson.optionalDependencies) {
520
+ for (const blacklist in blacklistedOptionalDependenciesPackageJson) {
521
+ if (
522
+ blacklistedOptionalDependenciesPackageJson[blacklist].onlyWWW !== undefined &&
523
+ blacklistedOptionalDependenciesPackageJson[blacklist].onlyWWW !== context.cfg.onlyWWW
524
+ ) {
525
+ continue;
526
+ }
343
527
 
344
- if (!context.ioPackageJson.common.onlyWWW) {
528
+ if (context.packageJson.optionalDependencies[blacklist]) {
529
+ if (blacklistedOptionalDependenciesPackageJson[blacklist].err) {
530
+ context.errors.push(`[E052] ${blacklistedOptionalDependenciesPackageJson[blacklist].msg}`);
531
+ } else {
532
+ context.warnings.push(`[W053] ${blacklistedOptionalDependenciesPackageJson[blacklist].msg}`);
533
+ }
534
+ passed = false;
535
+ }
536
+ }
537
+ }
538
+ if (passed) {
539
+ context.checks.push(`Package.json does not contain blacklisted devDependencies.`);
540
+ }
541
+
542
+ // check for dependencies listed multiple times
543
+ passed = true;
544
+ if (context.packageJson.devDependencies) {
545
+ for (const dependency in context.packageJson.devDependencies) {
546
+ if (context.packageJson.dependencies && context.packageJson.dependencies[dependency]) {
547
+ context.errors.push(`[E060] ${dependency} listed as dependency and as devDependency.`);
548
+ passed = false;
549
+ }
550
+ }
551
+ }
552
+ if (context.packageJson.peerDependencies) {
553
+ for (const dependency in context.packageJson.peerDependencies) {
554
+ if (context.packageJson.dependencies && context.packageJson.dependencies[dependency]) {
555
+ context.errors.push(`[E060] ${dependency} listed as dependency and as peerDependency.`);
556
+ passed = false;
557
+ }
558
+ if (context.packageJson.devDependencies && context.packageJson.devDependencies[dependency]) {
559
+ context.errors.push(`[E060] ${dependency} listed as devDependency and as peerDependency.`);
560
+ passed = false;
561
+ }
562
+ }
563
+ }
564
+ if (context.packageJson.optionalDependencies) {
565
+ for (const dependency in context.packageJson.optionalDependencies) {
566
+ if (context.packageJson.dependencies && context.packageJson.dependencies[dependency]) {
567
+ context.errors.push(`[E060] ${dependency} listed as dependency and as optionalDependency.`);
568
+ passed = false;
569
+ }
570
+ if (context.packageJson.devDependencies && context.packageJson.devDependencies[dependency]) {
571
+ context.errors.push(`[E060] ${dependency} listed as devDependency and as optionalDependency.`);
572
+ passed = false;
573
+ }
574
+ if (context.packageJson.peerDependencies && context.packageJson.peerDependencies[dependency]) {
575
+ context.errors.push(`[E060] ${dependency} listed as peerDependency and as optionalDependency.`);
576
+ passed = false;
577
+ }
578
+ }
579
+ }
580
+ if (passed) {
581
+ context.checks.push(`Package.json does not contain conflicting dependencies.`);
582
+ }
583
+
584
+ // check engines clause
585
+ if (!context.cfg.onlyWWW) {
345
586
  if (!context.packageJson.engines) {
346
587
  context.errors.push(
347
588
  `[E026] "{'engines': {'node'>='${requiredNodeVersion}'}}" is required at package.json, "{'engines':{'node'>='${recommendedNodeVersion}'}}" is recommended`,
@@ -360,7 +601,7 @@ async function checkPackageJson(context) {
360
601
  const match = nodeVal.match(/^(?<cmp>[<>=~]+)?\s*(?<vers>\d+(\.\d+(\.\d+)?)?(-\w+\.\d+)?)/m);
361
602
  if (!match) {
362
603
  context.warnings.push(
363
- `[W027] Engines clause at at package.json ({'engines' : { 'node' : '${nodeVal}' } }") is not parseable.`,
604
+ `[W027] Engines clause at package.json ({'engines' : { 'node' : '${nodeVal}' } }") is not parseable.`,
364
605
  );
365
606
  } else {
366
607
  common.debug(`node check: ${JSON.stringify(match.groups)}`);
@@ -390,17 +631,28 @@ async function checkPackageJson(context) {
390
631
  context.checks.push('"engines" check skipped for wwwOnly adapter.');
391
632
  }
392
633
 
393
- if (!context.ioPackageJson.common.onlyWWW) {
394
- for (const dependency in dependenciesPackageJson) {
395
- const requiredVersion = dependenciesPackageJson[dependency].required;
396
- const recommendedVersion = dependenciesPackageJson[dependency].recommended;
397
- let dependencyVersion = context.packageJson.dependencies[`${dependency}`] || '';
398
- dependencyVersion = dependencyVersion.replace(/[\^~]/, '').trim();
399
- if (!dependencyVersion) {
400
- context.errors.push(
401
- `[E032] No dependency declared for ${dependency}. Please add "${dependency}":"${recommendedVersion}" to dependencies at package.json`,
402
- );
403
- } else if (!compareVersions.compare(dependencyVersion, requiredVersion, '>=')) {
634
+ // check dependcy requirements
635
+ for (const dependency in dependenciesPackageJson) {
636
+ console.log(`checking dependency ${dependency} ...`);
637
+
638
+ if (dependenciesPackageJson[dependency].onlyWWW === false && context.cfg.onlyWWW) {
639
+ continue;
640
+ }
641
+
642
+ const requiredVersion = dependenciesPackageJson[dependency].required;
643
+ const recommendedVersion = dependenciesPackageJson[dependency].recommended;
644
+ const alternatives = dependenciesPackageJson[dependency].alternatives || [];
645
+ const optional = !!dependenciesPackageJson[dependency].optional;
646
+ const suggested = !!dependenciesPackageJson[dependency].suggested;
647
+ const exists = !!context.packageJson.dependencies[`${dependency}`];
648
+ let dependencyVersion = context.packageJson.dependencies[`${dependency}`] || '';
649
+ dependencyVersion = dependencyVersion.replace(/[\^~]/, '').trim();
650
+
651
+ console.log(` exists: ${exists}, optional: ${optional}, alternatives: [${alternatives}]`);
652
+
653
+ if (exists) {
654
+ // if dependency exists, version requirements must be met
655
+ if (!compareVersions.compare(dependencyVersion, requiredVersion, '>=')) {
404
656
  context.errors.push(
405
657
  `[E033] ${dependency} ${dependencyVersion} specified. ${requiredVersion} is required as minimum, ${recommendedVersion} is recommended. Please update dependencies at package.json`,
406
658
  );
@@ -409,39 +661,87 @@ async function checkPackageJson(context) {
409
661
  `[W034] ${dependency} ${dependencyVersion} specified. ${recommendedVersion} is recommended. Please consider updating dependencies at package.json`,
410
662
  );
411
663
  } else {
412
- context.checks.push('dependency ${dependency} ${dependencyVersion} is ok');
664
+ context.checks.push(`dependency ${dependency} ${dependencyVersion} is ok`);
665
+ }
666
+ } else {
667
+ // if dependency does not exist check if alternate exists
668
+ let found = '';
669
+ for (const alternative of alternatives){
670
+ if (context.packageJson.dependencies[`${alternative}`]){
671
+ found = alternative;
672
+ }
673
+ }
674
+ if (found) {
675
+ context.checks.push(`dependency ${dependency} satisfied by ${found}`);
676
+ } else if (optional) {
677
+ context.checks.push(`dependency ${dependency} is optional`);
678
+ if (suggested) {
679
+ context.warnings.push(`[S061] Consider using "${dependency}".`);
680
+ }
681
+ } else {
682
+ context.errors.push(
683
+ `[E032] No dependency declared for ${dependency}. Please add "${dependency}":"${recommendedVersion}" to dependencies at package.json`,
684
+ );
413
685
  }
414
686
  }
415
- context.checks.push('"dependenciesPackageJson" checked.');
416
- } else {
417
- context.checks.push('"dependenciesPackageJson" check skipped for wwwOnly adapter.');
418
687
  }
688
+ context.checks.push('required dependencies checked.');
419
689
 
690
+ // check devDependcy requirements
420
691
  for (const dependency in devDependenciesPackageJson) {
421
- if (devDependenciesPackageJson[dependency].onlyWWW === false && context.ioPackageJson.common.onlyWWW) {
692
+ console.log(`checking devDependency ${dependency} ...`);
693
+
694
+ if (devDependenciesPackageJson[dependency].onlyWWW === false && context.cfg.onlyWWW) {
422
695
  continue;
423
696
  }
697
+
424
698
  const requiredVersion = devDependenciesPackageJson[dependency].required;
425
699
  const recommendedVersion = devDependenciesPackageJson[dependency].recommended;
700
+ const alternatives = devDependenciesPackageJson[dependency].alternatives || [];
701
+ const optional = !!devDependenciesPackageJson[dependency].optional;
702
+ const suggested = !!devDependenciesPackageJson[dependency].suggested;
703
+ const exists = !!context.packageJson.devDependencies[`${dependency}`];
426
704
  let dependencyVersion = context.packageJson.devDependencies[`${dependency}`] || '';
427
705
  dependencyVersion = dependencyVersion.replace(/[\^~]/, '');
428
- if (!dependencyVersion) {
429
- context.errors.push(
430
- `[E035] No devDependency declared for ${dependency}. Please add "${dependency}":"${recommendedVersion}" to devDependencies at package.json`,
431
- );
432
- } else if (!compareVersions.compare(dependencyVersion, requiredVersion, '>=')) {
433
- context.errors.push(
434
- `[E036] ${dependency} ${dependencyVersion} specified. ${requiredVersion} is required as minimum, ${recommendedVersion} is recommended. Please update devDependencies at package.json`,
435
- );
436
- } else if (!compareVersions.compare(dependencyVersion, recommendedVersion, '>=')) {
437
- context.warnings.push(
438
- `[W037] ${dependency} ${dependencyVersion} specified. ${recommendedVersion} is recommended. Please consider updating devDependencies at package.json`,
439
- );
706
+
707
+ console.log(` exists: ${exists}, optional: ${optional}, alternatives: [${alternatives}]`);
708
+
709
+ if (exists) {
710
+ // if dependency exists, version requirements must be met
711
+ if (!compareVersions.compare(dependencyVersion, requiredVersion, '>=')) {
712
+ context.errors.push(
713
+ `[E036] ${dependency} ${dependencyVersion} specified. ${requiredVersion} is required as minimum, ${recommendedVersion} is recommended. Please update devDependencies at package.json`,
714
+ );
715
+ } else if (!compareVersions.compare(dependencyVersion, recommendedVersion, '>=')) {
716
+ context.warnings.push(
717
+ `[W037] ${dependency} ${dependencyVersion} specified. ${recommendedVersion} is recommended. Please consider updating devDependencies at package.json`,
718
+ );
719
+ } else {
720
+ context.checks.push(`devDependency ${dependency} ${dependencyVersion} is ok`);
721
+ }
440
722
  } else {
441
- context.checks.push('devDependency ${dependency} ${dependencyVersion} is ok');
723
+ // if dependency does not existscheck if alternate exists
724
+ let found = '';
725
+ for (const alternative of alternatives){
726
+ if (context.packageJson.devDependencies[`${alternative}`]){
727
+ found = alternative;
728
+ }
729
+ }
730
+ if (found) {
731
+ context.checks.push(`devDependency ${dependency} satisfied by ${found}`);
732
+ } else if (optional) {
733
+ context.checks.push(`devDependency ${dependency} is optional`);
734
+ if (suggested) {
735
+ context.warnings.push(`[S062] Consider using "${dependency}".`);
736
+ }
737
+ } else {
738
+ context.errors.push(
739
+ `[E035] No devDependency declared for ${dependency}. Please add "${dependency}":"${recommendedVersion}" to devDependencies at package.json`,
740
+ );
741
+ }
442
742
  }
443
743
  }
444
- context.checks.push('"devDependenciesPackageJson" checked.');
744
+ context.checks.push('required devDependencies have been checked.');
445
745
 
446
746
  const enforcedDependencies = [
447
747
  '@iobroker/adapter-core',
@@ -516,32 +816,6 @@ async function checkPackageJson(context) {
516
816
  }
517
817
  }
518
818
 
519
- for (const blacklist in blacklistPackageJson) {
520
- // console.log(`checking blacklist ${blacklist}`);
521
- let tmp = context.packageJson;
522
- let log = '';
523
- for (const element of blacklist.split('.')) {
524
- log = `${log}.${element}`;
525
- //console.log(` check ${log}`);
526
- tmp = tmp[element];
527
- if (!tmp) {
528
- //console.log(` ${log} does not exist`);
529
- break;
530
- }
531
- }
532
- if (tmp) {
533
- if (blacklistPackageJson[blacklist].err) {
534
- context.errors.push(`[E038] ${blacklistPackageJson[blacklist].msg}`);
535
- } else {
536
- context.warnings.push(`[W038] ${blacklistPackageJson[blacklist].msg}`);
537
- }
538
- }
539
- // else {
540
- // console.log(`blacklist ${blacklist} no match`);
541
- // }
542
- }
543
- context.checks.push('"blacklist (package)" checked.');
544
-
545
819
  if (!context.packageJson.keywords || !Array.isArray(context.packageJson.keywords)) {
546
820
  context.errors.push('[E039] "keywords" must be an array within package.json and contain some useful keywords');
547
821
  } else {
@@ -605,8 +879,8 @@ exports.checkPackageJson = checkPackageJson;
605
879
  // [005] Adapter name must be lowercase
606
880
  // [006] Invalid characters found in adapter name "${adapterName}". Only lowercase chars, digits, "-" and "_" are allowed
607
881
  // [007] Cannot find author repo in the URL
608
- // [008] - free -
609
- // [009] No version found in the package.json
882
+ // E008] No "name" key found in package.json.
883
+ // [009] No "version" key found in the package.json
610
884
  // [010] No description found in the package.json
611
885
  // [011] ### "@iobroker/dev-server" must not be listed as dependency at package.json'
612
886
  // [012] Invalid repository object in package.json
@@ -652,11 +926,15 @@ exports.checkPackageJson = checkPackageJson;
652
926
  // [048] devDependency should not require a specific version. Use "~1.2.3" or "^1.2.3" syntax. Please update "${dependency}:${context.packageJson.devDependencies[dependency]}"
653
927
  // [049] "keywords" within package.json must contain some keywords besides "${context.packageJson.keywords.join(', ')}" related to adapter
654
928
  // [050] ${blacklistedDependenciesPackageJson[blacklist].msg}
655
- // [051] ${blacklistedDependenciesPackageJson[blacklist].msg}.
656
- // [052] ${blacklistedDevDependenciesPackageJson[blacklist].msg}
657
- // [053] ${blacklistedDevDependenciesPackageJson[blacklist].msg}
929
+ // [051] --
930
+ // [052] --
931
+ // [053] --
658
932
  // [054] malformed dependency detected "${dependency}":${context.packageJson.dependencies[dependency]}". Please fix at package.json.`
659
933
  // [055] malformed dependency detected "${dependency}":${context.packageJson.devDependencies[dependency]}". Please fix at package.json.`
660
934
  // [056] Wildcard dependencies should be avoided "${dependency}":"${dependencyVersion}". Use "~1.2.3" or "^1.2.3" syntax at package.json.`,
661
935
  // [057] Wildcard devDependencies should be avoided "${dependency}":"${dependencyVersion}". Use "~1.2.3" or "^1.2.3" syntax at package.json.`,
662
-
936
+ // [058] Key ${objectName} at package.json is not supported. Please remove.
937
+ // [059] No "scripts" key found in the package.json.
938
+ // [060] ${dependency} listed as dependency and as devDependency.
939
+ // [062] No devDependency declared for ${dependency}. Please consider adding "${dependency}":"${recommendedVersion}" to devDependencies at package.json`
940
+ // [062] No devDependency declared for ${dependency}. Please consider adding "${dependency}":"${recommendedVersion}" to devDependencies at package.json`