@iobroker/repochecker 2.5.0 → 2.6.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/README.md CHANGED
@@ -20,8 +20,16 @@ Branch (`master/main/dev`) is optional.
20
20
  -->
21
21
 
22
22
  ## Changelog
23
+ ### 2.6.0 (2024-06-24)
24
+ * (mcm1957) Check has been aded to ensure keywords and common.keywords are present. [#200]
25
+ * (mcm1957) Detection of react has been added, gulpfile.js is accepted for react based UIs now. [#223]
26
+
27
+ ### 2.5.1 (2024-06-24)
28
+ * (mcm1957) Suggestion to update dependencies to recommended version added.
29
+ * (mcm1957) Adapter-core recommended set to 3.1.6 [#220]
30
+
23
31
  ### 2.5.0 (2024-05-30)
24
- * (mcm1957) Add check ensure that dependency revisions are available at repository. [#180]
32
+ * (mcm1957) Check to ensure that dependency revisions are available at repository added. [#180]
25
33
 
26
34
  ### 2.4.0 (2024-05-30)
27
35
  * (mcm1957) Add check to protect sensitive data. [#195]
package/doc/issues.json CHANGED
@@ -140,15 +140,18 @@
140
140
  "E033": {
141
141
  "title": "${dependency} ${dependencyVersion} specified. ${requiredVersion} is required as minimum, ${recommendedVersion} is recommended. Please update dependencies at package.json"
142
142
  },
143
- "E034": {
143
+ "E035": {
144
144
  "title": "No devDependency declared for ${dependency}. Please add `${dependency}`:`${recommendedVersion}` to devDependencies at package.json"
145
145
  },
146
- "E035": {
146
+ "E036": {
147
147
  "title": "${dependency} ${dependencyVersion} specified. ${requiredVersion} is required as minimum, ${recommendedVersion} is recommended. Please update devDependencies at package.json"
148
148
  },
149
- "E036": {
149
+ "E038": {
150
150
  "title": "${blacklistPackageJson[blacklist].msg}"
151
151
  },
152
+ "E039": {
153
+ "title": "`keywords` must be an array within package.json and contain some useful keywords"
154
+ },
152
155
  "E100": {
153
156
  "title": "Cannot parse io-package.json"
154
157
  },
@@ -509,9 +512,18 @@
509
512
  "W030": {
510
513
  "title": "No dependencies declared at package.json. Is this really correct?"
511
514
  },
512
- "W036": {
515
+ "W034": {
516
+ "title": "${dependency} ${dependencyVersion} specified. ${recommendedVersion} is recommended. Please consider updating dependencies at package.json"
517
+ },
518
+ "W037": {
519
+ "title": "${dependency} ${dependencyVersion} specified. ${recommendedVersion} is recommended. Please consider updating devDependencies at package.json"
520
+ },
521
+ "W038": {
513
522
  "title": "${blacklistPackageJson[blacklist].msg}"
514
523
  },
524
+ "W040": {
525
+ "title": "`keywords` within package.json should not contain `${forbiddenKeywords.join(', ')}`"
526
+ },
515
527
  "W105": {
516
528
  "title": "`common.titleLang` should be translated into all supported languages"
517
529
  },
@@ -596,6 +608,12 @@
596
608
  "W515": {
597
609
  "title": "Why you decided to disable i18n support?"
598
610
  },
611
+ "W520": {
612
+ "title": "`gulpfile.js` found in repo but `gulp` not found at devDependencies at package.json. Check whether it can be removed."
613
+ },
614
+ "W521": {
615
+ "title": "`gulp` found at devDependencies at package.json but no `gulpfile.js` found. Is this dependency really required?"
616
+ },
599
617
  "W801": {
600
618
  "title": ".npmignore not found"
601
619
  },
package/index.js CHANGED
@@ -34,15 +34,15 @@ axios.defaults.headers = {
34
34
  };
35
35
 
36
36
  // adapt recommended version here
37
- const recommendedAdapterCoreVersion = '3.0.6';
37
+ // outdated? // const recommendedAdapterCoreVersion = '3.0.6';
38
38
  const recommendedJsControllerVersion = '5.0.11';
39
- const recommendedNodeVersion = '18';
40
- const requiredNodeVersion = '16';
39
+ const recommendedNodeVersion = '18'; // This is the minimum node version which should be required
40
+ const requiredNodeVersion = '16'; // This is the minimum node version which must be required
41
41
 
42
42
  const dependencies = {
43
43
  "@iobroker/adapter-core": {
44
44
  "required":"3.1.4",
45
- "recommended":"3.1.4"
45
+ "recommended":"3.1.6"
46
46
  }
47
47
  };
48
48
 
@@ -524,6 +524,8 @@ function checkPackageJson(context) {
524
524
  context.errors.push(`[E032] No dependency declared for ${dependency}. Please add "${dependency}":"${recommendedVersion}" to dependencies at package.json`);
525
525
  } else if (! compareVersions.compare( dependencyVersion, requiredVersion, '>=' )) {
526
526
  context.errors.push(`[E033] ${dependency} ${dependencyVersion} specified. ${requiredVersion} is required as minimum, ${recommendedVersion} is recommended. Please update dependencies at package.json`);
527
+ } else if (! compareVersions.compare( dependencyVersion, recommendedVersion, '>=' )) {
528
+ context.warnings.push(`[W034] ${dependency} ${dependencyVersion} specified. ${recommendedVersion} is recommended. Please consider updating dependencies at package.json`);
527
529
  } else {
528
530
  context.checks.push('dependency ${dependency} ${dependencyVersion} is ok');
529
531
  }
@@ -539,9 +541,11 @@ function checkPackageJson(context) {
539
541
  let dependencyVersion = context.packageJson.devDependencies[`${dependency}`] || '';
540
542
  dependencyVersion = dependencyVersion.replace(/[\^\~]/,'' );
541
543
  if (!dependencyVersion) {
542
- context.errors.push(`[E034] No devDependency declared for ${dependency}. Please add "${dependency}":"${recommendedVersion}" to devDependencies at package.json`);
544
+ context.errors.push(`[E035] No devDependency declared for ${dependency}. Please add "${dependency}":"${recommendedVersion}" to devDependencies at package.json`);
543
545
  } else if (! compareVersions.compare( dependencyVersion, requiredVersion, '>=' )) {
544
- context.errors.push(`[E035] ${dependency} ${dependencyVersion} specified. ${requiredVersion} is required as minimum, ${recommendedVersion} is recommended. Please update devDependencies at package.json`);
546
+ context.errors.push(`[E036] ${dependency} ${dependencyVersion} specified. ${requiredVersion} is required as minimum, ${recommendedVersion} is recommended. Please update devDependencies at package.json`);
547
+ } else if (! compareVersions.compare( dependencyVersion, recommendedVersion, '>=' )) {
548
+ context.warnings.push(`[W037] ${dependency} ${dependencyVersion} specified. ${recommendedVersion} is recommended. Please consider updating devDependencies at package.json`);
545
549
  } else {
546
550
  context.checks.push('devDependency ${dependency} ${dependencyVersion} is ok');
547
551
  }
@@ -563,9 +567,9 @@ function checkPackageJson(context) {
563
567
  }
564
568
  if (tmp) {
565
569
  if (blacklistPackageJson[blacklist].err) {
566
- context.errors.push(`[E036] ${blacklistPackageJson[blacklist].msg}`);
570
+ context.errors.push(`[E038] ${blacklistPackageJson[blacklist].msg}`);
567
571
  } else {
568
- context.warnings.push(`[W036] ${blacklistPackageJson[blacklist].msg}`);
572
+ context.warnings.push(`[W038] ${blacklistPackageJson[blacklist].msg}`);
569
573
  }
570
574
  }
571
575
  //else {
@@ -573,7 +577,24 @@ function checkPackageJson(context) {
573
577
  //}
574
578
  }
575
579
  context.checks.push('"blacklist (package)" checked.');
576
- // max number is E036
580
+
581
+ if (! context.packageJson.keywords) {
582
+ context.errors.push('[E039] "keywords" must be an array within package.json and contain some useful keywords');
583
+ } else {
584
+ const forbiddenKeywords = [];
585
+ if (!Array.isArray(context.packageJson.keywords)) {
586
+ context.errors.push('[E039] "keywords" must be an array within package.json and contain some useful keywords');
587
+ } else if (context.packageJson.keywords.length === 0) {
588
+ context.errors.push('[E039] "keywords" must be an array within package.json and contain some useful keywords');
589
+ } else if (forbiddenKeywords.filter(keyword => context.packageJson.keywords.map(k => k.toLowerCase()).includes(keyword)).length > 0) {
590
+ context.warnings.push(`[W040] "keywords" within package.json should not contain "${forbiddenKeywords.join(', ')}"`);
591
+ }
592
+
593
+ context.checks.push('"keywords" found in package.json');
594
+ }
595
+
596
+
597
+ // max number is W040
577
598
 
578
599
  return context;
579
600
  });
@@ -1180,10 +1201,14 @@ function checkIOPackageJson(context) {
1180
1201
  }
1181
1202
  }
1182
1203
 
1183
- if (context.ioPackageJson.common.keywords) {
1204
+ if (! context.ioPackageJson.common.keywords) {
1205
+ context.errors.push('[E169] "common.keywords" must be an array within io-package.json and contain some useful keywords');
1206
+ } else {
1184
1207
  const forbiddenKeywords = ['iobroker', 'adapter', 'smart home'];
1185
1208
  if (!Array.isArray(context.ioPackageJson.common.keywords)) {
1186
- context.errors.push('[E169] "common.keywords" must be an array in the io-package.json');
1209
+ context.errors.push('[E169] "common.keywords" must be an array within io-package.json and contain some useful keywords');
1210
+ } else if (context.ioPackageJson.common.keywords.length === 0) {
1211
+ context.errors.push('[E169] "common.keywords" must be an array within io-package.json and contain some useful keywords');
1187
1212
  } else if (forbiddenKeywords.filter(keyword => context.ioPackageJson.common.keywords.map(k => k.toLowerCase()).includes(keyword)).length > 0) {
1188
1213
  context.warnings.push(`[W170] "common.keywords" should not contain "${forbiddenKeywords.join(', ')}" io-package.json`);
1189
1214
  }
@@ -1941,7 +1966,7 @@ function checkRepo(context) {
1941
1966
  } else {
1942
1967
  const versDependency = dependencies[dependency];
1943
1968
  const versRepository = context.latestRepoLive[dependency].version;
1944
- console.log( `DEBUG: dependency ${dependency} - ${versDependency} - latest ${versRepository}`);
1969
+ //console.log( `DEBUG: dependency ${dependency} - ${versDependency} - latest ${versRepository}`);
1945
1970
  if (!versDependency.startsWith('>=')) {
1946
1971
  context.warnings.push(`[W432] Dependency '${dependency}':'${dependencies[dependency]}' should specify '>='`);
1947
1972
  } else {
@@ -1958,7 +1983,7 @@ console.log( `DEBUG: dependency ${dependency} - ${versDependency} - latest ${ver
1958
1983
  } else {
1959
1984
  const versDependency = dependencies[dependency];
1960
1985
  const versRepository = context.stableRepoLive[dependency].version;
1961
- console.log( `DEBUG: dependency ${dependency} - ${versDependency} - latest ${versRepository}`);
1986
+ //console.log( `DEBUG: dependency ${dependency} - ${versDependency} - latest ${versRepository}`);
1962
1987
  if (!versDependency.startsWith('>=')) {
1963
1988
  context.warnings.push(`[W434] Dependency '${dependency}':'${dependencies[dependency]}' should specify '>='`);
1964
1989
  } else {
@@ -2034,6 +2059,8 @@ function checkCode(context) {
2034
2059
  'admin/jsonCustom.json',
2035
2060
  'admin/jsonCustom.json5',
2036
2061
  'admin/blockly.js',
2062
+
2063
+ 'src-admin/package.json', // present if react is used
2037
2064
  ];
2038
2065
  allowedLanguages.forEach(lang =>
2039
2066
  readFiles.push(`admin/i18n/${lang}/translations.json`));
@@ -2120,6 +2147,16 @@ function checkCode(context) {
2120
2147
  });
2121
2148
  })
2122
2149
  .then(context => {
2150
+ let usesReact = false;
2151
+ if (context['/src-admin/package.json']) {
2152
+ //console.log('"src-admin/package.json" exists');
2153
+ let packageJson = JSON.parse(context['/src-admin/package.json']);
2154
+ if (packageJson.devDependencies && packageJson.devDependencies['@iobroker/adapter-react-v5'] ){
2155
+ // console.log('REACT detected');
2156
+ usesReact = true;
2157
+ }
2158
+ }
2159
+
2123
2160
  if (context.ioPackageJson.common.materialize || (context.ioPackageJson.common.adminUI && context.ioPackageJson.common.adminUI.config === 'materialize')) {
2124
2161
  if (context['/admin/index_m.html'] && context['/admin/index_m.html'].includes('selectID.js') && !context.filesList.includes('admin/img/info-big.png')) {
2125
2162
  context.errors.push('[E502] "admin/img/info-big.png" not found, but selectID.js used in index_m.html ');
@@ -2218,7 +2255,16 @@ function checkCode(context) {
2218
2255
  }
2219
2256
 
2220
2257
  if (context['/gulpfile.js']) {
2221
- context.warnings.push('[W513] "gulpfile.js" found in repo! Think about migrating to @iobroker/adapter-dev package');
2258
+ if (!usesReact) {
2259
+ context.warnings.push('[W513] "gulpfile.js" found in repo! Think about migrating to @iobroker/adapter-dev package');
2260
+ }
2261
+ if (!context.packageJson.devDependencies['gulp']) {
2262
+ context.warnings.push('[W520] "gulpfile.js" found in repo but "gulp" not found at devDependencies at package.json. Check whether it can be removed.');
2263
+ }
2264
+ } else {
2265
+ if (context.packageJson.devDependencies['gulp']) {
2266
+ context.warnings.push('[W521] "gulp" found at devDependencies at package.json but no "gulpfile.js" found. Is this dependency really required?');
2267
+ }
2222
2268
  }
2223
2269
 
2224
2270
  if (context.packageJson.devDependencies && context.packageJson.devDependencies['@alcalzone/release-script'] && !context['/.releaseconfig.json']) {
@@ -2247,7 +2293,7 @@ function checkCode(context) {
2247
2293
  }
2248
2294
  }
2249
2295
  }
2250
- // max E519
2296
+ // max E521
2251
2297
  resolve(context);
2252
2298
  })
2253
2299
  .catch(e => reject(e));
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
- "version": "2.5.0",
2
+ "version": "2.6.0",
3
3
  "name": "@iobroker/repochecker",
4
4
  "dependencies": {
5
- "axios": "^1.6.8",
5
+ "axios": "^1.7.2",
6
6
  "compare-versions": "^6.1.0",
7
7
  "image-size": "^1.1.1",
8
- "unzipper": "^0.11.4",
8
+ "unzipper": "^0.11.6",
9
9
  "json5": "^2.2.3"
10
10
  },
11
11
  "publishConfig": {