Installations

npm install super-xmlllint

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

14.7.0

NPM Version

6.14.7 Pull Requests

Open

0

Total

1

Closed

0

Merged

1

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

2

TypeScript

JavaScript

TypeScript (62.3%)

JavaScript (37.7%)

Developer

JaanTaponen

Download Statistics

Total Downloads

0

Last Day

0

Last Week

0

Last Month

0

Last Year

0

GitHub Statistics

1 Stars

24 Commits

2 Forks

1 Watchers

1 Branches

2 Contributors

Updated on Jun 10, 2021

Maintainers

1

View All 2 Contributors

Package Meta Information

Latest Version

1.0.6

Package Id

super-xmlllint@1.0.6

Unpacked Size

11.60 kB

Size

3.69 kB

File Count

8

NPM Version

6.14.7

Node Version

14.7.0

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

0%

NaN

Compared to previous day

Last Week

0%

NaN

Compared to previous week

Last Month

0%

NaN

Compared to previous month

Last Year

0%

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

9

@types/node chai chai-as-promised mocha nyc typescript eslint @typescript-eslint/eslint-plugin @typescript-eslint/parser

super-xmllint

Wrapper for xmllint. Easy validation of XML. XML Schemas and DTDs supported. c14n, c14n11 and c14n-exc canoncalization.

Zero dependencies.

Fork from project validate-with-xmllint

Features

Validate schemaless XML file 👉 function validateXML(input: string | Buffer): Promise<xmllintOutput>
Validate with DTDs 👉 function validateXMLWithDTD(input: string | Buffer): Promise<xmllintOutput>
Validate with XML Schemas (XSD) 👉 function validateXMLWithXSD(input: string | Buffer, xsdfile: string | Buffer): Promise<void>
Canonicalize XML with c14n, c14n11 or exc-c14n 👉 function canonicalizeXML(input: string | Buffer, method: 'c14n' | 'c14n11' | 'exc-c14n' = 'exc-c14n'): Promise<xmllintOutput>
Written in TypeScript
Tests with good coverage included
Zero NPM dependencies
Availability of xmllint is verified during installation time
No network connections used during validations

The interface of the xmllintOutput format is

  code: number,     // Returned status code
  command: string,  // Used command
  output: string    // Output data

Usage

Importing functions

1const {
2  validateXML,
3  validateXMLWithDTD,
4  validateXMLWithXSD,
5  canonicalizeXML
6} = require("validate-with-xmllint");

Demos of passing validations

All the examples below return promises which will eventually resolve.

1validateXML("<hello>world!</hello>");
2validateXML("<tiny/>");
3
4/**
5 * All referenced DTD's must be available locally as `xmllint`
6 * is invoked with `--nonet` which prevents network connections
7 **/
8validateXMLWithDTD(
9  `<?xml version="1.0" encoding="utf-8"?>
10    <!DOCTYPE root SYSTEM "./test/dtds/valid-dtd.dtd">
11    <root>
12        <body/>
13        <body/>
14    </root>`
15);
16
17/**
18 * Path to XSD Schema file must be provided with the document
19 **/
20validateXMLWithXSD(
21  `<?xml version="1.0"?>
22    <root>
23        <text>
24        DEMO
25        </text>
26        <body>
27            <name>foo</name>
28        </body>
29    </root>`,
30  "./test/xsds/valid-xsd.xsd"
31);

Demos of failing validations

All the examples below return promises which will eventually reject with the output from xmllint.

1validateXML("<open_tag_only>");
2validateXML("garbage");
3
4validateXMLWithDTD(
5  `<?xml version="1.0" encoding="utf-8"?>
6    <!DOCTYPE root SYSTEM "./test/dtds/valid-dtd.dtd">
7    <this>
8      Not allowed by the dtd!
9    </this>`
10);
11
12validateXMLWithXSD(
13  `<?xml version="1.0"?>
14    <root>
15        <something_unexpected_here/>
16    </root>`,
17  "./test/xsds/valid-xsd.xsd"
18);

See more demos within the tests.

FAQ

How to install xmllint?

You might already have it. Execute xmllint --version and see what it prints out.

On Debian distros look up libxml2-utils, on RedHat libxml2. A recent version of xmllint should be bundled by default on MacOS.

This pacakge runs a postinstall script to verify that you have xmllint available.

How to see the actual errors in my XML?

The promise is rejected with the error output from xmllint. The error contains all the available details. Expect to see something like this:

Error: xmllint exited with code 3 when executed with xmllint --schema /Users/aautio/foobar/validate-with-xmllint/test/xsds/valid-xsd.xsd --noout --nonet -:
-:2: element root: Schemas validity error : Element 'root': Missing child element(s). Expected is ( body ).
- fails to validate

No vulnerabilities found.

10

Binary-Artifacts

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

0

Code-Review

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

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

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

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

License

Determines if the project has defined a license.

0

Branch-Protection

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

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.3

/10

Last Scanned on 2025-07-07

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