fix: ajout d'autres occurences variabilisées

publicodes · Oct 2, 2023 · ef0774a · ef0774a
1 parent 834f819
commit ef0774a
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 33 deletions.
diff --git a/README.md b/README.md
@@ -41,50 +41,50 @@ Pour garantir une utilisation de la documentation sans erreur :
 Pour utiliser les fonctionnalités de la CI :
 
 1. Il faut décommenter les fichiers `./github/workflows/*.yaml`
-2. Ajouter les variables suivantes dans les secrets du repository GitHub :
-    - `NPM_TOKEN` : token NPM pour publier le paquet sur [npmjs.com](https://npmjs.com)
-    - `PAT` : Personal Access Token pour publier la documentation sur GitHub Pages
-![Screenshot from 2023-09-12 12-02-40](https://github.com/incubateur-ademe/publicodes-model-template/assets/44124798/a6fe53cc-5766-4541-8936-41d474ed0069)
-3. Aller dans les paramètres du repository GitHub et :
-    - modifier les droits des worflows
-![image](https://github.com/incubateur-ademe/publicodes-model-template/assets/44124798/cd7e37f9-0641-44f2-b968-79faa778b832)
-    - sélectionner la branche `gh-pages` dans les paramètres du repository
-![image](https://github.com/incubateur-ademe/publicodes-model-template/assets/44124798/77191750-12f1-4ab4-94a4-7447f1b77624)
-
+2. Ajouter les variables suivantes dans les secrets du repository GitHub : - `NPM_TOKEN` : token NPM pour publier le paquet sur [npmjs.com](https://npmjs.com) - `PAT` : Personal Access Token pour publier la documentation sur GitHub Pages
+   ![Screenshot from 2023-09-12 12-02-40](https://github.com/incubateur-ademe/publicodes-model-template/assets/44124798/a6fe53cc-5766-4541-8936-41d474ed0069)
+3. Aller dans les paramètres du repository GitHub et : - modifier les droits des worflows
+   ![image](https://github.com/incubateur-ademe/publicodes-model-template/assets/44124798/cd7e37f9-0641-44f2-b968-79faa778b832) - sélectionner la branche `gh-pages` dans les paramètres du repository
+   ![image](https://github.com/incubateur-ademe/publicodes-model-template/assets/44124798/77191750-12f1-4ab4-94a4-7447f1b77624)
 
 ## Exemples de dépôts utilisant ce template
 
 - [`@incubateur-ademe/publicodes-commun`](https://github.com/incubateur-ademe/publicodes-commun) -
-_Ensemble de règles communes utilisées pour l'implémentation des modèles Publicodes de l'incubateur_
+  _Ensemble de règles communes utilisées pour l'implémentation des modèles Publicodes de l'incubateur_
 - [`@incubateur-ademe/publicodes-negaoctet`](https://github.com/incubateur-ademe/publicodes-negaoctet) -
-_Modèle Publicodes pour la base de données NegaOctet_
+  _Modèle Publicodes pour la base de données NegaOctet_
+- [`@incubateur-ademe/publicodes-impact-livraison`](https://github.com/incubateur-ademe/publicodes-negaoctet) -
+  _Modèle [Publicodes](https://publi.codes) pour le simulateur [Impact Livraison](https://impactco2.fr/livraison)_
+
+## Usage
 
-## Usage 
+Ajouter le paquet à vos dépendances :
 
-Ajouter le paquet à vos dépendances : 
 ```
-bun add %PACKAGE_NAME%
+bun add %GITHUB_USER%/%PACKAGE_NAME%
 ```
 
 Instancier un nouveau moteur Publicode :
+
 ```typescript
 import Engine from 'publicodes'
-import rules from '%PACKAGE_NAME%'
+import rules from '%GITHUB_USER%/%PACKAGE_NAME%'
 
 const engine = new Engine(rules)
 
 engine.evaluate('tablette . consommation en mode actif')
 ```
 
 Utiliser certaines règles dans un autre modèle publicodes :
+
 ```yaml
 importer!:
   depuis:
-    nom: %PACKAGE_NAME% 
+    nom: %PACKAGE_NAME%
     url: https://github.com/%GITHUB_USER%/%PACKAGE_NAME%
   dans: modèle numérique
   les règles:
-    - numérique . internet . consommation horaire 
+    - numérique . internet . consommation horaire
     - ordinateur portable . construction
 ```
 
@@ -96,7 +96,7 @@ importer!:
 > [`rules/`](https://github.com/%GITHUB_USER%/%PACKAGE_NAME%/tree/main/rules).
 
 Pour installer les dépendances et compiler tous les fichiers `.publicodes` en
-un seul fichier JSON, il suffit d'exécuter la commande suivante : 
+un seul fichier JSON, il suffit d'exécuter la commande suivante :
 
 ```
 bun && bun run build
@@ -122,7 +122,7 @@ bun run doc:start
 > [`api/`](https://github.com/%GITHUB_USER%/%PACKAGE_NAME%/tree/main/api).
 
 Pour lancer le serveur Node permettant d'utiliser l'API REST, il faut utiliser les commandes
-suivantes : 
+suivantes :
 
 ```
 bun run api

diff --git a/doc/public/index.html b/doc/public/index.html
@@ -6,9 +6,9 @@
     <meta name="theme-color" content="#000000" />
     <meta
       name="description"
-      content="Documentation for the publicodes modèle : Numérique"
+      content="Documentation for the publicodes modèle : %PACKAGE_NAME%"
     />
-	 <!-- Start Single Page Apps for GitHub Pages -->
+    <!-- Start Single Page Apps for GitHub Pages -->
     <script type="text/javascript">
       // Single Page Apps for GitHub Pages
       // MIT License
@@ -20,15 +20,23 @@
       // When the single page app is loaded further down in this file,
       // the correct url will be waiting in the browser's history for
       // the single page app to route accordingly.
-		  (function(l) {
-		   if (l.search[1] === '/' ) {
-		   var decoded = l.search.slice(1).split('&').map(function(s) { 
-				   return s.replace(/~and~/g, '&')
-				   }).join('?');
-		   window.history.replaceState(null, null,
-				   l.pathname.slice(0, -1) + decoded + l.hash
-				   );
-		   }(window.location)})
+      ;(function (l) {
+        if (l.search[1] === '/') {
+          var decoded = l.search
+            .slice(1)
+            .split('&')
+            .map(function (s) {
+              return s.replace(/~and~/g, '&')
+            })
+            .join('?')
+          window.history.replaceState(
+            null,
+            null,
+            l.pathname.slice(0, -1) + decoded + l.hash
+          )
+        }
+        window.location
+      })
     </script>
     <!--
       Notice the use of %PUBLIC_URL% in the tags above.
@@ -39,7 +47,7 @@
       work correctly both with client-side routing and a non-root public URL.
       Learn how to configure a non-root public URL by running `npm run build`.
     -->
-    <title>Modèle Numérique - Documentation</title>
+    <title>Modèle %PACKAGE_NAME% - Documentation</title>
   </head>
   <body>
     <noscript>You need to enable JavaScript to run this app.</noscript>

diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "%PACKAGE_NAME%",
+  "name": "%GITHUB_USER%/%PACKAGE_NAME%",
   "version": "0.1.0",
   "description": "",
   "type": "module",