From d71877f915aa0cd11a1d58999dd60e7a926b1cd2 Mon Sep 17 00:00:00 2001
From: Alexandre Gravel-Raymond <agravelraymond@deezer.com>
Date: Wed, 22 Nov 2023 20:35:19 +0100
Subject: [PATCH] Move jsdoc files to subfolder

---
 jsdoc-synonyms.js => jsdoc/jsdoc-synonyms.js | 0
 jsdoc.config.json => jsdoc/jsdoc.config.json | 2 +-
 undocumented.mjs => jsdoc/undocumented.mjs   | 4 ++--
 package.json                                 | 6 +++---
 4 files changed, 6 insertions(+), 6 deletions(-)
 rename jsdoc-synonyms.js => jsdoc/jsdoc-synonyms.js (100%)
 rename jsdoc.config.json => jsdoc/jsdoc.config.json (78%)
 rename undocumented.mjs => jsdoc/undocumented.mjs (91%)

diff --git a/jsdoc-synonyms.js b/jsdoc/jsdoc-synonyms.js
similarity index 100%
rename from jsdoc-synonyms.js
rename to jsdoc/jsdoc-synonyms.js
diff --git a/jsdoc.config.json b/jsdoc/jsdoc.config.json
similarity index 78%
rename from jsdoc.config.json
rename to jsdoc/jsdoc.config.json
index 4098a5c5..073b16c5 100644
--- a/jsdoc.config.json
+++ b/jsdoc/jsdoc.config.json
@@ -3,7 +3,7 @@
     "includePattern": ".+\\.(js(doc|x)?|mjs)$",
     "excludePattern": "node_modules|shift-parser|shift-reducer|shift-traverser|dist"
   },
-  "plugins": ["plugins/markdown", "jsdoc-synonyms"],
+  "plugins": ["plugins/markdown", "jsdoc/jsdoc-synonyms"],
   "opts": {
     "destination": "./out/",
     "recurse": true
diff --git a/undocumented.mjs b/jsdoc/undocumented.mjs
similarity index 91%
rename from undocumented.mjs
rename to jsdoc/undocumented.mjs
index 281d27d8..657fdea6 100644
--- a/undocumented.mjs
+++ b/jsdoc/undocumented.mjs
@@ -65,7 +65,7 @@ async function getUndocumented(path, docs) {
 }
 
 // read doc.json file
-const { docs } = JSON.parse(await readFile(resolve(__dirname, 'doc.json'), 'utf8'));
+const { docs } = JSON.parse(await readFile(resolve(__dirname, '..', 'doc.json'), 'utf8'));
 
 const paths = dependencyTree.toList({
   filename: 'index.mjs',
@@ -76,7 +76,7 @@ const paths = dependencyTree.toList({
 // const paths = ['../packages/core/pattern.mjs', '../packages/core/hap.mjs'].map((rel) => resolve(__dirname, rel));
 
 const undocumented = Object.fromEntries(
-  await Promise.all(paths.map(async (path) => [path, await getUndocumented(path, docs)])),
+  await Promise.all(paths.map(async (path) => [path.replace(resolve(__dirname, '..'), ''), await getUndocumented(path, docs)])),
 );
 
 console.log(JSON.stringify(undocumented, null, 2));
diff --git a/package.json b/package.json
index 36229611..172832ee 100644
--- a/package.json
+++ b/package.json
@@ -18,12 +18,12 @@
     "build": "npm run prebuild && cd website && npm run build",
     "preview": "cd website && npm run preview",
     "osc": "cd packages/osc && npm run server",
-    "jsdoc": "jsdoc packages/ -c jsdoc.config.json",
-    "jsdoc-json": "jsdoc packages/ --template ./node_modules/jsdoc-json --destination doc.json -c jsdoc.config.json",
+    "jsdoc": "jsdoc packages/ -c jsdoc/jsdoc.config.json",
+    "jsdoc-json": "jsdoc packages/ --template ./node_modules/jsdoc-json --destination doc.json -c jsdoc/jsdoc.config.json",
     "lint": "eslint . --ext mjs,js --quiet",
     "codeformat": "prettier --write .",
     "format-check": "prettier --check .",
-    "report-undocumented": "npm run jsdoc-json && node undocumented.mjs > undocumented.json",
+    "report-undocumented": "npm run jsdoc-json && node jsdoc/undocumented.mjs > undocumented.json",
     "check": "npm run format-check && npm run lint && npm run test",
     "iclc": "cd paper && pandoc --template=pandoc/iclc.html --citeproc  --number-sections iclc2023.md -o iclc2023.html && pandoc --template=pandoc/iclc.latex --citeproc --number-sections iclc2023.md -o iclc2023.pdf"
   },