Adds basic WebRTC types and cleans up build scripts #7
Conversation
This build directory made no sense to me. It was requiring a non existent file and writing to an un-used/ un-exported file. Also the source file was not exported or used anywhere that I could see. To make building better I made the following changes: - rename the `build` directory to `scripts` as `build` is misleading - remove the file `source.json` - propagate the last pull request #4 to the build script - add an npm command to build `npm run build` Now running `npm run build` will use the file `globals-docs.json` as its input and output file. To add more browser features just set a key to the feature name and the value to https://developer.mozilla.org and run `npm run build` to resolve the mozilla documentation and generate a new `globals-docs.json`
|
I went ahead and full refactored build to solve #5. All the SVG types resolve to documentation now, but there are still a few outliers like |
|
It is worth noting that this last commit changes the default value from and then run |
globals-docs.json
Outdated
| @@ -283,13 +290,13 @@ | |||
| "SVGAnimationElement": "https://developer.mozilla.org/docs/Web/API/SVGAnimationElement", | |||
| "SVGCircleElement": "https://developer.mozilla.org/docs/Web/API/SVGCircleElement", | |||
| "SVGClipPathElement": "https://developer.mozilla.org/docs/Web/API/SVGClipPathElement", | |||
| "SVGColor": "https://developer.mozilla.org/", | |||
| "SVGColor": "https://hacks.mozilla.org/2017/10/containers-for-add-on-developers/", | |||
There was a problem hiding this comment.
This one isn't quite right. Maybe it's time that we should just manually manage this list instead of relying on Google entirely for scrying the right URLs?
There was a problem hiding this comment.
It wouldn't be the end of the world... This is a bit more complete then what we have now anyway. Your call.
There was a problem hiding this comment.
👍 afaict no browser actually has a SVGColor global, so it should be fine to remove this line entirely
There was a problem hiding this comment.
patch incoming
.gitignore
Outdated
| @@ -0,0 +1,3 @@ | |||
| *.log | |||
There was a problem hiding this comment.
Mind keeping this out of the repo? I prefer to keep application-related logs in a global .gitignore
There was a problem hiding this comment.
Sure no problem. Give me a second.
There was a problem hiding this comment.
All set 👍
|
Thanks! How long before the changes will reflect in documentation.js? |
|
If you're installing with |
Hello, thanks for documentation.js. It's great and I use it everywhere.
I wanted to have my WebRTC types link to their respective mozilla documentations. After poking around I ended up here. When I cloned the repo I saw some things in the build chain that didn't quite make sense so I decided to tidy up. Please review my commits and make sure we are on the same page. Tests all pass,
npm run buildworks to add new browser features and WebRTC links are all correct.Thanks!