From bc3ebb793666c0d7e58cf428ba12465a7b290cbe Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 9 Feb 2024 17:55:17 +0100 Subject: chore(deps)!: update dependency typescript to v5 (#1953) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: ST-DDT --- .../apidoc/__snapshots__/signature.spec.ts.snap | 20 ++++++++++---------- test/scripts/apidoc/signature.example.ts | 2 +- test/scripts/apidoc/verify-jsdoc-tags.spec.ts | 2 +- 3 files changed, 12 insertions(+), 12 deletions(-) (limited to 'test/scripts') diff --git a/test/scripts/apidoc/__snapshots__/signature.spec.ts.snap b/test/scripts/apidoc/__snapshots__/signature.spec.ts.snap index d62c6c4c..37a9f754 100644 --- a/test/scripts/apidoc/__snapshots__/signature.spec.ts.snap +++ b/test/scripts/apidoc/__snapshots__/signature.spec.ts.snap @@ -130,7 +130,7 @@ exports[`signature > analyzeSignature() > literalUnionParamMethod 1`] = ` "deprecated": undefined, "description": "

Test with LiteralUnion.

", - "examples": "
ts
literalUnionParamMethod(value: 'a' | 'b' | string, namedValue: 'a' | 'b' | string, array: readonly Array<'a' | 'b' | string>, namedArray: readonly Array<'a' | 'b' | string>, mixed: 'a' | 'b' | string | readonly Array<'a' | 'b' | string>, namedMixed: 'a' | 'b' | string | readonly Array<'a' | 'b' | string>): string
+ "examples": "
ts
literalUnionParamMethod(value: 'a' | 'b' | ?, namedValue: 'a' | 'b' | ?, array: readonly Array<'a' | 'b' | ?>, namedArray: readonly Array<'a' | 'b' | ?>, mixed: 'a' | 'b' | ? | readonly Array<'a' | 'b' | ?>, namedMixed: 'a' | 'b' | ? | readonly Array<'a' | 'b' | ?>): string
", "name": "literalUnionParamMethod", "parameters": [ @@ -139,42 +139,42 @@ exports[`signature > analyzeSignature() > literalUnionParamMethod 1`] = ` "description": "

'a' or 'b'.

", "name": "value", - "type": "'a' | 'b' | string", + "type": "'a' | 'b' | ?", }, { "default": undefined, "description": "

'a' or 'b'.

", "name": "namedValue", - "type": "'a' | 'b' | string", + "type": "'a' | 'b' | ?", }, { "default": undefined, "description": "

Array of 'a' or 'b'.

", "name": "array", - "type": "Array<'a' | 'b' | string>", + "type": "Array<'a' | 'b' | ?>", }, { "default": undefined, "description": "

Array of 'a' or 'b'.

", "name": "namedArray", - "type": "Array<'a' | 'b' | string>", + "type": "Array<'a' | 'b' | ?>", }, { "default": undefined, "description": "

Value 'a' or 'b' or an array thereof.

", "name": "mixed", - "type": "'a' | 'b' | string | Array<'a' | 'b' | string>", + "type": "'a' | 'b' | ? | Array<'a' | 'b' | ?>", }, { "default": undefined, "description": "

Value 'a' or 'b' or an array thereof.

", "name": "namedMixed", - "type": "'a' | 'b' | string | Array<'a' | 'b' | string>", + "type": "'a' | 'b' | ? | Array<'a' | 'b' | ?>", }, ], "returns": "string", @@ -565,8 +565,8 @@ exports[`signature > analyzeSignature() > optionsParamMethod 1`] = ` b: string, c: boolean, d: () => string, - e: 'a' | 'b' | string -}): number + e: 'a' | 'b' | ? +}): number
", "name": "optionsParamMethod", "parameters": [ @@ -610,7 +610,7 @@ exports[`signature > analyzeSignature() > optionsParamMethod 1`] = ` "description": "

A parameter with inline documentation.

", "name": "options.e", - "type": "'a' | 'b' | string", + "type": "'a' | 'b' | ?", }, ], "returns": "number", diff --git a/test/scripts/apidoc/signature.example.ts b/test/scripts/apidoc/signature.example.ts index 2f62057b..af04ee90 100644 --- a/test/scripts/apidoc/signature.example.ts +++ b/test/scripts/apidoc/signature.example.ts @@ -4,7 +4,7 @@ import type { AlphaNumericChar } from '../../../src/modules/string'; import type { LiteralUnion } from '../../../src/utils/types'; // explicitly export types so they show up in the docs as decomposed types export type { NumberColorFormat, StringColorFormat } from '../../../src'; -export { Casing, ColorFormat, AlphaNumericChar, LiteralUnion }; +export { AlphaNumericChar, Casing, ColorFormat, LiteralUnion }; /** * Parameter options type with default from signature. diff --git a/test/scripts/apidoc/verify-jsdoc-tags.spec.ts b/test/scripts/apidoc/verify-jsdoc-tags.spec.ts index b14523e1..7d6d8554 100644 --- a/test/scripts/apidoc/verify-jsdoc-tags.spec.ts +++ b/test/scripts/apidoc/verify-jsdoc-tags.spec.ts @@ -7,6 +7,7 @@ import { afterAll, beforeAll, describe, expect, it, vi } from 'vitest'; import { initMarkdownRenderer } from '../../../scripts/apidoc/markdown'; import { analyzeSignature } from '../../../scripts/apidoc/signature'; import { + MISSING_DESCRIPTION, extractDeprecated, extractDescription, extractJoinedRawExamples, @@ -16,7 +17,6 @@ import { extractSince, extractSummaryDefault, extractTagContent, - MISSING_DESCRIPTION, } from '../../../scripts/apidoc/typedoc'; import { loadProjectModules } from './utils'; -- cgit v1.2.3