@omicronenergy/oscd-shell

OpenSCD Shell

<oscd-shell>

Installation

npm i @omicronenergy/oscd-shell

Usage

<script type="module">
  import '@omicronenergy/oscd-shell/oscd-shell.js';
</script>

<oscd-shell></oscd-shell>

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

Linting and formatting are centralized in @omicronenergy/oscd-tooling, which runs ESLint (with @stylistic for formatting) via the oscd CLI.

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

Build, lint, test, bundle, and deploy tooling is centralized in @omicronenergy/oscd-tooling and run via the oscd CLI (see package.json scripts). This project keeps its own rollup.config.js and web-test-runner.config.js because its build has needs (multi-entry bundling, a custom test harness) that diverge from the shared defaults — oscd automatically prefers a project-local config file of the same name over its own default.

Local Demo with web-dev-server

npm run 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