npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

super-xmlllint

v1.0.6

Published

Wrapper for `xmllint`. Easy validation of XML. C14n and c14n-exc canoncalization. XML Schemas and DTDs supported. Zero dependencies.

Downloads

1,375

Readme

super-xmllint

npm package

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

const {
  validateXML,
  validateXMLWithDTD,
  validateXMLWithXSD,
  canonicalizeXML
} = require("validate-with-xmllint");

Demos of passing validations

All the examples below return promises which will eventually resolve.

validateXML("<hello>world!</hello>");
validateXML("<tiny/>");

/**
 * All referenced DTD's must be available locally as `xmllint`
 * is invoked with `--nonet` which prevents network connections
 **/
validateXMLWithDTD(
  `<?xml version="1.0" encoding="utf-8"?>
    <!DOCTYPE root SYSTEM "./test/dtds/valid-dtd.dtd">
    <root>
        <body/>
        <body/>
    </root>`
);

/**
 * Path to XSD Schema file must be provided with the document
 **/
validateXMLWithXSD(
  `<?xml version="1.0"?>
    <root>
        <text>
        DEMO
        </text>
        <body>
            <name>foo</name>
        </body>
    </root>`,
  "./test/xsds/valid-xsd.xsd"
);

Demos of failing validations

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

validateXML("<open_tag_only>");
validateXML("garbage");

validateXMLWithDTD(
  `<?xml version="1.0" encoding="utf-8"?>
    <!DOCTYPE root SYSTEM "./test/dtds/valid-dtd.dtd">
    <this>
      Not allowed by the dtd!
    </this>`
);

validateXMLWithXSD(
  `<?xml version="1.0"?>
    <root>
        <something_unexpected_here/>
    </root>`,
  "./test/xsds/valid-xsd.xsd"
);

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