Skip to content

Commit db199e1

Browse files
committed
Update dependencies.
1 parent 0ed0ae9 commit db199e1

File tree

5 files changed

+2946
-4877
lines changed

5 files changed

+2946
-4877
lines changed

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,5 @@ out
22
dist
33
node_modules
44
.vscode-test
5+
coverage/
6+
*.vsix

README.md

+26-26
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,29 @@
33
# DTDL Editor for Visual Studio Code
44

55
## Overview
6+
67
The [Digital Twin Definition Language](https://aka.ms/DTDL) (DTDL) is a language for describing models for Plug and Play 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. Using DTDL to describe any digital twin’s abilities enables the IoT platform and IoT solutions to leverage the semantics of each digital twin.
78

89
With the [DTDL extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=vsciot-vscode.vscode-dtdl) , you can read and write documents using DTDL more efficiently taking full advantage of the following key features:
910

10-
- Create interfaces from the command palette with predefined or customized templates.
11+
- Create interfaces from the command palette with predefined or customized templates.
1112
- Intellisense to help you with the language syntax (including auto-completion).
12-
- Use predefined code snippets to develop DTDL efficiently.
13+
- Use predefined code snippets to develop DTDL efficiently.
1314
- Syntax validation.
1415

1516
## Get Started
1617

1718
### Create Interface
1819

19-
You could use the command palette to create interface from predefined or customized templates.
20+
You could use the command palette to create interface from predefined or customized templates.
2021

2122
- In Visual Studio Code, select **View > Command Palette** to open the VS Code command palette.
22-
- In the command palette, enter and run the command **DTDL: Create Interface**.
23-
- Follow the instruction to assign the interface name.
23+
- In the command palette, enter and run the command **DTDL: Create Interface**.
24+
- Follow the instruction to assign the interface name.
2425
- If there are multiple templates existing, choose a template you need. Otherwise, the extension will the basic template as default.
25-
- A JSON file will be created in the current folder. The file name is based on the interface name you assigned.
26-
- The @id is the path component of the [Digital Twin Model Identifier](https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/dtdlv2.md#digital-twin-model-identifier-dtmi) (DTMI). You should modify the @id following the DTMI rule to uniquely identify the device model.
27-
- You could extend the interface with [DTDL v2](https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/dtdlv2.md).
28-
26+
- A JSON file will be created in the current folder. The file name is based on the interface name you assigned.
27+
- The @id is the path component of the [Digital Twin Model Identifier](https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/dtdlv2.md#digital-twin-model-identifier-dtmi) (DTMI). You should modify the @id following the DTMI rule to uniquely identify the device model.
28+
- You could extend the interface with [DTDL v2](https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/dtdlv2.md).
2929

3030
### Intellisense and Syntax validation
3131

@@ -35,7 +35,7 @@ This extension could help you with the language syntax (including auto-completio
3535
3636
### Use Predefined Code Snippets
3737

38-
Besides the basic auto completion, this extension also provides some predefined code snippets to help you develop DTDL efficiently.
38+
Besides the basic auto completion, this extension also provides some predefined code snippets to help you develop DTDL efficiently.
3939

4040
| Code Snippet | Description |
4141
| --- | --- |
@@ -47,40 +47,40 @@ Besides the basic auto completion, this extension also provides some predefined
4747

4848
#### Prepare your template file
4949

50-
You could use any DTDL file as a template to develop efficiently. Meanwhile, you could also use these predefined tags to make your template more flexible.
50+
You could use any DTDL file as a template to develop efficiently. Meanwhile, you could also use these predefined tags to make your template more flexible.
5151

5252
- **{modelId}**: The extention will replace this tag with *dtmi:com:example:interface_name;1* when creating a new DTDL from a template. For example, if you assigned the interface name as "test", the result will be dtmi:com:example:test;1.
53-
- **{modelName}**: The extension will replace this tag with the interface name when creating a new DTDL from a template.
53+
- **{modelName}**: The extension will replace this tag with the interface name when creating a new DTDL from a template.
5454

5555
#### Import your template file
5656

5757
- Go to [[extension installation location](https://code.visualstudio.com/docs/editor/extension-gallery#_where-are-extensions-installed)]/vsciot-vscode.vscode-dtdl-[extension release version]/templates
58-
- Store your template into this folder as a JSON file. Keep the file name short and meaningful, because the extension will use the file name as template name.
58+
- Store your template into this folder as a JSON file. Keep the file name short and meaningful, because the extension will use the file name as template name.
5959

6060
### Create Your Own Code Snippets
6161

6262
If you would like to create customized code snippets for VS Code, you could follow [Snippets in Visual Studio Code](https://code.visualstudio.com/docs/editor/userdefinedsnippets)
6363

64-
### Contribute Your Templates and Code Snippets to the Community
64+
### Contribute Your Templates and Code Snippets to the Community
6565

6666
You could also contribute your templates and code snippets to the [DTDL repository](https://github.com/microsoft/vscode-dtdl).
6767

6868
- Uploading the new templates to **templates** folder.
6969
- Modifying and adding new code snippets to **snippets/snippets.json** file.
7070

71-
Once the pull request is approved, your templates and code snippets will be released with next release of DTDL extension.
71+
Once the pull request is approved, your templates and code snippets will be released with next release of DTDL extension.
7272

7373
## Commands
7474

7575
| Command | Description |
7676
| --- | --- |
7777
| `DTDL: Create Interface...` | Create new interface from predefined or customized templates. |
7878

79-
## Trouble Shooting
79+
## Trouble Shooting
8080

81-
### Error when creating the interface
81+
### Error when creating the interface
8282

83-
As default, the extension will get the available templates from *[[extension installation location](https://code.visualstudio.com/docs/editor/extension-gallery#_where-are-extensions-installed)]/vsciot-vscode.vscode-dtdl-[extension release version]/templates*. But if you delete this folder or all templates files in this folder, you will have an error when creating the interface. In order to fix this issue, you could copy the templates from [DTDL repository](https://github.com/microsoft/vscode-dtdl) to your local templates folder manually.
83+
As default, the extension will get the available templates from *[[extension installation location](https://code.visualstudio.com/docs/editor/extension-gallery#_where-are-extensions-installed)]/vsciot-vscode.vscode-dtdl-[extension release version]/templates*. But if you delete this folder or all templates files in this folder, you will have an error when creating the interface. In order to fix this issue, you could copy the templates from [DTDL repository](https://github.com/microsoft/vscode-dtdl) to your local templates folder manually.
8484

8585
## Contributing
8686

@@ -126,13 +126,13 @@ You should receive a response within 24 hours. If for some reason you do not, pl
126126

127127
Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
128128

129-
* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
130-
* Full paths of source file(s) related to the manifestation of the issue
131-
* The location of the affected source code (tag/branch/commit or direct URL)
132-
* Any special configuration required to reproduce the issue
133-
* Step-by-step instructions to reproduce the issue
134-
* Proof-of-concept or exploit code (if possible)
135-
* Impact of the issue, including how an attacker might exploit the issue
129+
- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
130+
- Full paths of source file(s) related to the manifestation of the issue
131+
- The location of the affected source code (tag/branch/commit or direct URL)
132+
- Any special configuration required to reproduce the issue
133+
- Step-by-step instructions to reproduce the issue
134+
- Proof-of-concept or exploit code (if possible)
135+
- Impact of the issue, including how an attacker might exploit the issue
136136

137137
This information will help us triage your report more quickly.
138138

@@ -144,4 +144,4 @@ We prefer all communications to be in English.
144144

145145
## Policy
146146

147-
Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd).
147+
Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd).

azure-pipelines/ci.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
trigger: none
66

77
pr:
8-
- master
8+
- main
99
- develop
1010
- pre-release-v*
1111

0 commit comments

Comments
 (0)