Remove moduleRoot config option

Author: Daniel-Knights

README.md

@@ -14,21 +14,10 @@ To configure JSDoc to use the plugin, add the following to the JSDoc configurati
 "plugins": [
   "jsdoc-plugin-typescript"
 ],
-"typescript": {
-  "moduleRoot": "src" // optional
-}
 ```
 
 See http://usejsdoc.org/about-configuring-jsdoc.html for more details on how to configure JSDoc.
 
-If `typescript.moduleRoot` is specified, the plugin will assume module ids are relative to that directory and format them as such. For example, `@type {import("./folder/file").Class}` will be converted to `@type {module:folder/file.Class}`. The file extension is removed along with any leading `../` segments (if the referenced module is outside `moduleRoot`).
-
-In the absence of `typescript.moduleRoot`, the plugin will mirror the method JSDoc uses to assign module ids:
-
-1. Parse the referenced module for an `@module` tag.
-2. If a tag is found and it has an explicit id, use that.
-3. If a tag is found, but it doesn't have an explicit id, use the module's file path relative to the nearest shared parent directory, and remove the file extension.
-
 ## What this plugin does
 
 When using the `class` keyword for defining classes (required by TypeScript), JSDoc requires `@classdesc` and `@extends` annotations. With this plugin, no `@classdesc` and `@extends` annotations are needed.
@@ -121,6 +110,14 @@ This syntax is also used when referring to types of `@typedef`s and `@enum`s.
  */
 ```
 
+## Module id resolution
+
+For resolving module ids, this plugin mirrors the method used by JSDoc:
+
+1. Parse the referenced module for an `@module` tag.
+2. If a tag is found and it has an explicit id, use that.
+3. If a tag is found, but it doesn't have an explicit id, use the module's file path relative to the nearest shared parent directory, and remove the file extension.
+
 ## Contributing
 
 If you are interested in making a contribution to the project, please see the [contributing page](./contributing.md) for details on getting your development environment set up.

index.js

@@ -4,34 +4,18 @@ const fs = require('fs');
 const env = require('jsdoc/env'); // eslint-disable-line import/no-unresolved
 const addInherited = require('jsdoc/augment').addInherited; // eslint-disable-line import/no-unresolved
 
-const config = env.conf;
-const moduleRoot = config.typescript ? config.typescript.moduleRoot : undefined;
-const moduleRootAbsolute = moduleRoot
-  ? path.join(process.cwd(), moduleRoot)
-  : undefined;
-
-if (moduleRootAbsolute && !fs.existsSync(moduleRootAbsolute)) {
-  throw new Error(
-    'Directory "' +
-      moduleRootAbsolute +
-      '" does not exist. Check the "typescript.moduleRoot" config option for jsdoc-plugin-typescript',
-  );
-}
-
 const importRegEx =
   /import\(["']([^"']*)["']\)(?:\.([^ \.\|\}><,\)=#\n]*))?([ \.\|\}><,\)=#\n])/g;
 const typedefRegEx = /@typedef \{[^\}]*\} (\S+)/g;
 const noClassdescRegEx = /@(typedef|module|type)/;
 const extensionReplaceRegEx = /\.m?js$/;
 const extensionEnsureRegEx = /(\.js)?$/;
 const slashRegEx = /\\/g;
-const leadingPathSegmentRegEx = /^(.?.[/\\])+/;
 
 const moduleInfos = {};
 const fileNodes = {};
 const resolvedPathCache = new Set();
 
-// Without explicit module ids, JSDoc will use the nearest shared parent directory
 /** @type {string} */
 let implicitModuleRoot;
 
@@ -76,14 +60,6 @@ function getModuleId(modulePath) {
     return moduleInfos[modulePath].id;
   }
 
-  // Use moduleRoot if set
-  if (moduleRootAbsolute) {
-    return path
-      .relative(moduleRootAbsolute, modulePath)
-      .replace(extensionReplaceRegEx, '')
-      .replace(leadingPathSegmentRegEx, '');
-  }
-
   // Search for explicit module id
   if (fileNodes[modulePath]) {
     for (const comment of fileNodes[modulePath].comments) {

test/template/config.json

@@ -5,17 +5,10 @@
     "destination": "test/dest/actual.json"
   },
   "source": {
-    "include": [
-      "test/src"
-    ]
+    "include": ["test/src"]
   },
   "tags": {
     "allowUnknownTags": true
   },
-  "plugins": [
-    "index.js"
-  ],
-  "typescript": {
-    "moduleRoot": "test/src"
-  }
+  "plugins": ["index.js"]
 }