Skip to content

Commit 0c80adf

Browse files
Ma11hewThomasMa11hewThomas
authored
feat: add organizeTestsBySuite (#5)
1 parent 13d7655 commit 0c80adf

40 files changed

+1419
-34
lines changed

‎docs/README.md‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
**CTRF v0.0.15**
1+
**CTRF v0.0.16**
22

33
***
44

5-
# CTRF v0.0.15
5+
# CTRF v0.0.16
66

77
## Enumerations
88

@@ -21,22 +21,33 @@
2121
- [Summary](interfaces/Summary.md)
2222
- [Test](interfaces/Test.md)
2323
- [TestInsights](interfaces/TestInsights.md)
24+
- [TestTree](interfaces/TestTree.md)
2425
- [Tool](interfaces/Tool.md)
26+
- [TreeNode](interfaces/TreeNode.md)
27+
- [TreeOptions](interfaces/TreeOptions.md)
2528
- [ValidationResult](interfaces/ValidationResult.md)
2629

2730
## Type Aliases
2831

2932
- [TestStatus](type-aliases/TestStatus.md)
33+
- [TreeTest](type-aliases/TreeTest.md)
3034

3135
## Functions
3236

3337
- [enrichReportWithInsights](functions/enrichReportWithInsights.md)
38+
- [findSuiteByName](functions/findSuiteByName.md)
39+
- [findTestByName](functions/findTestByName.md)
40+
- [flattenTree](functions/flattenTree.md)
41+
- [getAllTests](functions/getAllTests.md)
42+
- [getSuiteStats](functions/getSuiteStats.md)
3443
- [isValidCtrfReport](functions/isValidCtrfReport.md)
3544
- [mergeReports](functions/mergeReports.md)
45+
- [organizeTestsBySuite](functions/organizeTestsBySuite.md)
3646
- [readReportFromFile](functions/readReportFromFile.md)
3747
- [readReportsFromDirectory](functions/readReportsFromDirectory.md)
3848
- [readReportsFromGlobPattern](functions/readReportsFromGlobPattern.md)
3949
- [sortReportsByTimestamp](functions/sortReportsByTimestamp.md)
4050
- [storePreviousResults](functions/storePreviousResults.md)
51+
- [traverseTree](functions/traverseTree.md)
4152
- [validateReport](functions/validateReport.md)
4253
- [validateReportStrict](functions/validateReportStrict.md)

‎docs/enumerations/SortOrder.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**CTRF v0.0.15**](../README.md)
1+
[**CTRF v0.0.16**](../README.md)
22

33
***
44

‎docs/functions/enrichReportWithInsights.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**CTRF v0.0.15**](../README.md)
1+
[**CTRF v0.0.16**](../README.md)
22

33
***
44

‎docs/functions/findSuiteByName.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
[**CTRF v0.0.16**](../README.md)
2+
3+
***
4+
5+
[CTRF](../README.md) / findSuiteByName
6+
7+
# Function: findSuiteByName()
8+
9+
> **findSuiteByName**(`nodes`, `name`): `undefined` \| [`TreeNode`](../interfaces/TreeNode.md)
10+
11+
Defined in: src/methods/tree-hierarchical-structure.ts:331
12+
13+
Utility function to find a suite by name in the tree
14+
15+
## Parameters
16+
17+
### nodes
18+
19+
[`TreeNode`](../interfaces/TreeNode.md)[]
20+
21+
Array of tree nodes to search
22+
23+
### name
24+
25+
`string`
26+
27+
Name of the suite to find
28+
29+
## Returns
30+
31+
`undefined` \| [`TreeNode`](../interfaces/TreeNode.md)
32+
33+
The found suite node or undefined

‎docs/functions/findTestByName.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
[**CTRF v0.0.16**](../README.md)
2+
3+
***
4+
5+
[CTRF](../README.md) / findTestByName
6+
7+
# Function: findTestByName()
8+
9+
> **findTestByName**(`nodes`, `name`): `undefined` \| [`TreeTest`](../type-aliases/TreeTest.md)
10+
11+
Defined in: src/methods/tree-hierarchical-structure.ts:354
12+
13+
Utility function to find a test by name in the tree
14+
15+
## Parameters
16+
17+
### nodes
18+
19+
[`TreeNode`](../interfaces/TreeNode.md)[]
20+
21+
Array of tree nodes to search
22+
23+
### name
24+
25+
`string`
26+
27+
Name of the test to find
28+
29+
## Returns
30+
31+
`undefined` \| [`TreeTest`](../type-aliases/TreeTest.md)
32+
33+
The found test or undefined

‎docs/functions/flattenTree.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
[**CTRF v0.0.16**](../README.md)
2+
3+
***
4+
5+
[CTRF](../README.md) / flattenTree
6+
7+
# Function: flattenTree()
8+
9+
> **flattenTree**(`nodes`): `object`[]
10+
11+
Defined in: src/methods/tree-hierarchical-structure.ts:379
12+
13+
Utility function to convert tree to a flat array with indentation information
14+
Useful for displaying the tree in a linear format
15+
16+
## Parameters
17+
18+
### nodes
19+
20+
[`TreeNode`](../interfaces/TreeNode.md)[]
21+
22+
Array of tree nodes to flatten
23+
24+
## Returns
25+
26+
`object`[]
27+
28+
Array of objects containing node, depth, and nodeType information

‎docs/functions/getAllTests.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
[**CTRF v0.0.16**](../README.md)
2+
3+
***
4+
5+
[CTRF](../README.md) / getAllTests
6+
7+
# Function: getAllTests()
8+
9+
> **getAllTests**(`nodes`): [`TreeTest`](../type-aliases/TreeTest.md)[]
10+
11+
Defined in: src/methods/tree-hierarchical-structure.ts:403
12+
13+
Utility function to get all tests from the tree structure as a flat array
14+
15+
## Parameters
16+
17+
### nodes
18+
19+
[`TreeNode`](../interfaces/TreeNode.md)[]
20+
21+
Array of tree nodes to extract tests from
22+
23+
## Returns
24+
25+
[`TreeTest`](../type-aliases/TreeTest.md)[]
26+
27+
Array of all tests in the tree

‎docs/functions/getSuiteStats.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
[**CTRF v0.0.16**](../README.md)
2+
3+
***
4+
5+
[CTRF](../README.md) / getSuiteStats
6+
7+
# Function: getSuiteStats()
8+
9+
> **getSuiteStats**(`nodes`, `suitePath`): `undefined` \| [`Summary`](../interfaces/Summary.md)
10+
11+
Defined in: src/methods/tree-hierarchical-structure.ts:422
12+
13+
Utility function to get statistics for a specific suite path
14+
15+
## Parameters
16+
17+
### nodes
18+
19+
[`TreeNode`](../interfaces/TreeNode.md)[]
20+
21+
Array of tree nodes to search
22+
23+
### suitePath
24+
25+
`string`[]
26+
27+
Array representing the path to the suite
28+
29+
## Returns
30+
31+
`undefined` \| [`Summary`](../interfaces/Summary.md)
32+
33+
Summary statistics for the suite or undefined if not found

‎docs/functions/isValidCtrfReport.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**CTRF v0.0.15**](../README.md)
1+
[**CTRF v0.0.16**](../README.md)
22

33
***
44

@@ -8,7 +8,7 @@
88

99
> **isValidCtrfReport**(`report`): `report is { reportFormat: "CTRF" }`
1010
11-
Defined in: src/methods/validate-schema.ts:27
11+
Defined in: [src/methods/validate-schema.ts:27](https://github.com/ctrf-io/ctrf-core-js/blob/main/src/methods/validate-schema.ts#L27)
1212

1313
Simple check to verify if an object is a CTRF report by checking the reportFormat
1414

‎docs/functions/mergeReports.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**CTRF v0.0.15**](../README.md)
1+
[**CTRF v0.0.16**](../README.md)
22

33
***
44

0 commit comments

Comments
 (0)