@incubateur-ademe/publicodes-commun

Règles communes Publicodes

Ensemble de règles communes utilisées pour l'implémentation des modèles Publicodes.

Installation

yarn install publicodes-commun publicodes

Development

// Install the dependencies
yarn install

// Compile the Publicodes rules
yarn run compile

// Run the tests
yarn run test

// Run the documentation server
yarn run doc

Usage

Directement depuis ce jeux de règles

import { Engine } from 'publicodes'
import rules from 'publicodes-commun'

const engine = new Engine(rules)

console.log(engine.evaluate('mix électrique . empreinte carbone').nodeValue)
// 0.0519

Dans un projet Publicodes

yarn add -D publicodes-commun

Dans un fichier **.publicodes** :

importer!:
  depuis:
    nom: '@incubateur-ademe/publicodes-commun'
    url: https://github.com/incubateur-ademe/publicodes-commun
  dans: commun
  les règles:
    - mix électrique . empreinte carbone
    - mois par an

Les règles ainsi importées seront accessibles et utilisables dans le modèle. Par exemple:

empreinte électricité:
    formule: commun . mix électrique . empreinte carbone * commun . mois par an * 100 kWh/mois