npmpackage.info

amphtml-validator

The AMP web component framework.

1.0.38

14,895

Apache-2.0

JavaScript

17.27 kB

29,202,250 8.6

Installations

npm install amphtml-validator

Developer Guide

BETA

Typescript

No

Module System

N/A

Node Version

20.11.0

NPM Version

10.3.0 Score

95.6

Supply Chain

99.5

Quality

78.2

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

77

Total

25,628

Closed

4,891

Merged

20,660

Issues

Open

901

Total

14,345

Closed

13,444

Releases

847

2501101900000

Published on 14 Jan 2025

2410292120000

Published on 05 Nov 2024

2410250306000

Published on 29 Oct 2024

2410161801000

Published on 22 Oct 2024

2410081535000

Published on 15 Oct 2024

2410031633000

Published on 08 Oct 2024

View all 847 releases

Contributors

1,175

View all 1,175 contributors

Languages

JavaScript

HTML

C++

CSS

TypeScript

Python

Starlark

Yacc

Shell

JavaScript (79.92%)

HTML (9.11%)

C++ (7.54%)

CSS (2.22%)

TypeScript (0.55%)

Python (0.28%)

Starlark (0.15%)

Yacc (0.12%)

Shell (0.08%)

Go (0.03%)

Developer

ampproject

Download Statistics

Total Downloads

29,202,250

Last Day

1,571

Last Week

10,452

Last Month

95,957

Last Year

1,681,786

GitHub Statistics

14,895 Stars

22,542 Commits

3,894 Forks

632 Watching

166 Branches

1,175 Contributors

Bundle Size

54.26 kB

Minified

17.27 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

1.0.38

Package Id

amphtml-validator@1.0.38

Unpacked Size

30.75 kB

Size

8.61 kB

File Count

NPM Version

10.3.0

Node Version

20.11.0

Publised On

02 Apr 2024

Total Downloads

Cumulative downloads

Total Downloads

29,202,250

Last day

-19.5%

1,571

Compared to previous day

Last week

-50.1%

10,452

Compared to previous week

Last month

-20.2%

95,957

Compared to previous month

Last year

-34.6%

1,681,786

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

colors commander promise

Dev Dependencies

jasmine

Versions

amphtml-validator Node.js Package

This package is published and available at https://www.npmjs.com/package/amphtml-validator.

The source code is available at https://github.com/ampproject/amphtml/tree/main/validator/js/nodejs.

Command Line Tool

The amphtml-validator command line tool is documented here: https://amp.dev/documentation/guides-and-tutorials/learn/validation-workflow/validate_amp#command-line-tool

Node.js API

This API is new - feedback is especially welcome.

To install, use npm install amphtml-validator in your project directory, or add amphtml-validator as a dependency to your package.json.

You may save the following example into a file, e.g., demo.js.

1'use strict';
2var amphtmlValidator = require('amphtml-validator');
3
4amphtmlValidator.getInstance().then(function (validator) {
5  var result = validator.validateString('<html>Hello, world.</html>');
6  (result.status === 'PASS' ? console.log : console.error)(result.status);
7  for (var ii = 0; ii < result.errors.length; ii++) {
8    var error = result.errors[ii];
9    var msg =
10      'line ' + error.line + ', col ' + error.col + ': ' + error.message;
11    if (error.specUrl !== null) {
12      msg += ' (see ' + error.specUrl + ')';
13    }
14    (error.severity === 'ERROR' ? console.error : console.warn)(msg);
15  }
16});

Now try running it:

1$ node demo.js
2FAIL
3line 1, col 0: The mandatory attribute '⚡' is missing in tag 'html ⚡ for top-level html'. (see https://amp.dev/documentation/guides-and-tutorials/learn/spec/amphtml#required-markup)
4line 1, col 0: The parent tag of tag 'html ⚡ for top-level html' is '$root', but it can only be '!doctype'. (see https://amp.dev/documentation/guides-and-tutorials/learn/spec/amphtml.html#required-markup)
5...

As expected, this emits errors because the provided string in the example, <html>Hello, world.</html> is not a valid AMP HTML document.

The method validateString also takes a htmlFormat parameter which would allow applying the validator rules for AMP4ADS or AMP4EMAIL as well. `validateString(inputString, htmlFormat).

1/**
2 * Validates the provided inputString; the htmlFormat can be 'AMP' or
3 * 'AMP4ADS'; it defaults to 'AMP' if not specified.
4 * @param {string} inputString
5 * @param {string=} htmlFormat
6 * @return {!ValidationResult}
7 * @export
8 */

Release Notes

1.0.35

Set default engine to the WebAssembly version validator, which is https://cdn.ampproject.org/v0/validator_wasm.js. ampproject/amphtml #34213

1.0.34

Updated colors dependency version (ampproject/amphtml #31656).

1.0.33

Update repository location.

1.0.32

Removal of AMP Actions format as it is deprecated.

1.0.31

Fix Node API on Node > 12

1.0.30

Remove engine section from package.json to allow any version of nodejs.

1.0.29

Reintroduce node v8 support. Supports node v8, v10, v12 and v14.

1.0.28

Reintroduce node v10 support and introduce node v14 support.

1.0.27

Removed references to amp.validator.categorizeError.

1.0.26

Introduce node v12 support and remove node v10 support.

1.0.25

Broken release, removed.

1.0.24

Introduce node v10 support and remove node 8 support.

1.0.23

The amphtml-validator binary now requires the Node.js binary to be called node. On systems where the Node.js binary is called nodejs, consider installing the nodejs-legacy Debian package or better yet, NVM.

1.0.22

--html_format=AMP4EMAIL added.

1.0.21

--html_format=AMP4ADS is no longer experimental.

1.0.20

Better npm post-install for virtual machines, running debian over windows with SMB shared folder.

1.0.19

Set correct process exit status for old versions of Node.js (v0.10.25).

1.0.18

Small tweaks to this file and package.json.

1.0.17

If the amphtml-validator command is already patched up for Windows, leave it alone instead of failing. Relevant if the package has been installed globally and now we're performing a local install on top of it.

1.0.16

npm install amphtml-validator (local install) should now work on Windows, for require('amphtml-validator').

1.0.15

Added support for installing on Windows. npm install -g amphtml-validator should now just work.

1.0.13

Added newInstance method, a simple API that's not async.

1.0.12

Added support for --user-agent option.

1.0.11

Added support for AMP4ADS (via --html_format command line flag) and argument for validateString function in the API.

1.0.10

Fixed #4246: amphtml-validator CLI fails on Mac OS X.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

CI-Tests

Determines if the project runs tests before pull requests are merged.

10

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

10

Contributors

Determines if the project has a set of contributors from multiple organizations (e.g., companies).

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Dependency-Update-Tool

Determines if the project uses a dependency update tool.

10

Fuzzing

Determines if the project uses fuzzing.

10

License

Determines if the project has defined a license.

10

Maintained

Determines if the project is "actively maintained".

10

SAST

Determines if the project uses static code analysis.

10

Security-Policy

Determines if the project has published a security policy.

10

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

8

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

8

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

8.6

/10

Last Scanned on 2025-01-14T21:49:04Z

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to amphtml-validator

@types/amphtml-validator

1.0.4

TypeScript definitions for amphtml-validator

amphtml-validator-extra

0.1.6

Enhanced package of amphtml-validator.

gulp-amphtml-validator

1.0.8

Gulp plugin for the official AMP HTML validator (www.ampproject.org)

amphtml-validator-rules

3.0.0

Get all the rules that the `amphtml-validator` uses.