@iobroker/repochecker 3.0.6 → 3.1.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,6 +20,14 @@ Branch (`master/main/dev`) is optional.
20
20
  -->
21
21
 
22
22
  ## Changelog
23
+ ### 3.1.0 (2024-09-29)
24
+ * (mcm1957) "@iobroker/plugin-sentry" blacklisted as dependency [#301]
25
+ * (mcm1957) Accept .ts files as main file too. [#303]
26
+ * (mcm1957) [E405] and [E426] incorrect path has been corrected. [#299]
27
+
28
+ ### 3.0.7 (2024-09-19)
29
+ * (mcm1957) "[W523] 'package-lock.json"'not found in repo!" reduced to suggestion. [#298]
30
+
23
31
  ### 3.0.6 (2024-09-13)
24
32
  * (mcm1957) "[E124] Main file not found" no longer raised if common.nogit is set
25
33
  * (mcm1957) 'Text of "common.main" is deprecated' has been adapted. [#266]
package/index.js CHANGED
@@ -94,7 +94,7 @@ function getGithubApiData(context) {
94
94
  })
95
95
  .catch(e => {
96
96
  context.errors.push(`[E000] FATAL: cannot access repository ${context.githubUrlApi}`);
97
- reject(e.toJSON());
97
+ reject(e);
98
98
  });// E0xx
99
99
  });
100
100
  }
@@ -31,6 +31,40 @@ const devDependenciesPackageJson = {
31
31
  },
32
32
  };
33
33
 
34
+ const blacklistedDependenciesPackageJson = {
35
+ 'npm': {
36
+ msg: "'npm'must not be listed as dependency at package.json. Please remove.",
37
+ err: true
38
+ },
39
+ 'iobroker.js-controller': {
40
+ msg: "'iobroker.js-controller' must not be listed as dependency at package.json. Please remove.",
41
+ err: true
42
+ },
43
+ '@iobroker/dev-server': {
44
+ msg: "'@iobroker/dev-server' must not be listed as dependency at package.json. Please remove.",
45
+ err: true
46
+ },
47
+ '@iobroker/plugin-sentry': {
48
+ 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.",
49
+ err: true
50
+ },
51
+ };
52
+
53
+ const blacklistedDevDependenciesPackageJson = {
54
+ 'npm': {
55
+ msg: "'npm'must not be listed as devDependency at package.json. Please remove.",
56
+ err: true
57
+ },
58
+ 'iobroker.js-controller': {
59
+ msg: "'iobroker.js-controller' must not be listed as devDependency at package.json. Please remove.",
60
+ err: true
61
+ },
62
+ '@iobroker/plugin-sentry': {
63
+ msg: "'@iobroker/plugin-sentry' must not be listed as devDependency at package.json. Please remove.",
64
+ err: true
65
+ },
66
+ };
67
+
34
68
  const blacklistPackageJson = {
35
69
 
36
70
  };
@@ -201,28 +235,52 @@ async function checkPackageJson(context) {
201
235
  context.errors.push('[E031] No devDependencies declared at package.json. Please correct package.json');
202
236
  }
203
237
 
204
- if ((context.packageJson.dependencies && context.packageJson.dependencies.npm) || (context.packageJson.optionalDependencies && context.packageJson.optionalDependencies.npm)) {
205
- context.errors.push('[E023] Do not include "npm" as dependency!');
206
- } else {
207
- context.checks.push('npm is not in dependencies');
238
+ if (context.packageJson.dependencies) {
239
+ for (const blacklist in blacklistedDependenciesPackageJson) {
240
+ if (context.packageJson.dependencies[blacklist]) {
241
+ if (blacklistedDependenciesPackageJson[blacklist].err){
242
+ context.errors.push(`[E050] ${blacklistedDependenciesPackageJson[blacklist].msg}`);
243
+ } else {
244
+ context.warnings.push(`[W051] ${blacklistedDependenciesPackageJson[blacklist].msg}`);
245
+ }
246
+ }
247
+ }
208
248
  }
209
249
 
210
- if ((context.packageJson.dependencies && context.packageJson.dependencies['iobroker.js-controller']) ||
211
- (context.packageJson.devDependencies && context.packageJson.devDependencies['iobroker.js-controller']) ||
212
- (context.packageJson.optionalDependencies && context.packageJson.optionalDependencies['iobroker.js-controller'])
213
- ) {
214
- context.errors.push('[E025] "iobroker.js-controller" must not be listed as dependency at package.json');
215
- } else {
216
- context.checks.push('iobroker.js-controller is not in dependencies');
250
+ if (context.packageJson.devDependencies) {
251
+ for (const blacklist in blacklistedDevDependenciesPackageJson) {
252
+ if (context.packageJson.devDependencies[blacklist]) {
253
+ if (blacklistedDevDependenciesPackageJson[blacklist].err){
254
+ context.errors.push(`[E052] ${blacklistedDevDependenciesPackageJson[blacklist].msg}`);
255
+ } else {
256
+ context.warnings.push(`[W053] ${blacklistedDevDependenciesPackageJson[blacklist].msg}`);
257
+ }
258
+ }
259
+ }
217
260
  }
218
261
 
219
- if ((context.packageJson.dependencies && context.packageJson.dependencies['@iobroker/dev-server']) ||
220
- (context.packageJson.optionalDependencies && context.packageJson.optionalDependencies['@iobroker/dev-server'])
221
- ) {
222
- context.errors.push('[E011] "@iobroker/dev-server" must not be listed as dependency at package.json');
223
- } else {
224
- context.checks.push('iobroker.@iobroker/dev-server is not in dependencies');
225
- }
262
+ // if ((context.packageJson.dependencies && context.packageJson.dependencies.npm) || (context.packageJson.optionalDependencies && context.packageJson.optionalDependencies.npm)) {
263
+ // context.errors.push('[E023] Do not include "npm" as dependency!');
264
+ // } else {
265
+ // context.checks.push('npm is not in dependencies');
266
+ // }
267
+
268
+ // if ((context.packageJson.dependencies && context.packageJson.dependencies['iobroker.js-controller']) ||
269
+ // (context.packageJson.devDependencies && context.packageJson.devDependencies['iobroker.js-controller']) ||
270
+ // (context.packageJson.optionalDependencies && context.packageJson.optionalDependencies['iobroker.js-controller'])
271
+ // ) {
272
+ // context.errors.push('[E025] "iobroker.js-controller" must not be listed as dependency at package.json');
273
+ // } else {
274
+ // context.checks.push('iobroker.js-controller is not in dependencies');
275
+ // }
276
+
277
+ // if ((context.packageJson.dependencies && context.packageJson.dependencies['@iobroker/dev-server']) ||
278
+ // (context.packageJson.optionalDependencies && context.packageJson.optionalDependencies['@iobroker/dev-server'])
279
+ // ) {
280
+ // context.errors.push('[E011] "@iobroker/dev-server" must not be listed as dependency at package.json');
281
+ // } else {
282
+ // context.checks.push('iobroker.@iobroker/dev-server is not in dependencies');
283
+ // }
226
284
 
227
285
  if (!context.ioPackageJson.common.onlyWWW) {
228
286
  if (!context.packageJson.engines) {
@@ -391,7 +449,7 @@ async function checkPackageJson(context) {
391
449
  }
392
450
 
393
451
  // single free 008
394
- // first free 050
452
+ // first free 054
395
453
 
396
454
  return context;
397
455
  }
@@ -412,7 +470,7 @@ exports.checkPackageJson = checkPackageJson;
412
470
  // [008] - free -
413
471
  // [009] No version found in the package.json
414
472
  // [010] No description found in the package.json
415
- // [011] "@iobroker/dev-server" must not be listed as dependency at package.json'
473
+ // [011] ### "@iobroker/dev-server" must not be listed as dependency at package.json'
416
474
  // [012] Invalid repository object in package.json
417
475
  // [013] No author found in the package.json
418
476
  // [014] NPM information found in package.json. Please remove all attributes starting with "_"
@@ -425,9 +483,9 @@ exports.checkPackageJson = checkPackageJson;
425
483
  // [020] Name of adapter in package.json must be lowercase and be equal to "iobroker.${adapterName.toLowerCase()}". Now is "${packageJson.name}"
426
484
  // [021] "licenses" in package.json are deprecated. Please remove and use "license": "NAME" field.
427
485
  // [022] Adapter name is reserved. Please rename adapter.
428
- // [023] Do not include "npm" as dependency!
486
+ // [023] ### Do not include "npm" as dependency!
429
487
  // [024] Adapter name "${adapterName}" may not start with '_'y!
430
- // [025] "iobroker.js-controller" must not be listed as dependency at package.json'
488
+ // [025] ### "iobroker.js-controller" must not be listed as dependency at package.json'
431
489
  // [026] "{'engines': {'node'>='${requiredNodeVersion}'}}" is required at package.json, "{'engines':{'node'>='${recommendedNodeVersion}'}}" is recommended
432
490
  // [026] "{'engines': {'node'>='${requiredNodeVersion}'}}" is required at package.json, "{'engines':{'node'>='${recommendedNodeVersion}'}}" is recommended
433
491
  // [027] Engines clause at at package.json ({'engines' : { 'node' : '${nodeVal}' } }") is not parseable.
@@ -455,3 +513,8 @@ exports.checkPackageJson = checkPackageJson;
455
513
  // [047] dependency should not require a specific version. Use "~1.2.3" or "^1.2.3" syntax. Please update "${dependency}:${context.packageJson.dependencies[dependency]}"
456
514
  // [048] devDependency should not require a specific version. Use "~1.2.3" or "^1.2.3" syntax. Please update "${dependency}:${context.packageJson.devDependencies[dependency]}"
457
515
  // [049] "keywords" within package.json must contain some keywords besides "${context.packageJson.keywords.join(', ')}" related to adapter
516
+ // [E050] ${blacklistedDependenciesPackageJson[blacklist].msg}
517
+ // [W051] ${blacklistedDependenciesPackageJson[blacklist].msg}.
518
+ // [E052] ${blacklistedDevDependenciesPackageJson[blacklist].msg}
519
+ // [W053] ${blacklistedDevDependenciesPackageJson[blacklist].msg}
520
+
@@ -441,8 +441,8 @@ async function checkIOPackageJson(context) {
441
441
  } else {
442
442
  context.checks.push('"main" found in package.json');
443
443
 
444
- if (context.ioPackageJson.common.mode !== 'none' && !context.packageJson.main.endsWith('.js')) {
445
- !context.ioPackageJson.common.onlyWWW && context.errors.push(`[E163] common.mode "${context.ioPackageJson.common.mode}" requires JavaScript file for "main" in package.json`);
444
+ if (context.ioPackageJson.common.mode !== 'none' && !context.packageJson.main.endsWith('.js') && !context.packageJson.main.endsWith('.ts')) {
445
+ !context.ioPackageJson.common.onlyWWW && context.errors.push(`[E163] common.mode "${context.ioPackageJson.common.mode}" requires JavaScript or Typescript file for "main" in package.json`);
446
446
  }
447
447
  }
448
448
 
@@ -60,8 +60,8 @@ async function checkRepository(context) {
60
60
  } else {
61
61
  context.checks.push('Icon found in latest repository');
62
62
 
63
- if (!context.latestRepo[context.adapterName].icon.startsWith(url)) {
64
- context.errors.push(`[E405] Icon must be in the following path: ${url}; correct sources-dist.json`);
63
+ if (!context.latestRepo[context.adapterName].icon.startsWith(`${url}admin/`)) {
64
+ context.errors.push(`[E405] Icon must be in the following path: ${url}admin/; correct sources-dist.json`);
65
65
  } else {
66
66
  context.checks.push('Icon found in latest repository');
67
67
  }
@@ -113,8 +113,8 @@ async function checkRepository(context) {
113
113
  } else {
114
114
  context.checks.push('Icon found in stable repository');
115
115
 
116
- if (!context.stableRepo[context.adapterName].icon.startsWith(url)) {
117
- context.errors.push(`[E426] Icon must be in the following path: ${url}; correct sources-dist-stable.json`);
116
+ if (!context.stableRepo[context.adapterName].icon.startsWith(`${url}admin/`)) {
117
+ context.errors.push(`[E426] Icon must be in the following path: ${url}admin/; correct sources-dist-stable.json`);
118
118
  } else {
119
119
  context.checks.push('Icon (stable) found in latest repository');
120
120
  }
package/lib/M500_Code.js CHANGED
@@ -348,7 +348,7 @@ async function checkCode(context) {
348
348
  });
349
349
 
350
350
  if (!context.filesList.includes('package-lock.json')) {
351
- context.warnings.push('[W523] "package-lock.json" not found in repo! Please remove from .gitignore!');
351
+ context.warnings.push('[S523] "package-lock.json" not found in repo! Please consider to commit it to github repository.');
352
352
  }
353
353
 
354
354
  if (context['/.travis.yml']) {
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "3.0.6",
2
+ "version": "3.1.0",
3
3
  "name": "@iobroker/repochecker",
4
4
  "dependencies": {
5
5
  "axios": "^1.7.7",