Add new API TSDocConfiguration.allTsdocMessageIds

Author: octogonz

tsdoc/src/configuration/TSDocConfiguration.ts

@@ -3,7 +3,7 @@ import { TSDocTagDefinition } from './TSDocTagDefinition';
 import { TSDocValidationConfiguration } from './TSDocValidationConfiguration';
 import { DocNodeManager } from './DocNodeManager';
 import { BuiltInDocNodes } from '../nodes/BuiltInDocNodes';
-import { TSDocMessageId, allTsdocMessageIds } from '../parser/TSDocMessageId';
+import { TSDocMessageId, allTsdocMessageIds, allTsdocMessageIdsSet } from '../parser/TSDocMessageId';
 
 /**
  * Configuration for the TSDocParser.
@@ -170,7 +170,19 @@ export class TSDocConfiguration {
    * of the TSDoc parser, we may provide a way to register custom message identifiers.
    */
   public isKnownMessageId(messageId: TSDocMessageId | string): boolean {
-    return allTsdocMessageIds.has(messageId);
+    return allTsdocMessageIdsSet.has(messageId);
+  }
+
+  /**
+   * Returns the list of {@link TSDocMessageId} strings that are implemented by this release of the TSDoc parser.
+   *
+   * @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.
+   */
+  public get allTsdocMessageIds(): ReadonlyArray<TSDocMessageId> {
+    return allTsdocMessageIds as ReadonlyArray<TSDocMessageId>;
   }
 
   private _requireTagToBeDefined(tagDefinition: TSDocTagDefinition): void {

tsdoc/src/parser/TSDocMessageId.ts

@@ -336,8 +336,8 @@ export const enum TSDocMessageId {
   CodeSpanMissingDelimiter = 'tsdoc-code-span-missing-delimiter'
 }
 
-// Exposed via ParserMessage.isValidMessageId()
-export const allTsdocMessageIds: Set<string> = new Set<string>([
+// Exposed via TSDocConfiguration.allTsdocMessageIds()
+export const allTsdocMessageIds: string[] = [
   'tsdoc-comment-not-found',
   'tsdoc-comment-missing-opening-delimiter',
   'tsdoc-comment-missing-closing-delimiter',
@@ -398,4 +398,7 @@ export const allTsdocMessageIds: Set<string> = new Set<string>([
   'tsdoc-code-fence-closing-syntax',
   'tsdoc-code-span-empty',
   'tsdoc-code-span-missing-delimiter'
-]);
+];
+allTsdocMessageIds.sort();
+
+export const allTsdocMessageIdsSet: ReadonlySet<string> = new Set<string>(allTsdocMessageIds);