ioBroker.nestjs

Tests:

nestjs adapter for ioBroker

NestJS Adapter for Rest API access to function not covered by the standard simple Api like sendTo

Developer manual

This section is intended for the developer. It can be deleted later

Getting started

You are almost done, only a few steps left:

1. Create a new repository on GitHub with the name ioBroker.nestjs

2. Push all files to the GitHub repo. The creator has already set up the local repository for you:

   git push origin main

3. Head over to src/main.ts and start programming!

Best Practices

We've collected some best practices regarding ioBroker development and coding in general. If you're new to ioBroker or Node.js, you should check them out. If you're already experienced, you should also take a look at them - you might learn something new :)

Scripts in package.json

Several npm scripts are predefined for your convenience. You can run them using npm run <scriptname> | Script name | Description | |-------------|-------------| | build | Compile the TypeScript sources. | | watch | Compile the TypeScript sources and watch for changes. | | test:ts | Executes the tests you defined in *.test.ts files. | | test:package | Ensures your package.json and io-package.json are valid. | | test:unit | Tests the adapter startup with unit tests (fast, but might require module mocks to work). | | test:integration | Tests the adapter startup with an actual instance of ioBroker. | | test | Performs a minimal test run on package files and your tests. | | check | Performs a type-check on your code (without compiling anything). | | lint | Runs ESLint to check your code for formatting errors and potential bugs. | | translate | Translates texts in your adapter to all required languages, see @iobroker/adapter-dev for more details. | | release | Creates a new release, see @alcalzone/release-script for more details. |

Configuring the compilation

The adapter template uses esbuild to compile TypeScript and/or React code. You can configure many compilation settings either in tsconfig.json or by changing options for the build tasks. These options are described in detail in the @iobroker/adapter-dev documentation.

Writing tests

When done right, testing code is invaluable, because it gives you the confidence to change your code while knowing exactly if and when something breaks. A good read on the topic of test-driven development is https://hackernoon.com/introduction-to-test-driven-development-tdd-61a13bc92d92. Although writing tests before the code might seem strange at first, but it has very clear upsides.

The template provides you with basic tests for the adapter startup and package files. It is recommended that you add your own tests into the mix.

Publishing the adapter

Using GitHub Actions, you can enable automatic releases on npm whenever you push a new git tag that matches the form v<major>.<minor>.<patch>. We strongly recommend that you do. The necessary steps are described in .github/workflows/test-and-release.yml.

Since you installed the release script, you can create a new release simply by calling:

npm run release

Additional command line options for the release script are explained in the release-script documentation.

To get your adapter released in ioBroker, please refer to the documentation of ioBroker.repositories.

Test the adapter manually with dev-server

Since you set up dev-server, you can use it to run, test and debug your adapter.

You may start dev-server by calling from your dev directory:

dev-server watch

The ioBroker.admin interface will then be available at http://localhost:8081/

Please refer to the dev-server documentation for more details.

Changelog

2.0.1-2 (2022-07-08)

• (Swissglider) new version starts with more functions

2.0.1-1 (2022-07-08)

• (Swissglider) new version starts with more functions

2.0.1-0 (2022-07-08)

• (Swissglider) new version starts with more functions

2.0.0 (2022-07-08)

• (Swissglider) new version starts with more functions

1.0.0 (2022-07-08)

• (Swissglider) new version starts with more functions

0.0.2-23 (2022-04-06)

• (Swissglider) initial release

License

MIT License

Copyright (c) 2022 Swissglider [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.