fixup! Add unit tests for x-tsdoc-tag support in node-core-library and heft-json-schema-typings-plugin.

Author: iclanton

heft-plugins/heft-json-schema-typings-plugin/src/test/TsDocTagHelpers.test.ts

@@ -0,0 +1,63 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+import { _addTsDocTagToExports } from '../TsDocTagHelpers';
+
+describe(_addTsDocTagToExports.name, () => {
+  test('injects tag into an existing JSDoc comment before an export', () => {
+    const input: string = ['/**', ' * A description.', ' */', 'export type Foo = {};'].join('\n');
+
+    expect(_addTsDocTagToExports(input, '@beta')).toMatchSnapshot();
+  });
+
+  test('creates a new JSDoc block for an export without a preceding comment', () => {
+    const input: string = 'export type Foo = {};';
+
+    expect(_addTsDocTagToExports(input, '@public')).toMatchSnapshot();
+  });
+
+  test('handles multiple exports with and without JSDoc comments', () => {
+    const input: string = [
+      '/**',
+      ' * First type.',
+      ' */',
+      'export type Foo = {};',
+      '',
+      'export type Bar = {};'
+    ].join('\n');
+
+    expect(_addTsDocTagToExports(input, '@beta')).toMatchSnapshot();
+  });
+
+  test('normalizes CRLF line endings to LF', () => {
+    const input: string = '/**\r\n * A description.\r\n */\r\nexport type Foo = {};';
+
+    expect(_addTsDocTagToExports(input, '@beta')).toMatchSnapshot();
+  });
+
+  test('does not double-tag an export that already has a JSDoc block', () => {
+    const input: string = [
+      '/**',
+      ' * Already documented.',
+      ' */',
+      'export interface IConfig {',
+      '  name: string;',
+      '}'
+    ].join('\n');
+
+    const result: string = _addTsDocTagToExports(input, '@public');
+
+    // The tag should appear exactly once
+    const tagOccurrences: number = (result.match(/@public/g) || []).length;
+    expect(tagOccurrences).toBe(1);
+    expect(result).toMatchSnapshot();
+  });
+
+  test('does not modify non-export lines', () => {
+    const input: string = ['// A leading comment', 'const internal = 1;', '', 'export type Foo = {};'].join(
+      '\n'
+    );
+
+    expect(_addTsDocTagToExports(input, '@beta')).toMatchSnapshot();
+  });
+});