Start metadata updates from our mailing list discussion #830
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Namely move to:
"notes": []
and
"warnings" : []
Right now I have complex objects going into
notes
so it can be a link and a description of what that link is. I'd imagine we can just test:if (typeof notes[i] == 'string')
and handle regular notes that way too, so only go complex if it's a link.I also added a
doc
parser. Write markdown inside of a comment that looks like this:That gets parsed out and converted to html and put in the
doc
property of the metadata.I also have a line commented out that will remove the metadata and docs and then convert the actual code to syntax highlighted html. I figured we could do this entirely client side though, so it's commented out for now.
I also added the field
caniuse
-- so we can directly relate tests back to the caniuse api or embeds. So when you add a test, see if it has a corresponding caniuse id and put it in the metadata.would probably be the easiest integration for launch, but we could even build our own little UI from the api if we wanted.
LASTLY,
I parse out the dependencies that each test has so we can implement the feature in the builder that auto-selects dependencies. In the new one, though, I think it'd be better to have 3-state checkboxes. Selected, Depended-On, Off. The URL would only reflect the 'selected' group, so if a dependency changes in a future version, you don't have cruft for no reason.
Might merge if I get too far tonight, but happy for a little review. Code is likely fine, but I'm sure there's some discussion to be had on the comment thingy that delimits docs.
I'll begin porting docs and stuff tonight/tomorrow as well.