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.

Sign up for GitHub

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

Jump to bottom

core(config): add new PWA category groups #6396

Merged
merged 8 commits into from
Oct 26, 2018
Merged

core(config): add new PWA category groups #6396

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
54a9248
core(config): add new PWA category groups
brendankenny Oct 25, 2018
2b65d5e
delete descriptions
brendankenny Oct 25, 2018
5d42c27
sample and snapshot
brendankenny Oct 25, 2018
0787f2c
proto and renderer test
brendankenny Oct 26, 2018
ee999ca
feedback
brendankenny Oct 26, 2018
a57facf
snapshot
brendankenny Oct 26, 2018
37ee91d
desc
brendankenny Oct 26, 2018
e6efeed
jsonprotosnap
brendankenny Oct 26, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 42 additions & 20 deletions lighthouse-cli/test/cli/__snapshots__/index-test.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,6 @@ Object {
Object {
"path": "themed-omnibox",
},
Object {
"path": "manifest-short-name-length",
},
Object {
"path": "content-width",
},
Expand Down Expand Up @@ -814,52 +811,59 @@ Object {
"pwa": Object {
"auditRefs": Array [
Object {
"group": "pwa-fast-reliable",
"id": "load-fast-enough-for-pwa",
"weight": 7,
},
Object {
"group": "pwa-fast-reliable",
"id": "works-offline",
"weight": 5,
},
Object {
"id": "webapp-install-banner",
"weight": 3,
},
Object {
"group": "pwa-installable",
"id": "is-on-https",
"weight": 2,
},
Object {
"id": "redirects-http",
"weight": 2,
},
Object {
"id": "viewport",
"weight": 2,
},
Object {
"group": "pwa-installable",
"id": "service-worker",
"weight": 1,
},
Object {
"id": "without-javascript",
"weight": 1,
"group": "pwa-installable",
"id": "webapp-install-banner",
"weight": 3,
},
Object {
"group": "pwa-engaging",
"id": "redirects-http",
"weight": 2,
},
Object {
"group": "pwa-engaging",
"id": "splash-screen",
"weight": 1,
},
Object {
"group": "pwa-engaging",
"id": "themed-omnibox",
"weight": 1,
},
Object {
"group": "pwa-engaging",
"id": "content-width",
"weight": 1,
},
Object {
"id": "manifest-short-name-length",
"weight": 0,
"group": "pwa-engaging",
"id": "viewport",
"weight": 2,
},
Object {
"group": "pwa-engaging",
"id": "without-javascript",
"weight": 1,
},
Object {
"id": "pwa-cross-browser",
Expand All @@ -874,7 +878,7 @@ Object {
"weight": 0,
},
],
"description": "These checks validate the aspects of a Progressive Web App, as specified by the baseline [PWA Checklist](https://developers.google.com/web/progressive-web-apps/checklist).",
"description": "These checks validate the aspects of a Progressive Web App. [Learn more](https://developers.google.com/web/progressive-web-apps/checklist).",
"manualDescription": "These checks are required by the baseline [PWA Checklist](https://developers.google.com/web/progressive-web-apps/checklist) but are not automatically checked by Lighthouse. They do not affect your score but it's important that you verify them manually.",
"title": "Progressive Web App",
},
Expand Down Expand Up @@ -993,6 +997,15 @@ Object {
"metrics": Object {
"title": "Metrics",
},
"pwa-engaging": Object {
"title": "Engaging",
},
"pwa-fast-reliable": Object {
"title": "Fast and reliable",
},
"pwa-installable": Object {
"title": "Installable",
},
"seo-content": Object {
"description": "Format your HTML in a way that enables crawlers to better understand your app’s content.",
"title": "Content Best Practices",
Expand Down Expand Up @@ -1245,6 +1258,15 @@ Object {
"metrics": Object {
"title": "Metrics",
},
"pwa-engaging": Object {
"title": "Engaging",
},
"pwa-fast-reliable": Object {
"title": "Fast and reliable",
},
"pwa-installable": Object {
"title": "Installable",
},
"seo-content": Object {
"description": "Format your HTML in a way that enables crawlers to better understand your app’s content.",
"title": "Content Best Practices",
Expand Down
66 changes: 0 additions & 66 deletions lighthouse-core/audits/manifest-short-name-length.js
View file
Open in desktop

This file was deleted.

48 changes: 30 additions & 18 deletions lighthouse-core/config/default-config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,12 @@ const UIStrings = {
diagnosticsGroupTitle: 'Diagnostics',
/** Description of the diagnostics section of the Performance category. Within this section are audits with non-imperative titles that provide more detail on the page's page load performance characteristics. Whereas the 'Opportunities' suggest an action along with expected time savings, diagnostics do not. Within this section, the user may read the details and deduce additional actions they could take. */
diagnosticsGroupDescription: 'More information about the performance of your application.',
/** Title of the Fast and Reliable section of the web app category. Within this section are audits that check if the web site loaded quickly and can reliably load even if the internet connection is very slow or goes offline. */
pwaFastReliableGroupTitle: 'Fast and reliable',
/** Title of the Installable section of the web app category. Within this section are audits that check if Chrome supports installing the web site as an app on their device. */
pwaInstallableGroupTitle: 'Installable',
/** Title of the Engaging section of the web app category. Within this section are audits that check if the developer has taken advantage of features to make their web page more enjoyable and engaging for the user. */
pwaEngagingGroupTitle: 'Engaging',
};

const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
Expand Down Expand Up @@ -116,7 +122,6 @@ const defaultConfig = {
'webapp-install-banner',
'splash-screen',
'themed-omnibox',
'manifest-short-name-length',
'content-width',
'image-aspect-ratio',
'deprecations',
Expand Down Expand Up @@ -225,6 +230,15 @@ const defaultConfig = {
title: str_(UIStrings.diagnosticsGroupTitle),
description: str_(UIStrings.diagnosticsGroupDescription),
},
'pwa-fast-reliable': {
title: str_(UIStrings.pwaFastReliableGroupTitle),
},
'pwa-installable': {
title: str_(UIStrings.pwaInstallableGroupTitle),
},
'pwa-engaging': {
title: str_(UIStrings.pwaEngagingGroupTitle),
},
'a11y-color-contrast': {
title: 'Color Contrast Is Satisfactory',
description: 'These are opportunities to improve the legibility of your content.',
Expand Down Expand Up @@ -312,27 +326,25 @@ const defaultConfig = {
},
'pwa': {
title: 'Progressive Web App',
description: 'These checks validate the aspects of a Progressive Web App, as specified by the baseline [PWA Checklist](https://developers.google.com/web/progressive-web-apps/checklist).',
description: 'These checks validate the aspects of a Progressive Web App. [Learn more](https://developers.google.com/web/progressive-web-apps/checklist).',
manualDescription: 'These checks are required by the baseline ' +
'[PWA Checklist](https://developers.google.com/web/progressive-web-apps/checklist) but are ' +
'not automatically checked by Lighthouse. They do not affect your score but it\'s important that you verify them manually.',
auditRefs: [
// Most difficult and critical for good UX
{id: 'load-fast-enough-for-pwa', weight: 7}, // can't be green in the category without being fast
{id: 'works-offline', weight: 5},
// Encompasses most of the other checks
{id: 'webapp-install-banner', weight: 3},
// Important but not too difficult
{id: 'is-on-https', weight: 2},
{id: 'redirects-http', weight: 2},
{id: 'viewport', weight: 2},
// Relatively easy checkboxes to tick with minimal value on their own
{id: 'service-worker', weight: 1},
{id: 'without-javascript', weight: 1},
{id: 'splash-screen', weight: 1},
{id: 'themed-omnibox', weight: 1},
{id: 'content-width', weight: 1},
{id: 'manifest-short-name-length', weight: 0},
// Fast and Reliable
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hey this lines up exactly with "most difficult and critical for good UX" :D

do we need to re-order the lines? it lined up with "fast" and then "reliable" already ;)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need to re-order the lines?

We don't need to, but since this will end up being a pretty big change in the html report, it seems better to have them in the same order

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh, ha, nm, I see what you mean. SGTM :)

{id: 'load-fast-enough-for-pwa', weight: 7, group: 'pwa-fast-reliable'},
{id: 'works-offline', weight: 5, group: 'pwa-fast-reliable'},
// Installable
{id: 'is-on-https', weight: 2, group: 'pwa-installable'},
{id: 'service-worker', weight: 1, group: 'pwa-installable'},
{id: 'webapp-install-banner', weight: 3, group: 'pwa-installable'},
// Engaging
{id: 'redirects-http', weight: 2, group: 'pwa-engaging'},
{id: 'splash-screen', weight: 1, group: 'pwa-engaging'},
{id: 'themed-omnibox', weight: 1, group: 'pwa-engaging'},
{id: 'content-width', weight: 1, group: 'pwa-engaging'},
{id: 'viewport', weight: 2, group: 'pwa-engaging'},
{id: 'without-javascript', weight: 1, group: 'pwa-engaging'},
// Manual audits
{id: 'pwa-cross-browser', weight: 0},
{id: 'pwa-page-transitions', weight: 0},
Expand Down
12 changes: 12 additions & 0 deletions lighthouse-core/lib/i18n/en-US.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -383,6 +383,18 @@
"message": "Performance",
"description": "Title of the Performance category of audits. Equivalent to 'Web performance', this term is inclusive of all web page speed and loading optimization topics. Also used as a label of a score gauge; try to limit to 20 characters."
},
"lighthouse-core/config/default-config.js | pwaEngagingGroupTitle": {
"message": "Engaging",
"description": "Title of the Engaging section of the web app category. Within this section are audits that check if the developer has taken advantage of features to make their web page more enjoyable and engaging for the user."
},
"lighthouse-core/config/default-config.js | pwaFastReliableGroupTitle": {
"message": "Fast and reliable",
"description": "Title of the Fast and Reliable section of the web app category. Within this section are audits that check if the web site loaded quickly and can reliably load even if the internet connection is very slow or goes offline."
},
"lighthouse-core/config/default-config.js | pwaInstallableGroupTitle": {
"message": "Installable",
"description": "Title of the Installable section of the web app category. Within this section are audits that check if Chrome supports installing the web site as an app on their device."
},
"lighthouse-core/lib/i18n/i18n.js | columnCacheTTL": {
"message": "Cache TTL",
"description": "Label for the TTL column in data tables, entries will be the time to live value of the cache header on a web resource"
Expand Down
94 changes: 0 additions & 94 deletions lighthouse-core/test/audits/manifest-short-name-length-test.js
View file
Open in desktop

This file was deleted.

4 changes: 2 additions & 2 deletions lighthouse-core/test/report/html/renderer/category-renderer-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,8 +238,8 @@ describe('CategoryRenderer', () => {
const category = JSON.parse(JSON.stringify(origCategory));
category.auditRefs.forEach(audit => audit.result.score = 0);
const elem = renderer.render(category, sampleResults.categoryGroups);
const passedAudits = elem.querySelectorAll('.lh-passed-audits > .lh-audit');
const failedAudits = elem.querySelectorAll('.lh-failed-audits > .lh-audit');
const passedAudits = elem.querySelectorAll('.lh-passed-audits .lh-audit');
const failedAudits = elem.querySelectorAll('.lh-failed-audits .lh-audit');

assert.equal(passedAudits.length, 0);
assert.equal(failedAudits.length, 11);
Expand Down
Loading