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

Update to the build libs JSDoc #2320

Merged
merged 19 commits into from
Jan 17, 2020
Merged

Update to the build libs JSDoc #2320

merged 19 commits into from
Jan 17, 2020

Conversation

jeffposnick
Copy link
Contributor

R: @philipwalton

This updates the JSDocs for the workbox-build and workbox-webpack-plugin public interfaces to match what's supported in v5.

I am not 100% sure how JSDoc with that many options will look when rendered in our HTML, so it might need to be tweaked further prior to official publication. But... it should be accurate, at least!

@coveralls
Copy link

Coverage Status

Coverage remained the same at 79.433% when pulling 2fc7993 on jsdoc-for-build-libs into a5b983a on master.

@jeffposnick
Copy link
Contributor Author

(This will need to be updated to use allow/deny following #2325)

@philipwalton
Copy link
Member

Have you run gulp docs or gulp docs --pretty locally to see the output? I've found that to be a pretty good representations of what the final output will be most of the time.

@jeffposnick
Copy link
Contributor Author

Yeah, I have. It's a big table, but I'm not exactly sure how much horizontal width it will end up needing until seeing how it looks staged on d.g.c.

packages/workbox-build/src/_types.js Outdated Show resolved Hide resolved
packages/workbox-webpack-plugin/src/generate-sw.js Outdated Show resolved Hide resolved
packages/workbox-webpack-plugin/src/inject-manifest.js Outdated Show resolved Hide resolved
packages/workbox-webpack-plugin/src/inject-manifest.js Outdated Show resolved Hide resolved
@philipwalton
Copy link
Member

philipwalton commented Jan 13, 2020

Right. Now I'm remembering that when I made my JSDoc changes, I modified the WebFu gulp tasks to pull in my local Workbox changes rather than from the remote, so I could see what it would actually look like staged. But now I've reverted those changes, so I can't really share them.

Probably worth updating the gulp workbox task to support a local option to make this easier in the future.

@workbox-pr-bot
Copy link
Collaborator

PR-Bot Size Plugin

Changed File Sizes

File Before After Change GZipped
packages/workbox-build/build/generate-sw.js 2.75 KB 12.17 KB +343% 4.36 KB ☠️
packages/workbox-build/build/get-manifest.js 1.60 KB 5.50 KB +244% 2.28 KB ☠️
packages/workbox-build/build/inject-manifest.js 5.01 KB 9.50 KB +89% 3.49 KB ☠️
packages/workbox-webpack-plugin/build/generate-sw.js 4.73 KB 13.63 KB +188% 4.56 KB ☠️
packages/workbox-webpack-plugin/build/inject-manifest.js 6.76 KB 10.71 KB +58% 3.52 KB ☠️

New Files

No new files have been added.

All File Sizes

View Table
File Before After Change GZipped
packages/workbox-background-sync/build/workbox-background-sync.prod.js 3.87 KB 3.87 KB 0% 1.60 KB
packages/workbox-broadcast-update/build/workbox-broadcast-update.prod.js 1.33 KB 1.33 KB 0% 736 B
packages/workbox-build/build/_types.js 41 B 41 B 0% 61 B
packages/workbox-build/build/generate-sw.js 2.75 KB 12.17 KB +343% 4.36 KB ☠️
packages/workbox-build/build/get-manifest.js 1.60 KB 5.50 KB +244% 2.28 KB ☠️
packages/workbox-build/build/index.js 613 B 613 B 0% 344 B
packages/workbox-build/build/inject-manifest.js 5.01 KB 9.50 KB +89% 3.49 KB ☠️
packages/workbox-cacheable-response/build/workbox-cacheable-response.prod.js 608 B 608 B 0% 355 B
packages/workbox-cli/build/app.js 4.16 KB 4.16 KB 0% 1.64 KB
packages/workbox-cli/build/bin.js 940 B 940 B 0% 502 B
packages/workbox-core/build/workbox-core.prod.js 6.91 KB 6.91 KB 0% 2.85 KB
packages/workbox-expiration/build/workbox-expiration.prod.js 3.01 KB 3.01 KB 0% 1.30 KB
packages/workbox-google-analytics/build/workbox-offline-ga.prod.js 1.97 KB 1.97 KB 0% 914 B
packages/workbox-navigation-preload/build/workbox-navigation-preload.prod.js 657 B 657 B 0% 321 B
packages/workbox-precaching/build/workbox-precaching.prod.js 5.71 KB 5.71 KB 0% 2.15 KB
packages/workbox-range-requests/build/workbox-range-requests.prod.js 1.63 KB 1.63 KB 0% 807 B
packages/workbox-routing/build/workbox-routing.prod.js 3.11 KB 3.11 KB 0% 1.35 KB
packages/workbox-strategies/build/workbox-strategies.prod.js 3.97 KB 3.97 KB 0% 1.04 KB
packages/workbox-streams/build/workbox-streams.prod.js 1.44 KB 1.44 KB 0% 697 B
packages/workbox-sw/build/workbox-sw.js 1.34 KB 1.34 KB 0% 745 B
packages/workbox-webpack-plugin/build/generate-sw.js 4.73 KB 13.63 KB +188% 4.56 KB ☠️
packages/workbox-webpack-plugin/build/index.js 392 B 392 B 0% 283 B
packages/workbox-webpack-plugin/build/inject-manifest.js 6.76 KB 10.71 KB +58% 3.52 KB ☠️
packages/workbox-window/build/workbox-window.dev.umd.js 42.33 KB 42.33 KB 0% 9.44 KB
packages/workbox-window/build/workbox-window.prod.umd.js 4.54 KB 4.54 KB 0% 1.85 KB

Workbox Aggregate Size Plugin

2.96KB gzip'ed (20% of limit)
5.9KB uncompressed

@philipwalton philipwalton merged commit 433b515 into master Jan 17, 2020
@philipwalton philipwalton deleted the jsdoc-for-build-libs branch January 17, 2020 00:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants