[FIX] Node.js API: TypeScript type definition support (#335)

Lazy-loading in the index.js breaks the automatic type definition detection from TypeScript when using the module via require. Therefore we need to manually declare the exported types. Adds a small jsdoc-plugin to remove the import() comments as JSDoc is unable to parse them.
SAP · Jul 14, 2020 · c610305 · c610305
1 parent c0dcd29
commit c610305
Show file tree

Hide file tree

Showing 3 changed files with 99 additions and 60 deletions.
diff --git a/index.js b/index.js
@@ -2,16 +2,28 @@
  * @module module:@ui5/project
  * @public
  */
-const modules = {
+module.exports = {
+	/**
+	 * @type {import('./lib/normalizer')}
+	 */
 	normalizer: "./lib/normalizer",
+	/**
+	 * @type {import('./lib/projectPreprocessor')}
+	 */
 	projectPreprocessor: "./lib/projectPreprocessor",
 	/**
 	 * @public
 	 * @alias module:@ui5/project.ui5Framework
 	 * @namespace
 	 */
 	ui5Framework: {
+		/**
+		 * @type {typeof import('./lib/ui5Framework/Openui5Resolver')}
+		 */
 		Openui5Resolver: "./lib/ui5Framework/Openui5Resolver",
+		/**
+		 * @type {typeof import('./lib/ui5Framework/Sapui5Resolver')}
+		 */
 		Sapui5Resolver: "./lib/ui5Framework/Sapui5Resolver"
 	},
 	/**
@@ -20,7 +32,13 @@ const modules = {
 	 * @namespace
 	 */
 	validation: {
+		/**
+		 * @type {import('./lib/validation/validator')}
+		 */
 		validator: "./lib/validation/validator",
+		/**
+		 * @type {typeof import('./lib/validation/ValidationError')}
+		 */
 		ValidationError: "./lib/validation/ValidationError"
 	},
 	/**
@@ -29,7 +47,13 @@ const modules = {
 	 * @namespace
 	 */
 	translators: {
+		/**
+		 * @type {import('./lib/translators/npm')}
+		 */
 		npm: "./lib/translators/npm",
+		/**
+		 * @type {import('./lib/translators/static')}
+		 */
 		static: "./lib/translators/static"
 	}
 };
@@ -49,4 +73,4 @@ function exportModules(exportRoot, modulePaths) {
 	}
 }
 
-exportModules(module.exports, modules);
+exportModules(module.exports, JSON.parse(JSON.stringify(module.exports)));
diff --git a/jsdoc-plugin.js b/jsdoc-plugin.js
@@ -0,0 +1,13 @@
+/*
+ * Removes JSDoc comments with TypeScript import() declarations (used in index.js)
+ */
+
+const IMPORT_PATTERN = /{(?:typeof )?import\(["'][^"']*["']\)[ .|}><,)=#\n]/;
+
+exports.handlers = {
+	jsdocCommentFound: function(e) {
+		if (IMPORT_PATTERN.test(e.comment)) {
+			e.comment = "";
+		}
+	}
+};
diff --git a/jsdoc.json b/jsdoc.json
@@ -1,60 +1,62 @@
 {
-    "tags": {
-        "allowUnknownTags": false
-    },
-    "source": {
-        "include": ["README.md", "index.js"],
-        "includePattern": ".+\\.js$",
-        "excludePattern": "(node_modules(\\\\|/))"
-    },
-    "plugins": [],
-    "opts": {
-        "template": "node_modules/docdash/",
-        "encoding": "utf8",
-        "destination": "jsdocs/",
-        "recurse": true,
-        "verbose": true,
-        "access": "public"
-    },
-    "templates": {
-        "cleverLinks": false,
-        "monospaceLinks": false,
-        "default": {
-            "useLongnameInNav": true
-        }
-    },
-    "openGraph": {
-        "title": "UI5 Tooling - API Reference",
-        "type": "website",
-        "image": "https://sap.github.io/ui5-tooling/docs/images/UI5_logo_wide.png",
-        "site_name": "UI5 Tooling - API Reference",
-        "url": "https://sap.github.io/ui5-tooling/"
-    },
-    "docdash": {
-        "sectionOrder": [
-            "Modules",
-            "Namespaces",
-            "Classes",
-            "Externals",
-            "Events",
-            "Mixins",
-            "Tutorials",
-            "Interfaces"
-        ],
-        "meta": {
-            "title": "UI5 Tooling - API Reference - UI5 Project",
-            "description": "UI5 Tooling - API Reference - UI5 Project",
-            "keyword": "openui5 sapui5 ui5 build development tool api reference"
-        },
-        "search": true,
-        "wrap": true,
-        "menu": {
-            "GitHub": {
-                "href": "https://github.com/SAP/ui5-project",
-                "target": "_blank",
-                "class": "menu-item",
-                "id": "github_link"
-            }
-        }
-    }
+	"tags": {
+		"allowUnknownTags": false
+	},
+	"source": {
+		"include": ["README.md", "index.js"],
+		"includePattern": ".+\\.js$",
+		"excludePattern": "(node_modules(\\\\|/))"
+	},
+	"plugins": [
+		"./jsdoc-plugin"
+	],
+	"opts": {
+		"template": "node_modules/docdash/",
+		"encoding": "utf8",
+		"destination": "jsdocs/",
+		"recurse": true,
+		"verbose": true,
+		"access": "public"
+	},
+	"templates": {
+		"cleverLinks": false,
+		"monospaceLinks": false,
+		"default": {
+			"useLongnameInNav": true
+		}
+	},
+	"openGraph": {
+		"title": "UI5 Tooling - API Reference",
+		"type": "website",
+		"image": "https://sap.github.io/ui5-tooling/docs/images/UI5_logo_wide.png",
+		"site_name": "UI5 Tooling - API Reference",
+		"url": "https://sap.github.io/ui5-tooling/"
+	},
+	"docdash": {
+		"sectionOrder": [
+			"Modules",
+			"Namespaces",
+			"Classes",
+			"Externals",
+			"Events",
+			"Mixins",
+			"Tutorials",
+			"Interfaces"
+		],
+		"meta": {
+			"title": "UI5 Tooling - API Reference - UI5 Project",
+			"description": "UI5 Tooling - API Reference - UI5 Project",
+			"keyword": "openui5 sapui5 ui5 build development tool api reference"
+		},
+		"search": true,
+		"wrap": true,
+		"menu": {
+			"GitHub": {
+				"href": "https://github.com/SAP/ui5-project",
+				"target": "_blank",
+				"class": "menu-item",
+				"id": "github_link"
+			}
+		}
+	}
 }