Skip to content

Set of utility functions to write tooling for Publicodes models

License

Notifications You must be signed in to change notification settings

publicodes/tools

Repository files navigation

@publicodes/tools

Report BugAPI docsContributePublicodes

CI NPM

Set of utility functions that could be used to easily write tooling around Publicodes models.

⚠️ The project is not stable yet, don't hesitate to open an issue if you face a problem! ⚠️

Features

  • 🏗️ Compiles your set of Publicodes files into a standalone JSON file - [doc]
  • 📦 Resolves import from external Publicodes models, from source and from published NPM packages - [doc]
  • 🪶 Pre-computes your model at compile time and reduces the number of rules by ~65% - [doc]
  • ➡️ Use a migration function for user situation to deal with breaking changes in your models - [doc]

Installation

npm install --dev-dependency @publicodes/tools

yarn add -D @publicodes/tools

Usage in local

When developing in local:

  1. you can link the local package with yarn link,
  2. launch the compilation in watch mode with yarn watch,
  3. and use it in your project with yarn link @publicodes/tools.