@microsoft/tsdoc - npm Package Compare versions

Comparing version 0.12.6 to 0.12.7

CHANGELOG.json

@@ -5,2 +5,14 @@ {
     {
+      "version": "0.12.7",
+      "tag": "@microsoft/tsdoc_v0.12.7",
+      "date": "Fri, 01 Mar 2019 06:39:52 GMT",
+      "comments": {
+        "patch": [
+          {
+            "comment": "Add new API TSDocConfiguration.isKnownMessageId()"
+          }
+        ]
+      }
+    },
+    {
       "version": "0.12.6",
@@ -7,0 +19,0 @@ "tag": "@microsoft/tsdoc_v0.12.6",

CHANGELOG.md

 # Change Log - @microsoft/tsdoc
 
-This log was last generated on Thu, 28 Feb 2019 01:29:39 GMT and should not be manually modified.
+This log was last generated on Fri, 01 Mar 2019 06:39:52 GMT and should not be manually modified.
 
+## 0.12.7
+Fri, 01 Mar 2019 06:39:52 GMT
+
+### Patches
+
+- Add new API TSDocConfiguration.isKnownMessageId()
+
 ## 0.12.6
@@ -6,0 +13,0 @@ Thu, 28 Feb 2019 01:29:39 GMT

lib/configuration/TSDocConfiguration.d.ts

 import { TSDocTagDefinition } from './TSDocTagDefinition';
 import { TSDocValidationConfiguration } from './TSDocValidationConfiguration';
 import { DocNodeManager } from './DocNodeManager';
+import { TSDocMessageId } from '../parser/TSDocMessageId';
 /**
@@ -82,3 +83,13 @@ * Configuration for the TSDocParser.
     setSupportForTags(tagDefinitions: ReadonlyArray<TSDocTagDefinition>, supported: boolean): void;
+    /**
+     * Returns true if the specified {@link TSDocMessageId} string is implemented by this release of the TSDoc parser.
+     * This can be used to detect misspelled identifiers.
+     *
+     * @privateRemarks
+     *
+     * Why this API is associated with TSDocConfiguration:  In the future, if we enable support for custom extensions
+     * of the TSDoc parser, we may provide a way to register custom message identifiers.
+     */
+    isKnownMessageId(messageId: TSDocMessageId | string): boolean;
     private _requireTagToBeDefined;
 }

lib/configuration/TSDocConfiguration.js

@@ -7,2 +7,3 @@ "use strict";
 var BuiltInDocNodes_1 = require("../nodes/BuiltInDocNodes");
+var TSDocMessageId_1 = require("../parser/TSDocMessageId");
 /**
@@ -155,2 +156,14 @@ * Configuration for the TSDocParser.
     };
+    /**
+     * Returns true if the specified {@link TSDocMessageId} string is implemented by this release of the TSDoc parser.
+     * This can be used to detect misspelled identifiers.
+     *
+     * @privateRemarks
+     *
+     * Why this API is associated with TSDocConfiguration:  In the future, if we enable support for custom extensions
+     * of the TSDoc parser, we may provide a way to register custom message identifiers.
+     */
+    TSDocConfiguration.prototype.isKnownMessageId = function (messageId) {
+        return TSDocMessageId_1.allTsdocMessageIds.has(messageId);
+    };
     TSDocConfiguration.prototype._requireTagToBeDefined = function (tagDefinition) {
@@ -157,0 +170,0 @@ var matching = this._tagDefinitionsByName.get(tagDefinition.tagNameWithUpperCase);

lib/parser/ParserMessage.d.ts

@@ -19,2 +19,5 @@ import { TextRange } from './TextRange';
 export declare class ParserMessage {
+    /**
+     * A string that uniquely identifies the messages reported by the TSDoc parser.
+     */
     readonly messageId: TSDocMessageId;
@@ -21,0 +24,0 @@ /**

lib/parser/TSDocMessageId.d.ts

 /**
- * Message IDs for messages rpoted by the TSDoc parser.
+ * Unique identifiers for messages reported by the TSDoc parser.
  *
@@ -7,2 +7,5 @@ * @remarks
  * These strings are possible values for the {@link ParserMessage.messageId} property.
+ * These identifiers can be used to suppress or configure the reporting of individual messages.
+ * They are also useful when searching for help about a particular error.
+ *
  * @public
@@ -270,1 +273,2 @@ */
 }
+export declare const allTsdocMessageIds: Set<string>;

lib/parser/TSDocMessageId.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+// Exposed via ParserMessage.isValidMessageId()
+exports.allTsdocMessageIds = new Set([
+    'tsdoc-comment-not-found',
+    'tsdoc-comment-missing-opening-delimiter',
+    'tsdoc-comment-missing-closing-delimiter',
+    'tsdoc-extra-inheritdoc-tag',
+    'tsdoc-escape-right-brace',
+    'tsdoc-escape-greater-than',
+    'tsdoc-missing-deprecation-message',
+    'tsdoc-inheritdoc-incompatible-tag',
+    'tsdoc-inheritdoc-incompatible-summary',
+    'tsdoc-inline-tag-missing-braces',
+    'tsdoc-tag-should-not-have-braces',
+    'tsdoc-unsupported-tag',
+    'tsdoc-undefined-tag',
+    'tsdoc-param-tag-with-invalid-name',
+    'tsdoc-param-tag-missing-hyphen',
+    'tsdoc-unnecessary-backslash',
+    'tsdoc-missing-tag',
+    'tsdoc-at-sign-in-word',
+    'tsdoc-at-sign-without-tag-name',
+    'tsdoc-malformed-inline-tag',
+    'tsdoc-malformed-tag-name',
+    'tsdoc-text-after-tag',
+    'tsdoc-inline-tag-missing-right-brace',
+    'tsdoc-inline-tag-unescaped-brace',
+    'tsdoc-inheritdoc-tag-syntax',
+    'tsdoc-link-tag-empty',
+    'tsdoc-link-tag-unescaped-text',
+    'tsdoc-link-tag-destination-syntax',
+    'tsdoc-link-tag-invalid-url',
+    'tsdoc-reference-missing-hash',
+    'tsdoc-reference-hash-syntax',
+    'tsdoc-reference-malformed-package-name',
+    'tsdoc-reference-malformed-import-path',
+    'tsdoc-missing-reference',
+    'tsdoc-reference-missing-dot',
+    'tsdoc-reference-selector-missing-parens',
+    'tsdoc-reference-missing-colon',
+    'tsdoc-reference-missing-right-paren',
+    'tsdoc-reference-symbol-syntax',
+    'tsdoc-reference-missing-right-bracket',
+    'tsdoc-reference-missing-quote',
+    'tsdoc-reference-empty-identifier',
+    'tsdoc-reference-missing-identifier',
+    'tsdoc-reference-unquoted-identifier',
+    'tsdoc-reference-missing-label',
+    'tsdoc-reference-selector-syntax',
+    'tsdoc-html-tag-missing-greater-than',
+    'tsdoc-html-tag-missing-equals',
+    'tsdoc-html-tag-missing-string',
+    'tsdoc-html-string-missing-quote',
+    'tsdoc-text-after-html-string',
+    'tsdoc-missing-html-end-tag',
+    'tsdoc-malformed-html-name',
+    'tsdoc-code-fence-opening-indent',
+    'tsdoc-code-fence-specifier-syntax',
+    'tsdoc-code-fence-closing-indent',
+    'tsdoc-code-fence-missing-delimiter',
+    'tsdoc-code-fence-closing-syntax',
+    'tsdoc-code-span-empty',
+    'tsdoc-code-span-missing-delimiter'
+]);
 //# sourceMappingURL=TSDocMessageId.js.map

package.json

 {
   "name": "@microsoft/tsdoc",
-  "version": "0.12.6",
+  "version": "0.12.7",
   "description": "A parser for the TypeScript doc comment syntax",
@@ -5,0 +5,0 @@ "keywords": [

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

650019

increased by0.83%

Lines of code

11322

increased by0.95%

No dependency changes