Skip to content

Gradiant/smart-xapi-dsl

Repository files navigation

npm version code style: prettier Conventional Commits

Smart XAPI DSL

Specific xAPI vocabulary used at the Smarted plaform.

Overview

Includes everything exported from @gradiant-xapi-dsl/types and a sub set of @gradiant-xapi-dsl/dsl vocabulary specific for SMART projects.

It also include a set of utility functions to checks for specific activity types, verbs, recipes, etc

Check the markdown documentation for more info about what is exported

Scripts

npm run build

Compile typescript files from the src folder inside the build folder

npm test

Run tests files inside the tests folder that matches *.test.ts pattern

npm run docs

Generates the dsl documentation. Using npm run docs:md the documentation will be generated in markdown format

npm run ci

Check linters and run the tests