Class CommentTagParser<CustomTags>

Parser for extracting JSDoc and TSDoc tags from comments. Will extract all valid JSDoc tags and TSDoc tags that is able to parse. If a tag exists in both standard and TSDoc extends it: the TSDoc tag will be used.

Type Parameters

CustomTags extends string = AllTagsName

Hierarchy

CommentTagParser

Implements

ICommentTagParser<CustomTags>

Index

Constructors

constructor

new CommentTagParser<CustomTags>(__namedParameters): CommentTagParser<CustomTags>
Type Parameters
- CustomTags extends string = AllTagsName
Parameters
- __namedParameters: CommentTagParserConfig<CustomTags>
Returns CommentTagParser<CustomTags>
- Defined in packages/core/src/lib/comment-tag-parser/index.ts:62

Properties

`Private` _testBlockDocComments

_testBlockDocComments: TestBlockDocComment<CustomTags>[] = []

`Private` customTags

customTags: CustomTags[]

`Private` `Optional` excludeTags

excludeTags?: (AllTagsName | CustomTags)[]

`Private` getTypeChecker

getTypeChecker: (() => TypeChecker)

Type declaration

- (): TypeChecker
- Returns TypeChecker

`Private` sourceFile

sourceFile: SourceFile

`Private` sourceFileBuffer

sourceFileBuffer: string

`Private` tagSeparator

tagSeparator: string

`Private` `Optional` testBlockTagNames

testBlockTagNames?: TestBlockName[]

`Private` tsDocParser

tsDocParser: TSDocParser

Accessors

testBlockDocComments

get testBlockDocComments(): TestBlockDocComment<CustomTags>[]
Returns TestBlockDocComment<CustomTags>[]
Implementation of ICommentTagParser.testBlockDocComments
- Defined in packages/core/src/lib/comment-tag-parser/index.ts:83

Methods

`Private` apply

apply(tagName, testBlockTagName): boolean
Parameters
- tagName: AllTagsName | CustomTags
- testBlockTagName: TestBlockName
Returns boolean
- Defined in packages/core/src/lib/comment-tag-parser/index.ts:87

`Private` commentRangeToTestBlockDocComment

commentRangeToTestBlockDocComment(node, title, jsDocs?): ((comment) => TestBlockDocComment<CustomTags>)
Parameters
- node: CallExpression
- title: string
- Optional jsDocs: JSDoc[]
Returns ((comment) => TestBlockDocComment<CustomTags>)
- - (comment): TestBlockDocComment<CustomTags>
  - Parameters
    - comment: CommentRange
    Returns TestBlockDocComment<CustomTags>
- Defined in packages/core/src/lib/comment-tag-parser/index.ts:188

`Private` findTestBlockDocComments

findTestBlockDocComments(node): void
Parameters
- node: Node
Returns void
- Defined in packages/core/src/lib/comment-tag-parser/index.ts:206

`Private` getCustomTags

getCustomTags(): {
[k: string]: T;
}
Returns {
[k: string]: T;
}
- [k: string]: T
- Defined in packages/core/src/lib/comment-tag-parser/index.ts:134

`Private` getJSDocComments

getJSDocComments(title, testBlockName, jsDocs): Partial<Record<AllTagsName | CustomTags, TestBlockTag<CustomTags>>>
Parameters
- title: string
- testBlockName: TestBlockName
- jsDocs: JSDoc[]
Returns Partial<Record<AllTagsName | CustomTags, TestBlockTag<CustomTags>>>
- Defined in packages/core/src/lib/comment-tag-parser/index.ts:108

`Private` getTagsFromDocComment

getTagsFromDocComment(docComment, testBlockName, testTitle): Partial<Record<AllTagsName | CustomTags, TestBlockTag<CustomTags>>>
Parameters
- docComment: DocComment
- testBlockName: TestBlockName
- testTitle: string
Returns Partial<Record<AllTagsName | CustomTags, TestBlockTag<CustomTags>>>
- Defined in packages/core/src/lib/comment-tag-parser/index.ts:138

`Private` getTestTitle

getTestTitle(node): string
Parameters
- node: CallExpression
Returns string
- Defined in packages/core/src/lib/comment-tag-parser/index.ts:95

`Private` parseTsDocCommentRange

parseTsDocCommentRange(__namedParameters): DocComment
Parameters
- __namedParameters: CommentRange
Returns DocComment
- Defined in packages/core/src/lib/comment-tag-parser/index.ts:103

Class CommentTagParser<CustomTags>

Type Parameters

CustomTags extends string = AllTagsName

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

CustomTags extends string = AllTagsName

Parameters

__namedParameters: CommentTagParserConfig<CustomTags>

Returns CommentTagParser<CustomTags>

Properties

Private _testBlockDocComments

Private customTags

Private Optional excludeTags

Private getTypeChecker

Type declaration

Returns TypeChecker

Private sourceFile

Private sourceFileBuffer

Private tagSeparator

Private Optional testBlockTagNames

Private tsDocParser

Accessors

testBlockDocComments

Returns TestBlockDocComment<CustomTags>[]

Methods

Private apply

Parameters

tagName: AllTagsName | CustomTags

testBlockTagName: TestBlockName

Returns boolean

Private commentRangeToTestBlockDocComment

Parameters

node: CallExpression

title: string

Optional jsDocs: JSDoc[]

Returns ((comment) => TestBlockDocComment<CustomTags>)

Parameters

comment: CommentRange

Returns TestBlockDocComment<CustomTags>

Private findTestBlockDocComments

Parameters

node: Node

Returns void

Private getCustomTags

Returns { [k: string]: T; }

[k: string]: T

Private getJSDocComments

Parameters

title: string

testBlockName: TestBlockName

jsDocs: JSDoc[]

Returns Partial<Record<AllTagsName | CustomTags, TestBlockTag<CustomTags>>>

Private getTagsFromDocComment

Parameters

docComment: DocComment

testBlockName: TestBlockName

testTitle: string

Returns Partial<Record<AllTagsName | CustomTags, TestBlockTag<CustomTags>>>

Private getTestTitle

Parameters

node: CallExpression

Returns string

Private parseTsDocCommentRange

Parameters

__namedParameters: CommentRange

Returns DocComment

Settings

Member Visibility

Theme

On This Page

`Private` _testBlockDocComments

`Private` customTags

`Private` `Optional` excludeTags

`Private` getTypeChecker

`Private` sourceFile

`Private` sourceFileBuffer

`Private` tagSeparator

`Private` `Optional` testBlockTagNames

`Private` tsDocParser

`Private` apply

`Private` commentRangeToTestBlockDocComment

`Optional` jsDocs: JSDoc[]

`Private` findTestBlockDocComments

`Private` getCustomTags

Returns {
[k: string]: T;
}

`Private` getJSDocComments

`Private` getTagsFromDocComment

`Private` getTestTitle

`Private` parseTsDocCommentRange