PWABuilder: Shared Web Manifest Validation Library

[jgw96]

Continuing Conversation, things WILL change as we continue

• @Jaylyn-Barbee
• @jgw96
• @nmetulev
• @amrutha95

General notes

• Do it right
• Take our time
• Unit test
• Need to be able to explain the what and why of a validation. Example: Why does a user need to have a background_color, and why does it need to be a hex code.

Types:

• Shared, single source of truth for all interfaces: link to existing code to be ported

Methods / Usage:

• validateManifest() / store-ready: validates the entire manifest.
  • Return for site: Array<{ fieldName: string, valid: boolean, classification: "required" | "recommended"| "optional", errorString?: string | undefined}>
• validateSingleField(): validates a single field.
  • Return for site: { fieldName: string, valid: boolean, classification: "required" | "recommended"| "optional", errorString?: string | undefined}
• validateRequiredFields() / fastpass: validate the entire manifest and only return info on required fields.
  • Same as validateWholeManifest but only required fields
• validateImprovements(): returns validations on suggested and optional fields

Scoring

• How do we score?
• More guidance, less gamey
• Less "top score" type things, such as the rating dial
• Do we need a "top score" at all? Can it just be "do have or don't have"?
• Diagnostics report fueled by our docs
• Teach a person how to fish, they will eat forever
• Should still be tweetable

Utils Methods:

• isStoreReady():
  • Return: { ready: boolean, problems: Array<{ fieldName: string, valid: boolean, classification: "required" | "recommended"| "optional", errorString?: string | undefined}> | Array[] }
• isInstallReady(): ready: boolean

Open Questions / Future questions:

• Should we validate service workers too? And what should we even validate in that case?
• Should this just be a PWA validation library? Not a web manifest specific one
• Can we allow our users to trigger these functions themselves? Basically a built in validate button that runs validations, including improvements. Kinda like the validate command in PWA Studio
• Should we return