cli icon indicating copy to clipboard operation
cli copied to clipboard

Feature: Json schema for aurelia.json

Open zewa666 opened this issue 8 years ago • 9 comments

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

*** Inline Validation *** aurelia-json-schema2

zewa666 avatar Aug 20 '17 10:08 zewa666

Related issue: https://github.com/aurelia/cli/issues/654 So once the new section is in place, tooltips inside the editor could point to the new url

zewa666 avatar Aug 20 '17 10:08 zewa666

@JeroenVinke I've updated the json schema, over at my repo as much as I could. Some things are still undocumented since I had no idea how to properly describe them. So if you could pull the latest version and maybe create a PR for the missing title and descriptions I could go forward and prepare the PR for the CLI

zewa666 avatar Aug 23 '17 07:08 zewa666

@zewa666 sure, I'd like to take a proper look, which I can do early next week

JeroenVinke avatar Aug 23 '17 11:08 JeroenVinke

Good morning! Has this been pushed out to schema-store yet?

diegohb avatar Oct 30 '17 14:10 diegohb

Good afternoon :)

I don't think so. @zewa666 knows of the current status I think

JeroenVinke avatar Oct 30 '17 15:10 JeroenVinke

I'm very sorry for not having been active on this one. Currently I'm having a really challenging situation in my company. So @diegohb if you wanna go forward with this I would definitely be willing giving you access to my working repo. I think the state is overall quite good and its more about the publishing process. I'd definitely love to see this feature available asap like you but my current time constraints are limiting me to a bare minimum.

zewa666 avatar Nov 02 '17 07:11 zewa666

Awesome idea. But seems stale (-: asked for some help @ discourse https://discourse.aurelia.io/t/up-for-grabs-aurelia-json-schema/925/1

Alexander-Taran avatar Mar 19 '18 19:03 Alexander-Taran

I can't remember.. is the aurelia.json file obsolete in au2 ?

diegohb avatar May 17 '21 01:05 diegohb

That's correct, no more aurelia.json in au2 skeletons.

3cp avatar May 17 '21 04:05 3cp