apply jsdoc

bin/data-migrations/src/index.js

@@ -2,6 +2,11 @@
 /* eslint-disable no-undef, no-var, vars-on-top, no-restricted-globals, regex/invalid, import/extensions */
 // ignore lint error because this file is js as mongoshell
 
+/**
+ * @typedef {import('./types').MigrationModule} MigrationModule
+ * @typedef {import('./types').ReplaceLatestRevisions} ReplaceLatestRevisions
+ */
+
 var pagesCollection = db.getCollection('pages');
 var revisionsCollection = db.getCollection('revisions');
 
@@ -10,12 +15,14 @@ var batchSizeInterval = process.env.BATCH_INTERVAL ?? 3000; // default 3 sec
 
 var migrationModule = process.env.MIGRATION_MODULE;
 
+/** @type {MigrationModule[]} */
 var migrationModules = require(`./migrations/${migrationModule}`);
 
 if (migrationModules.length === 0) {
   throw Error('No valid migrationModules found. Please enter a valid environment variable');
 }
 
+/** @type {ReplaceLatestRevisions} */
 function replaceLatestRevisions(body, migrationModules) {
   var replacedBody = body;
   migrationModules.forEach((migrationModule) => {

bin/data-migrations/src/migrations/custom.js

@@ -1,4 +1,11 @@
+/**
+ * @typedef {import('../../types').MigrationModule} MigrationModule
+ */
+
 module.exports = [
+  /**
+   * @type {MigrationModule}
+   */
   (body) => {
     // processor for MIGRATION_MODULE=custom
     // ADD YOUR PROCESS HERE!

bin/data-migrations/src/migrations/v60x/bracketlink.js

@@ -1,4 +1,11 @@
+/**
+ * @typedef {import('../../types').MigrationModule} MigrationModule
+ */
+
 module.exports = [
+  /**
+   * @type {MigrationModule}
+   */
   (body) => {
     // https://regex101.com/r/btZ4hc/1
     // eslint-disable-next-line regex/invalid

bin/data-migrations/src/migrations/v60x/csv.js

@@ -1,4 +1,11 @@
+/**
+ * @typedef {import('../../types').MigrationModule} MigrationModule
+ */
+
 module.exports = [
+  /**
+   * @type {MigrationModule}
+   */
   (body) => {
     const oldCsvTableRegExp = /::: csv(-h)?\n([\s\S]*?)\n:::/g; // CSV old format
     return body.replace(oldCsvTableRegExp, '``` csv$1\n$2\n```');

bin/data-migrations/src/migrations/v60x/drawio.js

@@ -1,4 +1,11 @@
+/**
+ * @typedef {import('../../types').MigrationModule} MigrationModule
+ */
+
 module.exports = [
+  /**
+   * @type {MigrationModule}
+   */
   (body) => {
     const oldDrawioRegExp = /:::\s?drawio\n(.+?)\n:::/g; // drawio old format
     return body.replace(oldDrawioRegExp, '``` drawio\n$1\n```');

bin/data-migrations/src/migrations/v60x/plantuml.js

@@ -1,4 +1,11 @@
+/**
+ * @typedef {import('../../types').MigrationModule} MigrationModule
+ */
+
 module.exports = [
+  /**
+   * @type {MigrationModule}
+   */
   (body) => {
     const oldDrawioRegExp = /:::\s?drawio\n(.+?)\n:::/g; // drawio old format
     return body.replace(oldDrawioRegExp, '``` drawio\n$1\n```');

bin/data-migrations/src/migrations/v60x/tsv.js

@@ -1,4 +1,11 @@
+/**
+ * @typedef {import('../../types').MigrationModule} MigrationModule
+ */
+
 module.exports = [
+  /**
+   * @type {MigrationModule}
+   */
   (body) => {
     const oldTsvTableRegExp = /::: tsv(-h)?\n([\s\S]*?)\n:::/g; // TSV old format
     return body.replace(oldTsvTableRegExp, '``` tsv$1\n$2\n```');

bin/data-migrations/src/migrations/v61x/mdcont.js

@@ -1,4 +1,11 @@
+/**
+ * @typedef {import('../../types').MigrationModule} MigrationModule
+ */
+
 module.exports = [
+  /**
+   * @type {MigrationModule}
+   */
   (body) => {
     const oldMdcontPrefixRegExp = /#mdcont-/g;
     return body.replace(oldMdcontPrefixRegExp, '#');