Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/betagouv/publicodes-aides-velo

Modèle Publicodes pour le calcul des aides vélo en France
https://github.com/betagouv/publicodes-aides-velo

aides aides-velo publicodes-model rules-as-code

Last synced: about 1 month ago
JSON representation

Modèle Publicodes pour le calcul des aides vélo en France

Host: GitHub
URL: https://github.com/betagouv/publicodes-aides-velo
Owner: betagouv
License: apache-2.0
Created: 2024-10-22T10:36:21.000Z (2 months ago)
Default Branch: main
Last Pushed: 2024-11-14T17:39:26.000Z (about 2 months ago)
Last Synced: 2024-11-27T01:31:02.097Z (about 1 month ago)
Topics: aides, aides-velo, publicodes-model, rules-as-code
Language: TypeScript
Homepage:
Size: 415 KB
Stars: 2
Watchers: 0
Forks: 1
Open Issues: 6
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG-agir-back.md
- License: LICENSE

Awesome Lists containing this project

README

        # `@betagouv/aides-velo`

![NPM Version](https://img.shields.io/npm/v/%40betagouv%2Faides-velo) [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@betagouv/aides-velo)

Modèle [Publicodes](https://publi.codes) pour le calcul des aides vélo en

France.

> [!NOTE]

> Ce modèle est la continuité de celui de [Mes Aides

> Vélo](https://mesaidesvelo.fr/) rédigé par Maxime Quandalle. Il a été

> rapatrié dans l'organisation Beta.gouv pour faciliter sa maintenance et son

> évolution.

> [!WARNING]

> Ce modèle est en cours de développement et n'est pas encore complet. L'API

> d'utilisation est susceptible d'évoluer, veuillez en tenir compte lors de

> l'utilisation de ce paquet. (N'hésitez pas à ouvrir une issue si vous avez

> des suggestions ou des retours à faire).

## Installation

```sh

yarn install @betagouv/aides-velo

```

## Utilisation

Par soucis de praticité, ce paquet expose en plus des règles Publicodes

(accessible depuis

[`./src/rules`](https://github.com/betagouv/publicodes-aides-velo/tree/main/src/rules)),

une classe

[`AidesVeloEngine`](https://www.jsdocs.io/package/@betagouv/aides-velo#AidesVeloEngine)

qui encapsule un moteur [Publicodes](https://publi.codes) afin de faciliter

l'utilisation des règles.

En exposant notamment la méthode

[`computeAides`](https://www.jsdocs.io/package/@betagouv/aides-velo#AidesVeloEngine.computeAides)

qui permet de calculer et récupérer la liste de toutes les aides éligibles

pour une situation donnée, ainsi que la méthode

[`setInputs`](https://www.jsdocs.io/package/@betagouv/aides-velo#AidesVeloEngine.setInputs)

qui permet de définir les valeurs des questions du modèle de manière au format

JS et _type-safe_ (voir le type

[`Questions`](https://www.jsdocs.io/package/@betagouv/aides-velo#Questions)).

> [!NOTE]

> To see the full API documentation, please refer to

> [jsDocs.io](https://www.jsdocs.io/package/@betagouv/aides-velo).

### Avec la classe `AidesVeloEngine`

```typescript

import { AidesVeloEngine } from "@betagouv/aides-velo";

// Initialisation du moteur

const engine = new AidesVeloEngine();

// Définition de la situation

engine.setInputs({

  "localisation . code insee": "33119", // Code INSEE de la commune, permet de récupérer les aides communales

  "localisation . epci": "Bordeaux Métropole", // Permet de récupérer les aides intercommunales

  "localisation . département": "33", // Permet de récupérer les aides départementales

  "localisation . région": "75", // Permet de récupérer les aides régionales

  "localisation . pays": "France", // Permet de récupérer les aides nationales

  "vélo . type": "électrique",

  "vélo . état": "neuf",

  "vélo . prix": 1000,

  "revenu fiscal de référence par part . revenu de référence": 20000,

  "revenu fiscal de référence par part . nombre de parts": 2,

});

// Calcul des aides

engine

  .computeAides()

  .forEach(({ title, amount }) => console.log(`Aide ${title} : ${amount}€`));

// Aide Bonus vélo : 300€

// Aide Prime à la conversion : 400€

// Aide Bordeaux Métropole : 200€

// Aide Ville de Bègles : 200€

```

> [!TIP]

> Pour récupérer les informations de localisation (code INSEE, EPCI, etc...)

> nécessaires pour le calcul des aides, il est possible d'utiliser le paquet

> [`@etalab/decoupage-administratif`](https://github.com/datagouv/decoupage-administratif).

### Avec les règles Publicodes

Il est également possible d'utiliser les règles Publicodes directement avec

`@betagouv/aides-velo/rules`.

```typescript

import Engine, { formatValue } from "publicodes";

import rules from "@betagouv/aides-velo/rules";

const engine = new Engine(rules);

// Permet de définir les valeurs de chaques règles et pas seulement celles qui

// correspondent à des questions.

engine.setSituation({

  "localisation . epci": "'CA du Grand Angoulême'",

  "vélo . type": "'électrique'",

  "vélo . état": "'occasion'",

  "vélo . prix": 1000,

  "revenu fiscal de référence par part": 2000,

});

const result = engine.evaluate("aides . grand angouleme");

console.log(result.nodeValue);

// 400

console.log(formatValue(result));

// 400 €

```

## Développement

```sh

// Install the dependencies and run postinstall scripts

yarn install

// Compile the Publicodes rules

yarn run compile:rules

// Run the tests

yarn run test

// Compile the whole package (rules + wrapper function)

yarn run compile

// Run the documentation server

yarn run doc

```

## Modification des aides

Si vous avez repéré une erreur ou souhaitez ajouter une aide, vous pouvez

simplement ouvrir [une

issue](https://github.com/betagouv/publicodes-aides-velo/issues) ou si vous le

souhaitez, ouvrir une _pull request_ avec les modifications nécessaires.

Toutes les aides sont définie dans le fichier

[`src/rules/aides.publicodes`](./src/rules/aides.publicodes) et peuvent être

modifiées (resp. supprimées/ajoutées) directement dans ce fichier.

Une fois les modifications effectuées, assurez vous de ne pas avoir introduit

d'erreurs dans les règles avec la commande `yarn run compile`.

> [!NOTE]

> Si une aide n'est plus d'actualité et doit être supprimée, il est préférable

> de la commenter plutôt que de la supprimer directement. Cela permet de

> conserver une trace de l'aide et de la réactiver si nécessaire.

Si la modélisation de l'aide implique un certain degré de complexité, il est

probablement souhaitable de rajouter des tests unitaires dans le fichier

[`test/rules.test.ts`](./test/rules.test.ts).

Une fois toutes les modifications effectuées et les tests passés, vous pouvez

ajouter vos modifications dans le changelog grâce à la commande `npx changeset` en

sélectionnant `patch` puis en ajoutant la description adéquate :

```

Add - [Titre de l'aide]

Update - [Titre de l'aide] - [Description de la modification]

Remove - [Titre de l'aide]

```

> [!TIP]

> Exécuter cette commande permettra d'automatiser la génération du changelog

> lors de la publication de la prochaine version et ainsi garder une trace des

> modifications apportées.

Enfin, _commitez_ vos modifications et ouvrez une _pull request_.