Twing

First-class TypeScript and JavaScript Twig compiler

Prerequisites

This projects needs at least node.js 16.0.0 to run.

It is also strongly recommended to have ts-node and One Double Zero installed globally to ease the writing of tests and the tracking of the code coverage.

Usage

Installation

npm install

Build the library

npm run build

Build and run the test suite

npm run build:test
npm run test

Build and run the test suite in a browser

npm run build:test
npm run test:browser

Writing and executing tests

Assuming one want to execute the test located in src/test/tests/integration/comparison/to-array.ts, one would run:

ts-node src/test/tests/integration/comparison/to-array.ts

It is even possible - and recommended - to track the coverage while writing tests:

odz ts-node src/test/tests/integration/comparison/to-array.ts

Of course, it is also perfectly possible to pipe the result of the test to your favorite tap formatter:

src/test/tests/integration/comparison$ ts-node . | tap-nyan
 9   -_-_-_-_-_,------,
 0   -_-_-_-_-_|   /\_/\ 
 0   -_-_-_-_-^|__( ^ .^) 
     -_-_-_-_-  ""  "" 
  Pass!

Contributing

Fork this repository
Code
Implement tests using tape
Issue a pull request keeping in mind that all pull requests must reference an issue in the issue queue

2.4 KiB Raw Permalink Blame History