From 6aceeb154b4e66e9933717f656fdcb09cf209bca Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fran=C3=A7ois=20Parmentier?= <francois.parmentier@gmail.com>
Date: Tue, 6 Feb 2024 11:55:53 +0100
Subject: [PATCH] chore(insert-description): Add the npm script
 insert:description

---
 CONTRIBUTING.md | 17 +++++++++++++++++
 SCRIPTS.md      | 24 ++++++++++++++++++++++++
 package.json    |  3 ++-
 3 files changed, 43 insertions(+), 1 deletion(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f53ca3d1..d2e0d9f6 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -279,6 +279,23 @@ Exemples:
 ./bin/insert-description.sh services/terms-extraction/v1_teeft_fr.md
 ```
 
+Alternative: utiliser le script npm `insert:description`:
+
+```bash
+$ npm run insert:description services/terms-extraction/v*.md
+
+> web-services@1.0.0 insert:description
+> ./bin/insert-description.sh services/terms-extraction/v1_teeft_en.md services/terms-extraction/v1_teeft_fr.md services/terms-extraction/v1_teeft_with-numbers_en.md services/terms-extraction/v1_teeft_with-numbers_fr.md
+
+ - services/terms-extraction/v1/teeft/en.ini ✓
+ - services/terms-extraction/v1/teeft/fr.ini ✓
+ - services/terms-extraction/v1/teeft/with-numbers/en.ini ✓
+ - services/terms-extraction/v1/teeft/with-numbers/fr.ini ✓
+```
+
+> **Note**: si vous voulez bénéficier de l'auto-complétion des chemins de
+> fichiers, utilisez plutôt `./bin/insert-description.sh`.
+
 ## Développement
 
 ### Sans docker
diff --git a/SCRIPTS.md b/SCRIPTS.md
index fa233ccf..7b42c16c 100644
--- a/SCRIPTS.md
+++ b/SCRIPTS.md
@@ -6,6 +6,7 @@ Available scripts:
 - generate:example-tests
 - generate:service
 - help
+- insert:description
 - publish
 - update:images
 - test:local
@@ -59,6 +60,29 @@ Help is colorized if you have `bat` installed.
 
 See <https://github.com/sharkdp/bat>.
 
+## insert:description
+
+Usage: `npm run insert:description services/service-name/v1_path.md`
+
+Insert the Markdown description of a route into the matching `.ini` metadata
+(`post.description`).  
+Convert multiline markdown into one-line metadata (using `^M` character).
+Replace the `_` character in the markdown files names with `/`, to match the path of the `.ini`s to be modified.
+
+Example:
+
+```bash
+$ npm run insert:description services/terms-extraction/v*.md
+
+> web-services@1.0.0 insert:description
+> ./bin/insert-description.sh services/terms-extraction/v1_teeft_en.md services/terms-extraction/v1_teeft_fr.md services/terms-extraction/v1_teeft_with-numbers_en.md services/terms-extraction/v1_teeft_with-numbers_fr.md
+
+ - services/terms-extraction/v1/teeft/en.ini ✓
+ - services/terms-extraction/v1/teeft/fr.ini ✓
+ - services/terms-extraction/v1/teeft/with-numbers/en.ini ✓
+ - services/terms-extraction/v1/teeft/with-numbers/fr.ini ✓
+```
+
 ## publish
 
 Usage: `npm run publish`
diff --git a/package.json b/package.json
index 3250149a..b707ebd1 100644
--- a/package.json
+++ b/package.json
@@ -9,6 +9,7 @@
         "generate:example-tests": "node bin/generate-example-tests.mjs",
         "generate:service": "./bin/create-service-from-template.sh",
         "help": "bat SCRIPTS.md || cat SCRIPTS.md",
+        "insert:description": "./bin/insert-description.sh",
         "publish": "./bin/publish.sh",
         "update:images": "./bin/update-images.sh",
         "test": "echo \"Error: no test specified\" && exit 1",
@@ -51,4 +52,4 @@
     "devDependencies": {
         "@types/node": "20.11.16"
     }
-}
+}
\ No newline at end of file