Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

V2 rewrite #181

Merged
merged 113 commits into from
Dec 16, 2019
Merged

V2 rewrite #181

merged 113 commits into from
Dec 16, 2019

Conversation

trieloff
Copy link
Collaborator

@trieloff trieloff commented Dec 11, 2019

This is still a work in progress of what will become an effective re-write of jsonschema2md

Some of the changes that are coming:

Some things will be made easier with the change:

And some things will be made impossible:

but this is still work in progress and a couple of things remain to be done:

BREAKING CHANGE: Repaces lodash with ferrum, removed bluebird, changes the meaning of `--schema-out` or `-x` to be no longer relative to output dir

The `--schema-out` or `-x` command line option is no longer relative to the output path (specified with `-o` or `--out`)
@adobe adobe deleted a comment Dec 16, 2019
@adobe adobe deleted a comment Dec 16, 2019
@adobe adobe deleted a comment Dec 16, 2019
@adobe adobe deleted a comment Dec 16, 2019
@adobe adobe deleted a comment Dec 16, 2019
@adobe adobe deleted a comment Dec 16, 2019
@adobe adobe deleted a comment Dec 16, 2019
@adobe adobe deleted a comment Dec 16, 2019
@adobe adobe deleted a comment Dec 16, 2019
@adobe adobe deleted a comment Dec 16, 2019
@adobe adobe deleted a comment Dec 16, 2019
@adobe adobe deleted a comment Dec 16, 2019
@adobe adobe deleted a comment Dec 16, 2019
@adobe adobe deleted a comment Dec 16, 2019
@adobe adobe deleted a comment Dec 16, 2019
@adobe adobe deleted a comment Dec 16, 2019
@adobe adobe deleted a comment Dec 16, 2019
@adobe adobe deleted a comment Dec 16, 2019
@adobe adobe deleted a comment Dec 16, 2019
@adobe adobe deleted a comment Dec 16, 2019
@adobe adobe deleted a comment Dec 16, 2019
@adobe adobe deleted a comment Dec 16, 2019
@adobe adobe deleted a comment Dec 16, 2019
@trieloff trieloff merged commit f307ee1 into master Dec 16, 2019
@trieloff
Copy link
Collaborator Author

🎉 This PR is included in version 4.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@Relequestual
Copy link
Contributor

What's meant by "schemas are no longer validated"?
Is this in relation to #100 ?

@trieloff
Copy link
Collaborator Author

We used to have a dependency to ajv and used ajv to validate the schemas before we would even try to generate documentation. This brought a couple of drawbacks like:

  • additional dependencies
  • additional processing time
  • you needed to specify the JSON Schema version you were using

for very little benefit.

In order to implement #100 and generate the list of supported and unsupported keywords (https://github.com/adobe/jsonschema2md/blob/master/schemasupport.md) I've tagged every use of a keyword in the code with keyword and wrote a test that compares the keywords that have been used against the keywords that are mentioned in the spec. This does not rely on schema validation at all.

@Relequestual
Copy link
Contributor

I hadn't realised you had made the jump to draft 2019-09! Very exciting!
From previous discussions and this, I think what you've developed would be a great candidate for creating a vocabulary.
Obviously it's a little tricky to create and test out addtional vocabulaires with so few implementations, but they will come. =]
You have my email. Feel free to reach out should you want any feedback or sounding board for ideas!

@tripodsan tripodsan deleted the v2-rewrite branch March 25, 2024 11:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
3 participants