dtdl-language-server

DTDL language server

Usage no npm install needed!

<script type="module">
  import dtdlLanguageServer from 'https://cdn.skypack.dev/dtdl-language-server';
</script>

README

DTDL Language Server

npm

Introduction

Digital Twins Definition Language (DTDL), a language for describing models for Plug & Play (P&P) devices, device digital twins, and logical digital twins. Broadly, modeling enables IoT solutions to provision, use, and configure digital twins of all kinds from multiple sources in a single solution.

This repo is a language server for DTDL v2, which provides auto-completion and diagnostic by communicate with development tools over a protocol that enables inter-process communication. It currently support features below:

  • Syntax validation.
  • Intellisense to help you with the language syntax (including auto-completion).

Installing

npm install -g dtdl-language-server

Quickstart

Start DTDL language server using stdio protocol

dtdl-language-server --stdio

Start DTDL language server using ipc protocol

dtdl-language-server --node-ipc

Start DTDL language server using named pipe

dtdl-language-server --pipe <YOUR_PIPE_NAME>

Development

Install dependencies

git clone https://github.com/microsoft/dtdl-language-server
cd ./dtdl-language-server
npm install

Build for development

npm run webpack

Build standalone binary

npm run package

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information please see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Contact Us

If you would like to help to build the best IoT experience with IoT Plug and Play, you can reach us directly at Gitter.