README.md

OpenSCD Core

<open-scd>

Installation

npm i open-scd

Usage

<script type="module">
  import 'open-scd/open-scd.js';
</script>

<open-scd></open-scd>

Linting and formatting

To scan the project for linting and formatting errors, run

npm run lint

To automatically fix linting and formatting errors, run

npm run format

We use ESLint and Prettier for linting and formatting. Plugins for automatic formatting and linting during editing are available for vim, emacs, VSCode, and all popular IDEs.

Testing with Web Test Runner

To execute a single test run:

npm test

To run the tests in interactive watch mode run:

npm run test:watch

Tooling configs

For most of the tools, the configuration is in the package.json to reduce the amount of files in the project.

Local Demo with web-dev-server

npm start

To run a local development server that serves the basic demo located in demo/index.html

This webcomponent follows the open-wc recommendation.

License

This project is licensed under the Apache License 2.0.

© 2022 OMICRON electronics GmbH