Merge pull request #194 from microsoft/octogonz/eslint-plugin-updates

eslint-plugin-tsdoc: A couple minor improvements

Author: octogonz

common/changes/eslint-plugin-tsdoc/octogonz-eslint-plugin-updates_2019-11-09-04-47.json

@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "eslint-plugin-tsdoc",
+      "comment": "Improve error location accuracy",
+      "type": "patch"
+    }
+  ],
+  "packageName": "eslint-plugin-tsdoc",
+  "email": "4673363+octogonz@users.noreply.github.com"
+}

common/changes/eslint-plugin-tsdoc/octogonz-eslint-plugin-updates_2019-11-09-04-48.json

@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "eslint-plugin-tsdoc",
+      "comment": "Generalize the TSDoc parser configuration to allow any standard tag",
+      "type": "patch"
+    }
+  ],
+  "packageName": "eslint-plugin-tsdoc",
+  "email": "4673363+octogonz@users.noreply.github.com"
+}

eslint-plugin/src/index.ts

@@ -1,5 +1,13 @@
 
-import { ParserMessageLog, TSDocParser } from "@microsoft/tsdoc";
+import {
+  ParserMessageLog,
+  TSDocParser,
+  TextRange,
+  TSDocConfiguration,
+  StandardTags,
+  TSDocTagDefinition,
+  TSDocTagSyntaxKind
+} from "@microsoft/tsdoc";
 import { allTsdocMessageIds } from "@microsoft/tsdoc/lib/parser/TSDocMessageId";
 import * as eslint from "eslint";
 import * as ESTree from "estree";
@@ -31,16 +39,41 @@ const plugin: IPlugin = {
         }
       },
       create: (context: eslint.Rule.RuleContext) => {
-        const tsDocParser: TSDocParser = new TSDocParser();
+        const tsdocConfiguration: TSDocConfiguration = new TSDocConfiguration();
+
+        // Create 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);
+
+        const tsdocParser: TSDocParser = new TSDocParser(tsdocConfiguration);
+
         const sourceCode: eslint.SourceCode = context.getSourceCode();
         const checkCommentBlocks: (node: ESTree.Node) => void = function (node: ESTree.Node) {
           const commentToken: eslint.AST.Token | null = sourceCode.getJSDocComment(node);
           if (commentToken) {
-            const commentString: string = "/*" + commentToken.value + "*/";
-            const results: ParserMessageLog = tsDocParser.parseString(commentString).log;
+            const textRange: TextRange = TextRange.fromStringRange(sourceCode.text, commentToken.range[0], commentToken.range[1]);
+            const results: ParserMessageLog = tsdocParser.parseRange(textRange).log;
             for (const message of results.messages) {
               context.report({
-                loc: commentToken.loc,
+                loc: {
+                  start: sourceCode.getLocFromIndex(message.textRange.pos),
+                  end: sourceCode.getLocFromIndex(message.textRange.end)
+                },
                 messageId: message.messageId,
                 data: {
                   unformattedText: message.unformattedText