Import/Export plugin and document scripts

Author: nirmalhk7

.gitignore

@@ -16,6 +16,7 @@ package-lock.json
 ############################
 role-split
 *~
+wiki
 
 
 ############################

package.json

@@ -24,6 +24,7 @@
     "strapi-plugin-content-type-builder": "3.5.4",
     "strapi-plugin-email": "3.5.4",
     "strapi-plugin-graphql": "3.5.4",
+    "strapi-plugin-import-export-content": "^0.4.2",
     "strapi-plugin-upload": "3.5.4",
     "strapi-plugin-users-permissions": "3.5.4",
     "strapi-provider-email-nodemailer": "3.6.0",
@@ -38,5 +39,10 @@
   "engines": {
     "npm": "^7.0.0"
   },
-  "license": "MIT"
+  "license": "MIT",
+  "devDependencies": {
+    "jsdoc-to-markdown": "^7.1.1",
+    "lodash": "^4.17.21",
+    "pluralize": "^8.0.0"
+  }
 }

scripts/documentation.js

@@ -0,0 +1,71 @@
+/* eslint-disable */
+
+const jsdoc2md = require("jsdoc-to-markdown");
+const fs = require("fs");
+const pluralize = require("pluralize");
+const path = require("path");
+const groupBy = require("lodash/groupBy");
+const uniq = require("lodash/uniq");
+
+/* input and output paths */
+const inputFile = "src/**/*";
+const outputDir = "wiki";
+const capitalize = (s) => {
+  if (typeof s !== "string") return "";
+  return s.charAt(0).toUpperCase() + s.slice(1);
+};
+
+const templateData = jsdoc2md
+  .getNamepaths({ files: inputFile, configure: "./scripts/jsdoc.conf.json" })
+  .then((e) => {
+    Object.keys(e).forEach((key) => {
+      fs.writeFileSync(
+        path.resolve(`${outputDir}/project/${pluralize(key)}.md`),
+        `## ${capitalize(pluralize(key))}\n\n`
+      );
+    });
+  })
+  .then(() => {
+    const getTemplateData = jsdoc2md.getTemplateDataSync({
+      files: inputFile,
+      configure: "jsdoc.conf.json",
+    });
+    const groups = groupBy(getTemplateData, "kind");
+
+    Object.keys(groups).forEach((key) => {
+      const template = `
+{{>main}}
+
+* * *
+
+Last updated on ${new Date()}
+`;
+      const output = jsdoc2md.renderSync({
+        data: groups[key],
+        configure: "./scripts/jsdoc.conf.json",
+        template,
+      });
+      fs.writeFileSync(path.resolve(`${outputDir}/project/${pluralize(key)}.md`), output);
+    });
+    return groups;
+  })
+  .then((res) => {
+    const sidebarText = [];
+    Object.keys(res).forEach((key) => {
+      sidebarText.push(`\n#### ${capitalize(pluralize(key))}`);
+      res[key].forEach((e) => {
+        sidebarText.push(`- [${e.name}](project/${pluralize(key)}#${e.name})`);
+      });
+      sidebarText.push("\n");
+    });
+    return uniq(sidebarText);
+  })
+  .then((res) => {
+    const data = fs.readFileSync("wiki/Home.md", "utf8").split("<!-- OCTAWEBDOC -->");
+    let id = 0;
+    if (data.length > 1) {
+      id = 1;
+    }
+    data[id] = "<!-- OCTAWEBDOC -->\n" + res.join("\n");
+    fs.writeFileSync("wiki/Home.md", data.join(""), "utf8");
+  });