aurelia / aurelia/cli

Feature: Json schema for aurelia.json

Open
#704 9 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
JavaScript
Stars
402
Forks
134
PR merge metrics
No merged PRs in 30d

Description

**I'm submitting a feature request**

* **Library Version:**
all

**Please tell us about your environment:**
* **Operating System:**
all

* **Language:**
all

**Current behavior:**
Currently when working with the file `aurelia.json` its pretty hard to know what each property and setting is about and on top of that if you misstype something you won't know what is wrong.

**Expected/desired behavior:**
I'd like to add a json-schema describing the aurelia.json file

* **What is the expected behavior?**
* Have a schema file hosted on https://github.com/schemastore/schemastore/
* Have an example aurelia.json file hosted inside the aurelia cli repository
* Reference that example via the json schema's id property using rawgit

* **What is the motivation / use case for changing the behavior?**
* Full intellisense for aurelia.json props and keys
* Inline documentation directly in your editor
* Links to the aurelia.io docs
* Validation inside your editor of choice

* **Examples**
I've started working on that feature in this repository https://github.com/zewa666/aurelia-json-schema
Also take a look at below animated gifs for what this all is about. Its showing how json validation can work in VSCode

*** Inline documentation ***
![aurelia-json-schema](https://user-images.githubusercontent.com/2861414/29493964-d99fbfb2-85a0-11e7-98d8-5f29c8d6b600.gif)

*** Inline Validation ***
![aurelia-json-schema2](https://user-images.githubusercontent.com/2861414/29493965-d9a14bac-85a0-11e7-8141-a1ee99890b7d.gif)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.