Skip to content

JavaScript engine for the Validation and Transformation Language

License

Notifications You must be signed in to change notification settings

InseeFr/Trevas-TS

Repository files navigation

Trevas TS

Trevas TS is a TypeScript engine for the Validation and Transformation Language. It is part of the Trevas family, together with the Trevas Java engine.

Trevas TS CI Coverage Quality Gate Status License: MIT Storybook

The documentation can be found in the docs folder and browsed online.

@inseefr/trevas

npm version

The @inseefrtrevas package is the VTL engine itself, which exposes the interpret function root (named export).

Versions

VTL 2.1 is supported since Trevas TS >= 1.0.0

VTL 2.0 was supported for Trevas TS < 1.0.0

Getting started

Use Trevas TS

To use Trevas TS in your JavaScript project, just run:

yarn add @inseefr/trevas

or

npm install @inseefr/trevas

Build Trevas TS

If you prefer to build Trevas TS locally, first clone the Github repository:

git clone https://github.com/InseeFr/Trevas-TS.git
cd Trevas-TS
yarn
yarn build

Tests

Run once:

yarn test

Run with hot reloading:

yarn test-watch

Storybook

Run storybook:

yarn storybook

Documentation

Run docusaurus documentation:

cd docs
yarn
yarn start

Archived packages

@inseefr/vtl-2.0-antlr-tools

This library is deprecated and no longer maintained. The last version is 0.3.2.

See here for replacing tools.

@inseefr/vtl-tools

This library is deprecated and no longer maintained. The last version is 0.1.15.

@inseefr/vtl-2.1-engine

This library is deprecated and no longer maintained. The last version is 0.1.9.

@inseefr/trevas is the next engine.

@inseefr/vtl-2.1-antlr-tools

This library is deprecated and no longer maintained. The last version is 1.0.0-rc2.

See here for replacing tools.