Permalink
Switch branches/tags
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
112 lines (84 sloc) 3.92 KB

AMP HTML ⚡ Validator

A validator for the AMP HTML format.

If you just want to validate a page, please see our documentation over at ampproject.org.

Chrome Extension

Please see chromeextension/README.md.

Command Line Tool and Node.js API

Please see nodejs/README.md.

Web UI

Please see webui/README.md.

Building a Custom Validator

This is only useful for development - e.g. when making changes to engine/validator.js or when authoring an AMP extension, and it's rough around the edges. Below are instructions for Linux Ubuntu 14.

Installation

Linux

Install these packages using apt-get:

  • npm
  • openjdk-7-jre
  • protobuf-compiler
  • python-protobuf
  • python2.7

In addition, install Node.js v4.4.2. E.g., by downloading or by using a package manager or by using NVM.

OSX

Dependencies:

  • npm
  • python 2.7 (should already be installed on OSX)
  • homebrew
    • protobuf

      brew install protobuf
      mkdir -p /Users/USERNAME/Library/Python/2.7/lib/python/site-packages
      echo 'import site; site.addsitedir("/usr/local/lib/python2.7/site-packages")' >> /Users/USERNAME/Library/Python/2.7/lib/python/site-packages/homebrew.pth
    • openjdk-7-jre

      brew tap caskroom/cask
      brew install Caskroom/cask/java

Usage

Then, run build.py. This creates dist/validator_minified.js, which is equivalent to the validator deployed at cdn.ampproject.org. You may now use the --validator_js command line flag to amphtml-validator to use this validator.

$ amphtml-validator --validator_js dist/validator_minified.js testdata/feature_tests/several_errors.html
testdata/feature_tests/several_errors.html:23:2 The attribute 'charset' may not appear in tag 'meta name= and content='.
testdata/feature_tests/several_errors.html:26:2 The tag 'script' is disallowed except in specific forms.
testdata/feature_tests/several_errors.html:32:2 The mandatory attribute 'height' is missing in tag 'amp-img'. (see https://www.ampproject.org/docs/reference/amp-img.html)
testdata/feature_tests/several_errors.html:34:2 The attribute 'width' in tag 'amp-ad' is set to the invalid value '100%'. (see https://www.ampproject.org/docs/reference/amp-ad.html)
...

Building on MacOS

  • Download protobuf with brew install protobuf via homebrew.
  • Use pip to pip install google and pip install protobuf. If you don't have pip, you can get it either via brew install python or get-pip.py.
  • If your npm is out of date, run npm i -g npm to update it.

To verify that you have the necessary prerequisites, run and verify:

$ protoc --version
libprotoc 3.5.1

and

$ python
>>> import google.protobuf
>>>

Now cd amphtml/validator and run python build.py.