Notification from ioBroker Check and Service Bot

Oct 13, 2025 by magicalceylontours.com 107 views

As an adapter developer, it's essential to keep your adapter up-to-date and free from errors to ensure a smooth user experience. The ioBroker Check and Service Bot is an automated tool that processes routine tasks for the ioBroker infrastructure, including checking your adapter repository for common errors and providing suggestions to keep it updated. In this article, we'll discuss the issues detected by the repository checker and provide guidance on how to fix them.

Notification from ioBroker Check and Service Bot

Dear adapter developer,

I'm the ioBroker Check and Service Bot, and I've recently checked the repository for your adapter simple-api for common errors and appropriate suggestions to keep this adapter up-to-date. Please see the result of the check below.

This Check is Based on the Current Head Revisions (Master / Main Branch) of the Adapter Repository

The repository checker has identified several errors, warnings, and suggestions that need to be addressed. These issues can be categorized into three main groups: errors, warnings, and suggestions.

Errors

The following errors were detected by the repository checker:

E026: The "engines" field in the package.json file is missing the required "node" version. The recommended version is ">=18".
E157: The dependency "js-controller" is listed as version 2.0.0, but the minimum required version is 5.0.19. Please update the dependency in the io-package.json file.
E186: The "common.globalDependencies" field in the io-package.json file is not an array.
E190: The admin dependency is missing. The minimum required version is 6.17.14, and the recommended version is 7.4.10. Please add the dependency to the io-package.json file.
E507: The size attributes [xs, xl] are missing for the certificate, checkbox, instance, ip, and number fields in the admin/jsonConfig.json file.
E510: The responsive check has reached its maximum issues. Please fix the reported issues and recheck.
E804: Please process issue ${[#204] "Compatibility check and testing for node.js 22"}$ (https://github.com/ioBroker/ioBroker.simple-api/issues/204).
E804: Please process issue ${[#205] "Compatibility check and testing for Responsive Design (jsonConfig)"}$ (https://github.com/ioBroker/ioBroker.simple-api/issues/205).

Warnings

The following warnings were detected by the repository checker:

W050: The "request" package is deprecated and no longer maintained. Please consider migrating to the "axios" package.
W127: The suggested translation into UK of "common.titleLang" is missing in the io-package.json file.
W134: The suggested translation into UK of "common.desc" is missing in the io-package.json file.
W154: The suggested translation into UK of some "common.news" is missing in the io-package.json file.
W184: The "common.title" field is deprecated and replaced by "common.titleLang". Please remove it from the io-package.json file.
W187: The "common.materialize" field is replaced by the property "common.adminUI.config" in the io-package.json file. Please remove it.
W505: A setTimeout function is found in the "dist/main.js" file, but no clearTimeout is detected.
W510: The "/admin/i18n/uk/translations.json" or "admin/i18n/uk.json" file is not found, but admin support is declared. Please add it.

Suggestions

The following suggestions were detected by the repository checker:

S523: The "package-lock.json" file is not found in the repository. Please consider committing it to the GitHub repository.
S526: Consider adding the plugin "@alcalzone/release-script-plugin-manual-review".

Fixing Errors

Errors reported by the repository checker should be fixed as soon as possible. Some of them require a new release to be considered as fixed. Please note that errors reported by the checker might be considered as a blocking point for future updates at the stable repository.

To fix the errors, follow these steps:

Update the "engines" field in the package.json file to include the required "node" version.
Update the dependency "js-controller" to the minimum required version 5.0.19 in the io-package.json file.
Ensure that the "common.globalDependencies" field in the io-package.json file is an array.
Add the admin dependency to the io-package.json file with the minimum required version 6.17.14 and the recommended version 7.4.10.
Add the size attributes [xs, xl] for the certificate, checkbox, instance, ip, and number fields in the admin/jsonConfig.json file.
Fix the responsive check issues and recheck.
Process issue ${[#204] "Compatibility check and testing for node.js 22"}$ (https://github.com/ioBroker/ioBroker.simple-api/issues/204).
Process issue ${[#205] "Compatibility check and testing for Responsive Design (jsonConfig)"}$ (https://github.com/ioBroker/ioBroker.simple-api/issues/205).

Reviewing Warnings

Warnings reported by the repository checker should be reviewed. While some warnings can be ignored due to good reasons or a dedicated decision of the developer, most warnings should be fixed as soon as possible.

To review the warnings, follow these steps:

Check the "request" package and consider migrating to the "axios" package.
Add the suggested translation into UK of "common.titleLang" to the io-package.json file.
Add the suggested translation into UK of "common.desc" to the io-package.json file.
Add the suggested translation into UK of some "common.news" to the io-package.json file.
Remove the deprecated "common.title" field from the io-package.json file.
Remove the replaced "common.materialize" field from the io-package.json file.
Fix the setTimeout function in the "dist/main.js" file and add a clearTimeout.
Add the "/admin/i18n/uk/translations.json" or "admin/i18n/uk.json" file to support admin translations.

Reviewing Suggestions

Suggestions reported by the repository checker should be reviewed. Suggestions can be ignored due to a decision of the developer, but they are reported as a hint to use a configuration that might become required in the future or is used by most adapters.

To review the suggestions, follow these steps:

Consider committing the "package-lock.json" file to the GitHub repository.
Consider adding the plugin "@alcalzone/release-script-plugin-manual-review".

Conclusion

As an adapter developer, you may have questions about the issues detected by the repository checker. In this article, we'll provide answers to some of the most frequently asked questions.

Q: What is the ioBroker Check and Service Bot?

A: The ioBroker Check and Service Bot is an automated tool that processes routine tasks for the ioBroker infrastructure. It checks your adapter repository for common errors and provides suggestions to keep it up-to-date.

Q: Why are errors reported by the repository checker important?

A: Errors reported by the repository checker can be considered as a blocking point for future updates at the stable repository. It's essential to fix these errors as soon as possible to ensure a smooth user experience.

Q: What are the consequences of ignoring warnings reported by the repository checker?

A: Ignoring warnings reported by the repository checker can lead to issues with your adapter's functionality and user experience. While some warnings can be ignored due to good reasons or a dedicated decision of the developer, most warnings should be fixed as soon as possible.

Q: Can I ignore suggestions reported by the repository checker?

A: Yes, you can ignore suggestions reported by the repository checker. Suggestions are reported as a hint to use a configuration that might become required in the future or is used by most adapters. However, it's recommended to review and consider implementing these suggestions to keep your adapter up-to-date.

Q: How do I fix the errors reported by the repository checker?

A: To fix the errors, follow these steps:

Update the "engines" field in the package.json file to include the required "node" version.
Update the dependency "js-controller" to the minimum required version 5.0.19 in the io-package.json file.
Ensure that the "common.globalDependencies" field in the io-package.json file is an array.
Add the admin dependency to the io-package.json file with the minimum required version 6.17.14 and the recommended version 7.4.10.
Add the size attributes [xs, xl] for the certificate, checkbox, instance, ip, and number fields in the admin/jsonConfig.json file.
Fix the responsive check issues and recheck.
Process issue ${[#204] "Compatibility check and testing for node.js 22"}$ (https://github.com/ioBroker/ioBroker.simple-api/issues/204).
Process issue ${[#205] "Compatibility check and testing for Responsive Design (jsonConfig)"}$ (https://github.com/ioBroker/ioBroker.simple-api/issues/205).

Q: How do I review the warnings reported by the repository checker?

A: To review the warnings, follow these steps:

Check the "request" package and consider migrating to the "axios" package.
Add the suggested translation into UK of "common.titleLang" to the io-package.json file.
Add the suggested translation into UK of "common.desc" to the io-package.json file.
Add the suggested translation into UK of some "common.news" to the io-package.json file.
Remove the deprecated "common.title" field from the io-package.json file.
Remove the replaced "common.materialize" field from the io-package.json file.
Fix the setTimeout function in the "dist/main.js" file and add a clearTimeout.
Add the "/admin/i18n/uk/translations.json" or "admin/i18n/uk.json" file to support admin translations.

Q: How do I review the suggestions reported by the repository checker?

A: To review the suggestions, follow these steps:

Consider committing the "package-lock.json" file to the GitHub repository.
Consider adding the plugin "@alcalzone/release-script-plugin-manual-review".

Q: What if I'm not sure how to fix an issue reported by the repository checker?

A: If you're not sure how to fix an issue reported by the repository checker, you can:

Consult the ioBroker documentation and community resources.
Reach out to the ioBroker support team for assistance.
Ask for help from other adapter developers in the ioBroker community.

Q: How do I start a new check or force the creation of a new issue?

A: To start a new check or force the creation of a new issue, add the following comment to the issue:

@iobroker-bot recheck or @iobroker-bot recreate

Conclusion

The ioBroker Check and Service Bot has detected several errors, warnings, and suggestions in your adapter repository. By following the steps outlined in this article, you can fix the errors, review the warnings, and review the suggestions to keep your adapter up-to-date and compliant with the ioBroker infrastructure. If you have any further questions or concerns, don't hesitate to reach out to the ioBroker community or support team.