ioBroker templates
This is a collection of templates for ioBroker developers to create adapters or VIS widgets. Just select the template you need, copy its contents from the sub directory and begin working on your project.
Alternatively you can use @iobroker/create-adapter
to generate a custom skeleton based on your exact needs. We recommended that way if you start developing an adapter or widget.
Templates
Currently, the following templates are available:
Adapter and visualization
JavaScript
TypeScript
Adapter only
JavaScript
TypeScript
Visualization only
Features
All templates come with the following features:
- IntelliSense (auto completion and tooltips) in supporting editors
- JavaScript only:
- ESLint for code quality
- Type checking based on the ioBroker declarations
- TypeScript only:
- Built-in component tests using
mocha
&chai
(withchai-as-promised
) andsinon
(withsinon-chai
) for:- Correctly defined package files
- and your own tests
- ... and more to come
Anything missing?
The templates are automatically generated using @iobroker/create-adapter
. If you're missing a feature or found a bug, please open an issue in that repository. Or consider using the tool directly for much more configuration goodness.
For developers
Please don't edit these files directly (except this README). Instead the CI builds in the create-adapter
repo should be updated.