workbox / Tickets / #2320 Update to the build libs JSDoc

#2320 Update to the build libs JSDoc

Status: closed

Owner: nobody

Labels: None

Updated: 2020-01-17

Created: 2020-01-09

Creator: Anonymous

Private: No

Originally created by: jeffposnick

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!

Anonymous - 2020-01-09

Originally posted by: coveralls

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

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Anonymous - 2020-01-13

Originally posted by: jeffposnick

(This will need to be updated to use allow/deny following https://github.com/GoogleChrome/workbox/pull/2325)

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Anonymous - 2020-01-13

Originally posted by: philipwalton

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.

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Anonymous - 2020-01-13

Originally posted by: jeffposnick

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.

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Anonymous - 2020-01-13

Originally posted by: philipwalton

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.

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Originally posted by: workbox-pr-bot

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

Anonymous - 2020-01-17

Ticket changed by: philipwalton

status: open --> closed
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Update to the build libs JSDoc

Milestone

Searches

Help