Giter Club home page Giter Club logo

xslt's Introduction

XSLT library

XSLT 1.0 implementation for browser and Node.js environment based on xpath-ts library.

Requirements

Release Notes

See CHANGELOG.md

Usage

Install with npm:

npm install xslt-ts

This library is xml engine agnostic but I recommend to use xmldom-ts, xmldom or jsdom

npm install xmldom-ts

or

npm install xmldom

or

npm install jsdom

simple usage:

import { DOMImplementationImpl, DOMParserImpl, XMLSerializerImpl } from 'xmldom-ts';
import { install, xsltProcess, xmlParse } from 'xslt-ts';

// xmlString: string of xml file contents
// xsltString: string of xslt file contents
// outXmlString: output xml string.
install(new DOMParserImpl(), new XMLSerializerImpl(), new DOMImplementationImpl());
const outXmlString = xsltProcess(xmlParse(xmlString), xmlParse(xsltString));

another type of usage:

import { DOMImplementationImpl, DOMParserImpl, XMLSerializerImpl } from 'xmldom-ts';
import { install, XSLTProcessor } from 'xslt-ts';

// xmlString: string of xml file contents
// xsltString: string of xslt file contents
// output: output DOM model
install(new DOMParserImpl(), new XMLSerializerImpl(), new DOMImplementationImpl());
const processor = new XSLTProcessorImpl();

processor.importStylesheet(xmlParse(xsltString));
const output = processor.transformToDocument(xmlParse(xmlString));

Introduction

This library contains an implementation of XSLT in TypeScript. Because XSLT uses XPath, it uses compatible XPath implementation xpath-ts which can be used independently of XSLT. This implementation has the advantage that it makes XSLT uniformly available whenever the browser's native XSLTProcessor() is not available such as in node.js or in web workers.

XSLT-processor builds on Google's AJAXSLT which was written before XSLTProcessor() became available in browsers, but the code base has been updated to comply with ES2015+ and to make it work outside of browsers.

This implementation of XSLT operates at the DOM level on its input documents. It internally uses a DOM implementation to create the output document, but usually returns the output document as text stream. The DOM to construct the output document must be supplied by the application. xmldom and jsdom are tested.

Conformance

A few features that are required by the XSLT and XPath standards were left out (but patches to add them are welcome). See our TODO for a list of missing features that we are aware of (please add more items by means of PRs).

Issues are also marked in the source code using throw-statements.

The implementation is all agnostic about namespaces. It just expects XSLT elements to have tags that carry the xsl: prefix, but we disregard all namespace declaration for them.

Developing and Testing

Download

git clone 'https://github.com/backslash47/xslt-ts'
cd xslt-ts

Install

npm install

Build

npm run build

You will get the transpiled code under '/dist/lib' and typings under '/dist/types'.

Test

Run standard tests with Mocha + Chai testing framework

npm test

Authors

  • Google Inc. - Initial work ajaxslt project
  • Johannes Wilm - ES2015+ rewrite Fiduswriter
  • Matus Zamborsky - TypeScript rewrite - Backslash47

References

Licence

The original sources of ajaxslt projects are licenced under BSD-3 clause AJAXSLT-LICENCE.md. Modification made after are licenced with GNU Lesser General Public License v3.0 - see the LICENCE.md file for details.

xslt's People

Contributors

backslash47 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.