computron

Computron

Computron is a Node.js library to apply XSLT stylesheets to XML documents. It's a C++ addon for Node.js that uses libxml2 and libxslt.

Disclaimer

This library is only intended to be used on Linux.

Requirements

You must have libxml2 and libxslt1 installed on your system.

sudo apt install libxml2-dev libxslt1-dev

You should already have a C++ compiler installed on your system, if it's not the case install g++.

sudo apt install g++

Computron uses node-gyp as a build system so you need to install it to be able to compile Computron

npm install -g node-gyp

Usage

Basic example:

const Computron = require('computron');
const computron = new Computron();

// A stylesheet needs to be loaded on the current instance before doing anything
try {
  computron.loadStylesheet('/path/to/stylesheet');
} catch (err) {
  console.error(err);
  process.exit(1);
}

// Apply the previously loaded stylesheet on the provided XML file
let xmlResult;
try {
  xmlResult = computron.apply('/path/to/xml');
} catch (err) {
  console.error(err);
  process.exit(1);
}

console.info(xmlResult);

Using a stylesheet that takes parameters:

const Computron = require('computron');
const computron = new Computron();

// A stylesheet needs to be loaded on the current instance before doing anything
try {
  computron.loadStylesheet('/path/to/stylesheet/with/params');
} catch (err) {
  console.error(err);
  process.exit(1);
}

// Apply the previously loaded stylesheet on the provided XML file
let xmlResult;
try {
  // Parameters can be passed to the stylesheet
  const params = {
    param1Name: 'value1',
    param2Name: 'value2',
  };

  xmlResult = computron.apply('/path/to/xml', params);
} catch (err) {
  console.error(err);
  process.exit(1);
}

console.info(xmlResult);

Development

To build and run the tests in release mode run:

npm test

You can debug the C++ code with in VSCode, to do so run:

npm run build:config

This will build the VSCode debugger configuration, you can then simply press F5 or go to the "Run and Debug" tab and click on "Debug".