Add json-schema notation for config

[askirmas]

Add config's JSON Schema to website available by https:://jestjs.io/jest.schema.json

Motivation

• Documentation hints during typing
  

• JSON Schema root property "examples" for popular 'snippets'

TBD

• One source of truth for website documentation, CLI help and jest init. During collecting I found some contradictions in transform, testPathPattern and coverageProvider.

[facebook-github-bot]

Hi @askirmas!

Thank you for your pull request and welcome to our community.We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file.

In order for us to review and merge your code, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

[codecov-io]

Codecov Report

Merging #9879 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #9879   +/-   ##
=======================================
  Coverage   64.50%   64.50%           
=======================================
  Files         291      291           
  Lines       12361    12361           
  Branches     3057     3055    -2     
=======================================
  Hits         7974     7974           
  Misses       3745     3745           
  Partials      642      642           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6cbd3cb...a79eaaf. Read the comment docs.

[SimenB]

Oh this is cool! How can we keep it up to date? Can we generate it from TS types or something so it always reflects the code?

During collecting I found some contradictions

Can we fix those?

[askirmas]

Producing MD, TS, stdout for --help, etc from JsonSchema is MUCH easier task than vice versa. I can add it in a while.

From TS - that exactly i'm playing with. But AST.parser officially raw so my brains are burning.

[jeysal]

I remember there was a tool called typescript-json-schema I think that worked pretty well for any setup since it also used proper TS APIs

[connectdotz]

hi, we have a PR (jest-community/vscode-jest#638) aimed to add jest json config validation/code-assistance in vscode. I think it is a great idea but it uses the schema hosted in @askirmas repo instead of jest's official repo. For accuracy and long-term maintenance, I think it is much desired to host in here as part of jest release process.

Noticed this PR and wondering if @askirmas can address the issues @SimenB mentioned above so we can get the schema into the official repo?

[askirmas]

What to do with this issue?

[SimenB]

I believe the missing part is generating this rather than having some hand made thing. Also, a separate PR for any errors you found would be great

[askirmas]

Well, I prefer much more the opposite way - to generate/evaluate code from data. In this case, jsonSchema is the source, .d.ts is generated // event better - evaluated with TypeScript expression but it is a very hard task
Also question about markdown files if not support them manually

[SimenB]

Seems the bot closed this instead of retargeting when we renamed master to main - feel free to open up a new PR

[github-actions]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.