adobe / adobe/structured-data-validator
Feature Request: Add validators for LocalBusiness, Article, Event, FAQPage, and other common types, and child schema validation
- Lingua principale
- JavaScript
- Stelle
- 15
- Fork
- 3
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
## Summary
The library currently returns zero validation errors for several commonly-used schema.org types that Google Rich Results actively supports, including `LocalBusiness`, `Article`, `Event`, `FAQPage`, `HowTo`, `WebSite`, and `WebPage`.
## Reproduction
```javascript
const testData = {
jsonld: {
LocalBusiness: [{
'@type': 'LocalBusiness'
// Missing required fields: name, address, etc.
}]
},
microdata: {},
rdfa: {},
errors: []
};
const issues = await validator.validate(testData);
console.log(issues.length); // 0 — No errors reported
```
## Expected Behavior
The validator should report missing required fields per [Google's structured data guidelines](https://developers.google.com/search/docs/appearance/structured-data).
For example, `LocalBusiness` should validate:
**Required:**
- `name`
- `address` (PostalAddress object)
**Recommended:**
- `telephone`
- `openingHoursSpecification`
- `geo` (GeoCoordinates)
- `image`
- `priceRange`
## Schema Types Affected
| Type | Google Rich Results Page |
|------|--------------------------|
| LocalBusiness | [docs](https://developers.google.com/search/docs/appearance/structured-data/local-business) |
| Article | [docs](https://developers.google.com/search/docs/appearance/structured-data/article) |
| Event | [docs](https://developers.google.com/search/docs/appearance/structured-data/event) |
| FAQPage | [docs](https://developers.google.com/search/docs/appearance/structured-data/faqpage) |
| HowTo | [docs](https://developers.google.com/search/docs/appearance/structured-data/how-to) |
| WebSite | [docs](https://developers.google.com/search/docs/appearance/structured-data/sitelinks-searchbox) |
| WebPage | Part of various structured data types |
## Impact
Users may believe their structured data is valid when critical fields are missing, leading to:
- Failed rich result eligibility in Google Search
- Poor SEO outcomes
- Confusion when Google Search Console reports errors that this validator missed
## Proposed Solution
Add validator classes for the missing types following the existing pattern. Example:
```javascript
// src/types/LocalBusiness.js
import BaseValidator from './base.js';
export default class LocalBusinessValidator extends BaseValidator {
getConditions() {
return [
this.required('name'),
this.required('address', 'object'),
this.recommended('telephone'),
this.recommended('openingHoursSpecification', 'array'),
this.recommended('geo', 'object'),
this.recommended('image', 'url'),
this.recommended('priceRange'),
].map((c) => c.bind(this));
}
}
```
Then register in `src/Validator.js`:
```javascript
this.registeredHandlers = {
// ... existing handlers
LocalBusiness: [() => import('./types/LocalBusiness.js')],
};
```
### Problem: Subtypes are not validated
Currently, if a schema uses a subtype like `Restaurant`, `NewsArticle`, or `MusicEvent`, the validator returns **zero errors** even when required fields are missing.
**Example:**
const data = {
jsonld: {
Restaurant: [{
'@type': 'Restaurant'
// Missing name, address - but no errors reported!
}]
},
microdata: {},
rdfa: {},
errors: []
};
const issues = await validator.validate(data);
console.log(issues.length); // 0 — No validation!
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Esamina le classi validator esistenti e il pattern di registrazione in src/Validator.js, quindi confronta i requisiti elencati per i dati strutturati di Google con i tipi interessati. Usa l’esempio LocalBusiness come punto di partenza e verifica che gli input dei sottotipi come Restaurant, NewsArticle e MusicEvent non passino più senza validazione. Il lavoro è completato quando i tipi supportati segnalano i campi obbligatori mancanti e rappresentano i campi consigliati come richiesto.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript
- Ambito
- tooling
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 30/100