Update eslint-plugin to use tsdoc-config

Author: octogonz

eslint-plugin/package.json

@@ -26,7 +26,8 @@
     "test": "node lib/tests/index.js"
   },
   "dependencies": {
-    "@microsoft/tsdoc": "0.12.15"
+    "@microsoft/tsdoc": "0.12.15",
+    "@microsoft/tsdoc-config": "0.12.15"
   },
   "devDependencies": {
     "@rushstack/eslint-config": "0.4.0",

eslint-plugin/src/index.ts

@@ -8,14 +8,17 @@ import {
   TSDocTagSyntaxKind,
   ParserContext
 } from "@microsoft/tsdoc";
+import {
+  TSDocConfigFile
+} from '@microsoft/tsdoc-config';
 import * as eslint from "eslint";
 import * as ESTree from "estree";
 
-const messageIds: {[x: string]: string} = {};
+const tsdocMessageIds: {[x: string]: string} = {};
 
 const defaultTSDocConfiguration: TSDocConfiguration = new TSDocConfiguration()
 defaultTSDocConfiguration.allTsdocMessageIds.forEach((messageId: string) => {
-  messageIds[messageId] = `${messageId}: {{ unformattedText }}`;
+  tsdocMessageIds[messageId] = `${messageId}: {{unformattedText}}`;
 });
 
 interface IPlugin {
@@ -28,7 +31,7 @@ const plugin: IPlugin = {
     // from the NPM package name, and then appending this string.
     "syntax": {
       meta: {
-        messages: messageIds,
+        messages: tsdocMessageIds,
         type: "problem",
         docs: {
           description: "Validates that TypeScript documentation comments conform to the TSDoc standard",
@@ -41,24 +44,32 @@ const plugin: IPlugin = {
       create: (context: eslint.Rule.RuleContext) => {
         const tsdocConfiguration: TSDocConfiguration = new TSDocConfiguration();
 
-        // Create a lax configuration that allows every standard tag regardless of standardization group
-        tsdocConfiguration.setSupportForTags(StandardTags.allDefinitions, true);
+        const sourceFilePath: string = context.getFilename();
+        const tsdocConfigFile: TSDocConfigFile = TSDocConfigFile.loadForFolder(sourceFilePath);
+
+        if (!tsdocConfigFile.fileNotFound) {
+          tsdocConfigFile.configureParser(tsdocConfiguration);
+        } else {
+          // If we weren't able to find a tsdoc-config.json file, then by default we will use a lax configuration
+          // that allows every standard tag regardless of standardization group.
+          tsdocConfiguration.setSupportForTags(StandardTags.allDefinitions, true);
 
-        // Also add the three AEDoc tags
-        tsdocConfiguration.addTagDefinitions([
-          new TSDocTagDefinition({
-            tagName: '@betaDocumentation',
-            syntaxKind: TSDocTagSyntaxKind.ModifierTag
-          }),
-          new TSDocTagDefinition({
-            tagName: '@internalRemarks',
-            syntaxKind: TSDocTagSyntaxKind.BlockTag
-          }),
-          new TSDocTagDefinition({
-            tagName: '@preapproved',
-            syntaxKind: TSDocTagSyntaxKind.ModifierTag
-          })
-        ], true);
+          // Also allow the three AEDoc tags.
+          tsdocConfiguration.addTagDefinitions([
+            new TSDocTagDefinition({
+              tagName: '@betaDocumentation',
+              syntaxKind: TSDocTagSyntaxKind.ModifierTag
+            }),
+            new TSDocTagDefinition({
+              tagName: '@internalRemarks',
+              syntaxKind: TSDocTagSyntaxKind.BlockTag
+            }),
+            new TSDocTagDefinition({
+              tagName: '@preapproved',
+              syntaxKind: TSDocTagSyntaxKind.ModifierTag
+            })
+          ], true);
+        }
 
         const tsdocParser: TSDocParser = new TSDocParser(tsdocConfiguration);