structured-data-testing-tool/examples/test-url.js

A library and command line tool to help test for Structured Data.

// Basic example of how to test a URL with the API
const { structuredDataTest } = require('structured-data-testing-tool')
const { Google, Twitter, Facebook } = require('structured-data-testing-tool/presets')

const url = 'https://www.bbc.co.uk/news/world-us-canada-49060410'
 
let result

structuredDataTest(url, { 
  // Check for compliance with Google, Twitter and Facebook recommendations
  presets: [ Google, Twitter, Facebook ],
  // Check the page includes a specific Schema (see https://schema.org/docs/full.html for a list)
  schemas: [ 'ReportageNewsArticle' ]
})
.then(res => {
  result = res
  console.log('✅ All tests passed!')
})
.catch(err => {
  if (err.type === 'VALIDATION_FAILED') {
    result = err.res
    console.log('❌ Some tests failed.')
    console.log("⚠️  Errors:\n", result.failed.map(test => test))
  } else {
    console.error(err) // Handle other errors here (e.g. an error fetching a URL)
  }
})
.finally(() => {
  if (result) {
    console.log(
      `Passed: ${result.passed.length},`,
      `Failed: ${result.failed.length},`,
      `Warnings: ${result.warnings.length}`,
    )
    console.log(`Schemas found: ${result.schemas.join(',')}`)
  }
})