# CWL Schema is now available on JSON Schema Store

**URL:** <https://cwl.discourse.group/t/cwl-schema-is-now-available-on-json-schema-store/872>\
**Category:** Announcements\
**Created:** [March 26, 2024, 3:22am UTC](https://cwl.discourse.group/t/cwl-schema-is-now-available-on-json-schema-store/872 "2024-03-26T03:22:07Z")\
**Posts on this page:** 7\
**Page:** 1

<div class="post-metadata">

**Author:** ![alexiswl](https://yyz2.discourse-cdn.com/free1/user_avatar/cwl.discourse.group/alexiswl/32/93_2.png) [@alexiswl](https://cwl.discourse.group/u/alexiswl)\
**Post date:** [March 26, 2024, 3:22am UTC](https://cwl.discourse.group/t/cwl-schema-is-now-available-on-json-schema-store/872/1 "2024-03-26T03:22:07Z")

</div>

Hi all,

Excited to announce that the CWL JSON Schema is now available on the JSON Schema store!!

This means that any interaction with CWL on an IDE that supports JSON Schemas will syntax highlight your code and hopefully both autocomplete and error highlight any CWL code you may have.

---

<div class="post-metadata">

**Author:** ![alexiswl](https://yyz2.discourse-cdn.com/free1/user_avatar/cwl.discourse.group/alexiswl/32/93_2.png) [@alexiswl](https://cwl.discourse.group/u/alexiswl)\
**Post date:** [March 26, 2024, 3:22am UTC](https://cwl.discourse.group/t/cwl-schema-is-now-available-on-json-schema-store/872/2 "2024-03-26T03:22:20Z")

</div>

**VSCode Setup:**

1. Install the [RedHat Yaml](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) extension.
2. Associate .cwl file types with .yaml  
This can be achieved by opening up user `settings.json` and adding the following code:

```auto
{
  "files.associations": {
      "*.cwl": "yaml"
  }
}

```

`settings.json` can be opened via the command pallete (Ctrl + Shift + P) and entering _Preferences: Open User Settings (JSON)_

---

<div class="post-metadata">

**Author:** ![alexiswl](https://yyz2.discourse-cdn.com/free1/user_avatar/cwl.discourse.group/alexiswl/32/93_2.png) [@alexiswl](https://cwl.discourse.group/u/alexiswl)\
**Post date:** [March 26, 2024, 3:22am UTC](https://cwl.discourse.group/t/cwl-schema-is-now-available-on-json-schema-store/872/3 "2024-03-26T03:22:26Z")

</div>

**JetBrains Setup**

Make sure your .cwl files are associated as yaml files by going  
Settings (Ctrl + Alt +S ) → Editor → File Types → YAML

Add `*.cwl` to the list of file name patterns

---

<div class="post-metadata">

**Author:** ![alexiswl](https://yyz2.discourse-cdn.com/free1/user_avatar/cwl.discourse.group/alexiswl/32/93_2.png) [@alexiswl](https://cwl.discourse.group/u/alexiswl)\
**Post date:** [March 26, 2024, 3:28am UTC](https://cwl.discourse.group/t/cwl-schema-is-now-available-on-json-schema-store/872/4 "2024-03-26T03:28:35Z")

</div>

**Example - Highlight Invalid Keys**

> Invalid key in input item (VSCode)

![invalid_key_vscode_2](https://global.discourse-cdn.com/free1/uploads/cwl1/original/1X/3bf058fe1ae042db11ab44f4679b29dd5e8d09e5.png)

> Invalid top level document key (VSCode)

![invalid_key_vscode_1](https://global.discourse-cdn.com/free1/uploads/cwl1/original/1X/efdae5a07ebc16b5c9e94b74407a107dace1c5b8.png)

> Invalid key in argument item (JetBrains)

![invalid_key_jetbrains_3](https://global.discourse-cdn.com/free1/uploads/cwl1/original/1X/6581313604d3fe58449902d384e8277c29ad5d13.png)

> Invalid requirements key (JetBrains)

![invalid_key_jetbrains_2](https://global.discourse-cdn.com/free1/uploads/cwl1/original/1X/9bf8229fa560f3d969963906d69597cbc7ebac68.png)

> Invlid top level key (JetBrains)

![invalid_key_jetbrains_1](https://global.discourse-cdn.com/free1/uploads/cwl1/original/1X/1a004dc868b9eb1c3368b4f45008886487df7c46.png)

---

<div class="post-metadata">

**Author:** ![alexiswl](https://yyz2.discourse-cdn.com/free1/user_avatar/cwl.discourse.group/alexiswl/32/93_2.png) [@alexiswl](https://cwl.discourse.group/u/alexiswl)\
**Post date:** [March 26, 2024, 3:33am UTC](https://cwl.discourse.group/t/cwl-schema-is-now-available-on-json-schema-store/872/5 "2024-03-26T03:33:46Z")

</div>

**Example - Hightlight Documentation**

> Show inputBinding documentation (VSCode)

![show_doc_vscode_1](https://global.discourse-cdn.com/free1/uploads/cwl1/original/1X/351bc4ff4b0f086711b3b2e927f3c7f6066c7b6c.png)

> Show valueFrom documentation (JetBrains)

![invalid_key_jetbrains_3](https://global.discourse-cdn.com/free1/uploads/cwl1/original/1X/6581313604d3fe58449902d384e8277c29ad5d13.png)

> Show requirements documentation (JetBrains)

![show_doc_jetbrains_1](https://global.discourse-cdn.com/free1/uploads/cwl1/original/1X/6607d03e30b93babe3991620996ebd451028b4b0.png)

---

<div class="post-metadata">

**Author:** ![alexiswl](https://yyz2.discourse-cdn.com/free1/user_avatar/cwl.discourse.group/alexiswl/32/93_2.png) [@alexiswl](https://cwl.discourse.group/u/alexiswl)\
**Post date:** [March 26, 2024, 3:36am UTC](https://cwl.discourse.group/t/cwl-schema-is-now-available-on-json-schema-store/872/6 "2024-03-26T03:36:50Z")

</div>

**Provide Valid Suggestions**

> Provide valid suggestion to input item (VSCode)  
> ![valid_suggestions_vscode_2](https://global.discourse-cdn.com/free1/uploads/cwl1/original/1X/64739247b2295309300c3c81d2b0c9300f4cc25e.png)

> Provide valid suggestion to requirements (VSCode)  
> ![valid_suggestions_vscode_1](https://global.discourse-cdn.com/free1/uploads/cwl1/original/1X/79e9484c4b5d0b7df336caedda84aeffd0430b83.png)

> Provide valid suggestion to input (JetBrains)  
> ![valid_suggestions_jetbrains_2](https://global.discourse-cdn.com/free1/uploads/cwl1/original/1X/02186918e3f8800453e99a00f8d803eba318ea3a.png)

> Provide valid suggestion to requirements (JetBrains)  
> ![valid_suggestions_jetbrains_1](https://global.discourse-cdn.com/free1/uploads/cwl1/original/1X/089b675ad7cdcf96a554cdccbece3928fb1f005d.png)

---

<div class="post-metadata">

**Author:** ![alexiswl](https://yyz2.discourse-cdn.com/free1/user_avatar/cwl.discourse.group/alexiswl/32/93_2.png) [@alexiswl](https://cwl.discourse.group/u/alexiswl)\
**Post date:** [April 5, 2024, 2:10am UTC](https://cwl.discourse.group/t/cwl-schema-is-now-available-on-json-schema-store/872/7 "2024-04-05T02:10:24Z")

</div>

Note: Enabling VSCode extensions such as vscode-cwl or CWL (Rabix/Benten) may cause the JSON Schema highlighting not to work
