@iobroker/repochecker 3.1.4 → 3.2.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
@@ -1,215 +1,277 @@
1
1
  # Adapter repository checker
2
- This is a code for frontend and back-end of the service https://adapter-check.iobroker.in/
2
+
3
+ This is a code for frontend and back-end of the service <https://adapter-check.iobroker.in/>
3
4
 
4
5
  If you want to add your adapter to the public ioBroker repository, all tests on this page must be OK.
5
6
 
6
7
  ## How to test via cli
8
+
7
9
  You can pass your repository as a parameter to test
8
10
 
9
- ``npx @iobroker/repochecker <repo> [branch]``
11
+ `npx @iobroker/repochecker <repo> [branch]`
10
12
 
11
- ```
13
+ ```bash
12
14
  npx @iobroker/repochecker https://github.com/ioBroker/ioBroker.javascript master
13
15
  ```
14
16
 
15
17
  Branch (`master/main/dev`) is optional.
16
18
 
19
+ For extra debugging outputs you can pass the `--debug` parameter.
20
+
21
+ For a local test you can pass the `--local` parameter. Most of the files are read localy.
22
+ The link to the github repository is still necessary because data from the project settings on github is also checked.
23
+
24
+ Example:
25
+
26
+ ```bash
27
+ npx @iobroker/repochecker https://github.com/ioBroker/ioBroker.javascript --local
28
+ ```
29
+
17
30
  <!--
18
31
  Placeholder for the next version (at the beginning of the line):
19
32
  ### **WORK IN PROGRESS**
20
33
  -->
21
34
 
22
35
  ## Changelog
36
+ ### 3.2.0 (2024-11-01)
37
+
38
+ - (oweitman) Script has been extended to use optionally local data for checking.
39
+ - (mcm1957) Warning if i18n is not used has been fixed [#324].
40
+ - (mcm1957) Check for importent issues has been added.
41
+ - (mcm1957) Checking of jsonConfig (initially) added.
42
+
23
43
  ### 3.1.4 (2024-10-26)
24
- * (mcm1957) linter has been activated and issues reported have been fixed.
25
- * (mcm1957) Blacklist for package/dependencies has been extended.
26
- * (mcm1957) Recommend adapter-core 3.2.2 now.
27
- * (mcm1957) Clearify test for "[E952] .npmignore not found". [#320]
28
- * (mcm1957) Abort processing if iobroker.live not reachable. [#321]
44
+
45
+ - (mcm1957) linter has been activated and issues reported have been fixed.
46
+ - (mcm1957) Blacklist for package/dependencies has been extended.
47
+ - (mcm1957) Recommend adapter-core 3.2.2 now.
48
+ - (mcm1957) Clearify test for "[E952] .npmignore not found". [#320]
49
+ - (mcm1957) Abort processing if iobroker.live not reachable. [#321]
29
50
 
30
51
  ### 3.1.3 (2024-10-11)
31
- * (mcm1957) Checker no longer crash id no npm package exists.
52
+
53
+ - (mcm1957) Checker no longer crash id no npm package exists.
32
54
 
33
55
  ### 3.1.2 (2024-10-04)
34
- * (mcm1957) Require node 18 minimum as engines clause.
56
+
57
+ - (mcm1957) Require node 18 minimum as engines clause.
35
58
 
36
59
  ### 3.1.1 (2024-10-04)
37
- * (mcm1957) "[E166] 'common.mode: extension' is unknown" has been fixed [#308]
38
- * (mcm1957) "[E904] file iob_npm.done found in repository, but not found in .gitignore" removed as covered by [E503]. [#309]
39
- * (mcm1957) "[E500] node_modules found" has been retricted to adapetr root. [#297]
40
- * (mcm1957) Do not check main entry if common.mode none or extension.
41
- * (mcm1957) Change "[W113] Adapter should support compact mode" text and honor common.compact set to false. [#300]
60
+
61
+ - (mcm1957) "[E166] 'common.mode: extension' is unknown" has been fixed [#308]
62
+ - (mcm1957) "[E904] file iob_npm.done found in repository, but not found in .gitignore" removed as covered by [E503]. [#309]
63
+ - (mcm1957) "[E500] node_modules found" has been retricted to adapetr root. [#297]
64
+ - (mcm1957) Do not check main entry if common.mode none or extension.
65
+ - (mcm1957) Change "[W113] Adapter should support compact mode" text and honor common.compact set to false. [#300]
42
66
 
43
67
  ### 3.1.0 (2024-09-29)
44
- * (mcm1957) "@iobroker/plugin-sentry" blacklisted as dependency [#301]
45
- * (mcm1957) Accept .ts files as main file too. [#303]
46
- * (mcm1957) [E405] and [E426] incorrect path has been corrected. [#299]
68
+
69
+ - (mcm1957) "@iobroker/plugin-sentry" blacklisted as dependency [#301]
70
+ - (mcm1957) Accept .ts files as main file too. [#303]
71
+ - (mcm1957) [E405] and [E426] incorrect path has been corrected. [#299]
47
72
 
48
73
  ### 3.0.7 (2024-09-19)
49
- * (mcm1957) "[W523] 'package-lock.json"'not found in repo!" reduced to suggestion. [#298]
74
+
75
+ - (mcm1957) "[W523] 'package-lock.json"'not found in repo!" reduced to suggestion. [#298]
50
76
 
51
77
  ### 3.0.6 (2024-09-13)
52
- * (mcm1957) "[E124] Main file not found" no longer raised if common.nogit is set
53
- * (mcm1957) 'Text of "common.main" is deprecated' has been adapted. [#266]
54
- * (mcm1957) Ignore errors caused by complex .gitignor/.npmignore. [#288]
78
+
79
+ - (mcm1957) "[E124] Main file not found" no longer raised if common.nogit is set
80
+ - (mcm1957) 'Text of "common.main" is deprecated' has been adapted. [#266]
81
+ - (mcm1957) Ignore errors caused by complex .gitignor/.npmignore. [#288]
55
82
 
56
83
  ### 3.0.5 (2024-09-13)
57
- * (mcm1957) '@iobroker/dev-server' is valid as dev-dependency. [#260]
84
+
85
+ - (mcm1957) '@iobroker/dev-server' is valid as dev-dependency. [#260]
58
86
 
59
87
  ### 3.0.4 (2024-09-12)
60
- * (mcm1957) Abort with incorrect dependency definition fixed [#287]
61
- * (mcm1957) Improve handling of malformed dependency definitions [#284]
62
- * (mcm1957) Improve handling of malformed .releaseconfig.json files [#283]
63
- * (mcm1957) Missing mandatory translations are considered an error now. [#277, #278]
64
- * (mcm1957) '.npmignore found but "files" is used' is a warning now. [#274]
65
- * (mcm1957) '@iobroker/dev-server' has been blacklisted as any dependency. [#260]
66
- * (mcm1957) Do no longer require a js-controller dependecy for wwwOnly adapters. [#250]
88
+
89
+ - (mcm1957) Abort with incorrect dependency definition fixed [#287]
90
+ - (mcm1957) Improve handling of malformed dependency definitions [#284]
91
+ - (mcm1957) Improve handling of malformed .releaseconfig.json files [#283]
92
+ - (mcm1957) Missing mandatory translations are considered an error now. [#277, #278]
93
+ - (mcm1957) '.npmignore found but "files" is used' is a warning now. [#274]
94
+ - (mcm1957) '@iobroker/dev-server' has been blacklisted as any dependency. [#260]
95
+ - (mcm1957) Do no longer require a js-controller dependecy for wwwOnly adapters. [#250]
67
96
 
68
97
  ### 3.0.3 (2024-09-12)
69
- * (mcm1957) Check for iob_npm.done at .npmignore has been removed [#294]
98
+
99
+ - (mcm1957) Check for iob_npm.done at .npmignore has been removed [#294]
70
100
 
71
101
  ### 3.0.2 (2024-09-11)
72
- * (mcm1957) Handling of missing LICENSE file corrected. [#282]
73
- * (mcm1957) [W126] Missing mandatory translation is error now. [#293]
74
- * (mcm1957) Record repochcker version used for tests.
75
- * (mcm1957) Record github commit-sha of last commit used for tests.
102
+
103
+ - (mcm1957) Handling of missing LICENSE file corrected. [#282]
104
+ - (mcm1957) [W126] Missing mandatory translation is error now. [#293]
105
+ - (mcm1957) Record repochcker version used for tests.
106
+ - (mcm1957) Record github commit-sha of last commit used for tests.
76
107
 
77
108
  ### 3.0.0 (2024-09-10)
78
- * (mcm1957) Error and warning numbering has been reviewed and duplicates removed.
79
- * (mcm1957) index.js has been split into seperated modules.
109
+
110
+ - (mcm1957) Error and warning numbering has been reviewed and duplicates removed.
111
+ - (mcm1957) index.js has been split into seperated modules.
80
112
 
81
113
  ### 2.10.0 (2024-08-19)
82
- * (mcm1957) Suggestions ([Sxxx] have been added).
114
+
115
+ - (mcm1957) Suggestions ([Sxxx] have been added).
83
116
 
84
117
  ### 2.9.1 (2024-08-12)
85
- * (mcm1957) E162 - correct dependency check for js-controller. [#267].
86
- * (mcm1957) E605 - copyright year range including whitespaces is now accepted. [#269].
87
- * (mcm1957) E016 - missing vaiableexpansion has been added. [#263].
88
- * (mcm1957) E114 - typo at error message has been fixed [#261].
118
+
119
+ - (mcm1957) E162 - correct dependency check for js-controller. [#267].
120
+ - (mcm1957) E605 - copyright year range including whitespaces is now accepted. [#269].
121
+ - (mcm1957) E016 - missing vaiableexpansion has been added. [#263].
122
+ - (mcm1957) E114 - typo at error message has been fixed [#261].
89
123
 
90
124
  ### 2.9.0 (2024-07-29)
91
- * (mcm1957) Adapt text if sources-dist(-stable).json need a correction [#97].
92
- * (mcm1957) Missing "common.mode" error text corrected [#249].
93
- * (mcm1957) Files "iob" and "iobroker" are disallowed now [#248].
94
- * (mcm1957) Checks related to @alcalzone/releasescript modified [#71].
95
- * (mcm1957) Text of E114 (missing adminUI) adapted.
125
+
126
+ - (mcm1957) Adapt text if sources-dist(-stable).json need a correction [#97].
127
+ - (mcm1957) Missing "common.mode" error text corrected [#249].
128
+ - (mcm1957) Files "iob" and "iobroker" are disallowed now [#248].
129
+ - (mcm1957) Checks related to @alcalzone/releasescript modified [#71].
130
+ - (mcm1957) Text of E114 (missing adminUI) adapted.
96
131
 
97
132
  ### 2.8.1 (2024-07-28)
98
- * (mcm1957) Check of js-controller version has been corrected [#247].
99
- * (mcm1957) Honor '>' at dependency checks too [#246].
133
+
134
+ - (mcm1957) Check of js-controller version has been corrected [#247].
135
+ - (mcm1957) Honor '>' at dependency checks too [#246].
100
136
 
101
137
  ### 2.8.0 (2024-07-28)
102
- * (mcm1957) Copyright year check has been fixed for single year entries.
103
- * (mcm1957) js-controller version check added [#233].
104
- * (mcm1957) Check for fixed version dependencies and for github dependencies [#233].
105
- * (mcm1957) Missing language files reduced to warning [#203].
106
- * (mcm1957) Missing .gitignore is considered an error now.
107
- * (mcm1957) "common.noConfig" no longer reported as error if "common.adminUI" is present [#245].
108
- * (mcm1957) "common.noConfig" must match "common.adminUI" setting [#170].
138
+
139
+ - (mcm1957) Copyright year check has been fixed for single year entries.
140
+ - (mcm1957) js-controller version check added [#233].
141
+ - (mcm1957) Check for fixed version dependencies and for github dependencies [#233].
142
+ - (mcm1957) Missing language files reduced to warning [#203].
143
+ - (mcm1957) Missing .gitignore is considered an error now.
144
+ - (mcm1957) "common.noConfig" no longer reported as error if "common.adminUI" is present [#245].
145
+ - (mcm1957) "common.noConfig" must match "common.adminUI" setting [#170].
109
146
 
110
147
  ### 2.7.2 (2024-07-26)
111
- * (mcm1957) package-lock.json check fixed.
148
+
149
+ - (mcm1957) package-lock.json check fixed.
112
150
 
113
151
  ### 2.7.1 (2024-07-26)
114
- * (mcm1957) Reduce setTimeout/setInterval error to warning temporary.
152
+
153
+ - (mcm1957) Reduce setTimeout/setInterval error to warning temporary.
115
154
 
116
155
  ### 2.7.0 (2024-07-26)
117
- * (mcm1957) Some non trivial keywords related to adapter are enforced now [#234].
118
- * (mcm1957) Severity if [E105] / [W105] has been corrected [#204].
119
- * (mcm1957) Disallow 'globalDependencies' at package.json [#204].
120
- * (mcm1957) Several false positives for wwwOnly widgetadapters have been fixed [#230, #222].
121
- * (mcm1957) Missing .npmignore is now considered an error [#229].
122
- * (mcm1957) Usage of package.json 'files' section is now recommended.
123
- * (mcm1957) If more than 7 common.news entries are present a warning is issued now [#232].
124
- * (mcm1957) Versions listed at common.news are checked to exist at npm now [#226].
125
- * (mcm1957) 'package-lock.json' is checked to exist at GitHub now [#188].
126
- * (mcm1957) travis checks have been removed [#237].
127
- * (mcm1957) Copyright year now honors commit year and npm publish year too [#237].
156
+
157
+ - (mcm1957) Some non trivial keywords related to adapter are enforced now [#234].
158
+ - (mcm1957) Severity if [E105] / [W105] has been corrected [#204].
159
+ - (mcm1957) Disallow 'globalDependencies' at package.json [#204].
160
+ - (mcm1957) Several false positives for wwwOnly widgetadapters have been fixed [#230, #222].
161
+ - (mcm1957) Missing .npmignore is now considered an error [#229].
162
+ - (mcm1957) Usage of package.json 'files' section is now recommended.
163
+ - (mcm1957) If more than 7 common.news entries are present a warning is issued now [#232].
164
+ - (mcm1957) Versions listed at common.news are checked to exist at npm now [#226].
165
+ - (mcm1957) 'package-lock.json' is checked to exist at GitHub now [#188].
166
+ - (mcm1957) travis checks have been removed [#237].
167
+ - (mcm1957) Copyright year now honors commit year and npm publish year too [#237].
128
168
 
129
169
  ### 2.6.1 (2024-06-24)
130
- * (mcm1957) Check "[W156] Adapter should support admin 5 UI (jsonConfig)" checks for reactUi now.
170
+
171
+ - (mcm1957) Check "[W156] Adapter should support admin 5 UI (jsonConfig)" checks for reactUi now.
131
172
 
132
173
  ### 2.6.0 (2024-06-24)
133
- * (mcm1957) Check has been aded to ensure keywords and common.keywords are present. [#200]
134
- * (mcm1957) Detection of react has been added, gulpfile.js is accepted for react based UIs now. [#223]
174
+
175
+ - (mcm1957) Check has been aded to ensure keywords and common.keywords are present. [#200]
176
+ - (mcm1957) Detection of react has been added, gulpfile.js is accepted for react based UIs now. [#223]
135
177
 
136
178
  ### 2.5.1 (2024-06-24)
137
- * (mcm1957) Suggestion to update dependencies to recommended version added.
138
- * (mcm1957) Adapter-core recommended set to 3.1.6 [#220]
179
+
180
+ - (mcm1957) Suggestion to update dependencies to recommended version added.
181
+ - (mcm1957) Adapter-core recommended set to 3.1.6 [#220]
139
182
 
140
183
  ### 2.5.0 (2024-05-30)
141
- * (mcm1957) Check to ensure that dependency revisions are available at repository added. [#180]
184
+
185
+ - (mcm1957) Check to ensure that dependency revisions are available at repository added. [#180]
142
186
 
143
187
  ### 2.4.0 (2024-05-30)
144
- * (mcm1957) Add check to protect sensitive data. [#195]
145
- * (mcm1957) Add check to verify that dependencies and globalDepencies are of type array. [#90]
188
+
189
+ - (mcm1957) Add check to protect sensitive data. [#195]
190
+ - (mcm1957) Add check to verify that dependencies and globalDepencies are of type array. [#90]
146
191
 
147
192
  ### 2.3.1 (2024-05-07)
148
- * (mcm1957) Reduce number of missing translation warnings.
149
- * (mcm1957) Seperate between required and recommended translations.
150
- * (mcm1957) Log missing translations in detail.
193
+
194
+ - (mcm1957) Reduce number of missing translation warnings.
195
+ - (mcm1957) Seperate between required and recommended translations.
196
+ - (mcm1957) Log missing translations in detail.
151
197
 
152
198
  ### 2.3.0 (2024-05-07)
153
- * (mcm1957) Elements marked as deprectaed added to blacklist.
154
- * (mcm1957) Blacklist added to block elements at package.json and io-package.json.
155
- * (mcm1957) Error [E000] will be raised now if repository cannot be accessed at all [#194].
156
- * (mcm1957) Reading of package.json and io-package.json has been moved to head of tests.
157
- * (mcm1957) Check minimum and recommended node version at package.json (#160)
158
- * (mcm1957) Raise an error if version at package.json is lower than latest release at npmjs [#192]
199
+
200
+ - (mcm1957) Elements marked as deprectaed added to blacklist.
201
+ - (mcm1957) Blacklist added to block elements at package.json and io-package.json.
202
+ - (mcm1957) Error [E000] will be raised now if repository cannot be accessed at all [#194].
203
+ - (mcm1957) Reading of package.json and io-package.json has been moved to head of tests.
204
+ - (mcm1957) Check minimum and recommended node version at package.json (#160)
205
+ - (mcm1957) Raise an error if version at package.json is lower than latest release at npmjs [#192]
159
206
 
160
207
  ### 2.2.3 (2024-03-29)
161
- * (mcm1957) Checking of license has been improved
162
208
 
163
- ### 2.2.2 (2024-03-29)
164
- * (mcm1957) Checking of adapter-core has been fixed
165
- * (mcm1957) Load all potential interesting files, fixes [#149]
209
+ - (mcm1957) Checking of license has been improved
210
+
211
+ ### 2.2.2 (2024-03-29)
212
+
213
+ - (mcm1957) Checking of adapter-core has been fixed
214
+ - (mcm1957) Load all potential interesting files, fixes [#149]
166
215
 
167
216
  ### 2.2.1 (2024-03-26)
168
- * (mcm1957) Added check that own adapter is not listed at common.restartAdapters
169
- * (mcm1957) Added check of version strings at common.news
170
- * (mcm1957) Added check for recommended node version (node 18 for now)
171
- * (mcm1957) Disallow common.mode == subscribe
172
- * (mcm1957) Deprecate common.wakeup
173
- * (mcm1957) Added check for adapter-core version (>= 3.0.6)
217
+
218
+ - (mcm1957) Added check that own adapter is not listed at common.restartAdapters
219
+ - (mcm1957) Added check of version strings at common.news
220
+ - (mcm1957) Added check for recommended node version (node 18 for now)
221
+ - (mcm1957) Disallow common.mode == subscribe
222
+ - (mcm1957) Deprecate common.wakeup
223
+ - (mcm1957) Added check for adapter-core version (>= 3.0.6)
174
224
 
175
225
  ### 2.2.0 (2024-03-24)
176
- * (klein0r) Added check for licenseInformation
177
- * (klein0r) Added check for deprecated license
178
- * (klein0r) Added check for required attribute common.tier
179
- * (klein0r) Added check for disallowed attribute common.automaticUpgrade
226
+
227
+ - (klein0r) Added check for licenseInformation
228
+ - (klein0r) Added check for deprecated license
229
+ - (klein0r) Added check for required attribute common.tier
230
+ - (klein0r) Added check for disallowed attribute common.automaticUpgrade
180
231
 
181
232
  ### 2.1.13 (2024-01-02)
182
- * (bluefox) Corrected rule W156: adminUI.config === 'none' is allowed
233
+
234
+ - (bluefox) Corrected rule W156: adminUI.config === 'none' is allowed
183
235
 
184
236
  ### 2.1.12 (2023-09-21)
185
- * (bluefox) Added check of using '_' in adapter name
237
+
238
+ - (bluefox) Added check of using '\_' in adapter name
186
239
 
187
240
  ### 2.1.11 (2023-09-05)
188
- * (bluefox) Added check of iobroker.js-controller in dependencies
241
+
242
+ - (bluefox) Added check of iobroker.js-controller in dependencies
189
243
 
190
244
  ### 2.1.7 (2023-08-14)
191
- * (mcm57) Update index.js - fix typo in error message (packet.json)
192
- * (mcm57) Update index.js - renumber E504/1 to 519 - fixes #112
245
+
246
+ - (mcm57) Update index.js - fix typo in error message (packet.json)
247
+ - (mcm57) Update index.js - renumber E504/1 to 519 - fixes #112
193
248
 
194
249
  ### 2.1.6 (2022-12-08)
195
- * (bluefox) added better error logging
250
+
251
+ - (bluefox) added better error logging
196
252
 
197
253
  ### 2.1.5 (2022-12-07)
198
- * (bluefox) added check of `.releaseconfig.json` file
254
+
255
+ - (bluefox) added check of `.releaseconfig.json` file
199
256
 
200
257
  ### 2.1.4 (2022-08-19)
201
- * (bluefox) Added check for adapter name: it may not start with '_'
258
+
259
+ - (bluefox) Added check for adapter name: it may not start with '\_'
202
260
 
203
261
  ### 2.1.2 (2022-07-14)
204
- * (bluefox) Fixed some errors
262
+
263
+ - (bluefox) Fixed some errors
205
264
 
206
265
  ### 2.1.0 (2022-05-26)
207
- * (bluefox) Added support for jsonConfig.json5 and jsonCustom.json5
266
+
267
+ - (bluefox) Added support for jsonConfig.json5 and jsonCustom.json5
208
268
 
209
269
  ### 2.0.5 (2022-05-22)
210
- * (bluefox) Made it possible to run with npx
270
+
271
+ - (bluefox) Made it possible to run with npx
211
272
 
212
273
  ## License
274
+
213
275
  The MIT License (MIT)
214
276
 
215
277
  Copyright (c) 2014-2024 Denis Haev <dogafox@gmail.com>