Feat/organise by suite

README.md

@@ -33,9 +33,62 @@ We’d love your feedback, <a href="https://app.formbricks.com/s/cmefs524mhlh1tl
 npm install ctrf
 ```
 
-## API reference
-
-See [API reference](./docs) for more details.
+## API Reference
+
+### Schema Types
+
+- [Attachment](docs/interfaces/Attachment.md)
+- [Baseline](docs/interfaces/Baseline.md)
+- [Environment](docs/interfaces/Environment.md)
+- [InsightsMetric](docs/interfaces/InsightsMetric.md)
+- [Report](docs/interfaces/Report.md)
+- [Results](docs/interfaces/Results.md)
+- [RetryAttempt](docs/interfaces/RetryAttempt.md)
+- [RootInsights](docs/interfaces/RootInsights.md)
+- [Step](docs/interfaces/Step.md)
+- [Summary](docs/interfaces/Summary.md)
+- [Test](docs/interfaces/Test.md)
+- [TestInsights](docs/interfaces/TestInsights.md)
+- [Tool](docs/interfaces/Tool.md)
+- [TestStatus](docs/type-aliases/TestStatus.md)
+
+### File Operations Methods
+
+- [readReportFromFile](docs/functions/readReportFromFile.md)
+- [readReportsFromDirectory](docs/functions/readReportsFromDirectory.md)
+- [readReportsFromGlobPattern](docs/functions/readReportsFromGlobPattern.md)
+
+### Report Processing Methods
+
+- [enrichReportWithInsights](docs/functions/enrichReportWithInsights.md)
+- [mergeReports](docs/functions/mergeReports.md)
+- [sortReportsByTimestamp](docs/functions/sortReportsByTimestamp.md)
+- [storePreviousResults](docs/functions/storePreviousResults.md)
+
+### Validation Methods
+
+- [isValidCtrfReport](docs/functions/isValidCtrfReport.md)
+- [validateReport](docs/functions/validateReport.md)
+- [validateReportStrict](docs/functions/validateReportStrict.md)
+
+### Tree Operations Methods
+
+- [findSuiteByName](docs/functions/findSuiteByName.md)
+- [findTestByName](docs/functions/findTestByName.md)
+- [flattenTree](docs/functions/flattenTree.md)
+- [getAllTests](docs/functions/getAllTests.md)
+- [getSuiteStats](docs/functions/getSuiteStats.md)
+- [organizeTestsBySuite](docs/functions/organizeTestsBySuite.md)
+- [traverseTree](docs/functions/traverseTree.md)
+
+### Utility Types
+
+- [SortOrder](docs/enumerations/SortOrder.md) (enumeration)
+- [TestTree](docs/interfaces/TestTree.md)
+- [TreeNode](docs/interfaces/TreeNode.md)
+- [TreeOptions](docs/interfaces/TreeOptions.md)
+- [ValidationResult](docs/interfaces/ValidationResult.md)
+- [TreeTest](docs/type-aliases/TreeTest.md)
 
 ## TypeScript Types
 

docs/README.md

@@ -21,25 +21,34 @@
 - [Tool](interfaces/Tool.md)
 - [TestStatus](type-aliases/TestStatus.md)
 
-## Methods
+## File Operations
+
+- [readReportFromFile](functions/readReportFromFile.md)
+- [readReportsFromDirectory](functions/readReportsFromDirectory.md)
+- [readReportsFromGlobPattern](functions/readReportsFromGlobPattern.md)
+
+## Report Processing
 
 - [enrichReportWithInsights](functions/enrichReportWithInsights.md)
+- [mergeReports](functions/mergeReports.md)
+- [sortReportsByTimestamp](functions/sortReportsByTimestamp.md)
+- [storePreviousResults](functions/storePreviousResults.md)
+
+## Validation
+
+- [isValidCtrfReport](functions/isValidCtrfReport.md)
+- [validateReport](functions/validateReport.md)
+- [validateReportStrict](functions/validateReportStrict.md)
+
+## Tree Operations
+
 - [findSuiteByName](functions/findSuiteByName.md)
 - [findTestByName](functions/findTestByName.md)
 - [flattenTree](functions/flattenTree.md)
 - [getAllTests](functions/getAllTests.md)
 - [getSuiteStats](functions/getSuiteStats.md)
-- [isValidCtrfReport](functions/isValidCtrfReport.md)
-- [mergeReports](functions/mergeReports.md)
 - [organizeTestsBySuite](functions/organizeTestsBySuite.md)
-- [readReportFromFile](functions/readReportFromFile.md)
-- [readReportsFromDirectory](functions/readReportsFromDirectory.md)
-- [readReportsFromGlobPattern](functions/readReportsFromGlobPattern.md)
-- [sortReportsByTimestamp](functions/sortReportsByTimestamp.md)
-- [storePreviousResults](functions/storePreviousResults.md)
 - [traverseTree](functions/traverseTree.md)
-- [validateReport](functions/validateReport.md)
-- [validateReportStrict](functions/validateReportStrict.md)
 
 ## Enumerations
 

package.json

@@ -24,6 +24,7 @@
     "format:check": "prettier --check .",
     "docs": "typedoc",
     "docs:watch": "typedoc --watch",
+    "update-readme": "npx tsx update-readme.ts",
     "all": "npm run build:check && npm run test:coverage && npm run lint && npm run format && npm run docs && npm run build"
   },
   "files": [

src/index.ts

@@ -1,44 +1,44 @@
 /**
- * @group Methods
+ * @group Report Processing
  */
 export { mergeReports } from './methods/merge-reports.js'
 /**
- * @group Methods
+ * @group File Operations
+ */
+export { readReportFromFile } from './methods/read-reports.js'
+/**
+ * @group File Operations
  */
 export { readReportsFromDirectory } from './methods/read-reports.js'
 /**
- * @group Methods
+ * @group File Operations
  */
 export { readReportsFromGlobPattern } from './methods/read-reports.js'
 /**
- * @group Methods
+ * @group Report Processing
  */
 export { enrichReportWithInsights } from './methods/run-insights.js'
 /**
- * @group Methods
+ * @group Report Processing
  */
 export {
   sortReportsByTimestamp,
   SortOrder,
 } from './methods/utilities/sort-reports.js'
 /**
- * @group Methods
+ * @group Report Processing
  */
 export { storePreviousResults } from './methods/store-previous-results.js'
 /**
- * @group Methods
- */
-export { readReportFromFile } from './methods/read-reports.js'
-/**
- * @group Methods
+ * @group Validation
  */
 export {
   validateReport,
   validateReportStrict,
   isValidCtrfReport,
 } from './methods/validate-schema.js'
 /**
- * @group Methods
+ * @group Tree Operations
  */
 export {
   organizeTestsBySuite,

typedoc.json

@@ -7,8 +7,24 @@
   "excludeExternals": true,
   "includeVersion": true,
   "categorizeByGroup": true,
-  "categoryOrder": ["Schema", "Utility Types", "Methods", "*"],
-  "groupOrder": ["Schema", "Utility Types", "Methods", "*"],
+  "categoryOrder": [
+    "Schema",
+    "File Operations",
+    "Report Processing",
+    "Validation",
+    "Tree Operations",
+    "Utility Types",
+    "*"
+  ],
+  "groupOrder": [
+    "Schema",
+    "File Operations",
+    "Report Processing",
+    "Validation",
+    "Tree Operations",
+    "Utility Types",
+    "*"
+  ],
   "readme": "none",
   "plugin": ["typedoc-plugin-markdown"],
   "name": "CTRF ",

update-readme.ts

@@ -0,0 +1,107 @@
+#!/usr/bin/env tsx
+
+import fs from 'fs'
+import path from 'path'
+
+const README_PATH = path.join(process.cwd(), 'README.md')
+const DOCS_PATH = path.join(process.cwd(), 'docs', 'README.md')
+
+function extractCategorizedSections(docsContent: string): string {
+  const sections = [
+    { name: 'Schema', newName: 'Schema Types' },
+    { name: 'File Operations', newName: 'File Operations Methods' },
+    { name: 'Report Processing', newName: 'Report Processing Methods' },
+    { name: 'Validation', newName: 'Validation Methods' },
+    { name: 'Tree Operations', newName: 'Tree Operations Methods' },
+    { name: 'Enumerations', newName: 'Utility Types' },
+    { name: 'Interfaces', newName: 'Utility Types' },
+    { name: 'Type Aliases', newName: 'Utility Types' },
+  ]
+
+  let apiContent = '## API Reference\n'
+  let utilityTypesAdded = false
+
+  for (const section of sections) {
+    const sectionStart = docsContent.indexOf(`## ${section.name}`)
+    if (sectionStart === -1) continue
+
+    const nextSectionStart = docsContent.indexOf('## ', sectionStart + 1)
+    const sectionEnd =
+      nextSectionStart === -1 ? docsContent.length : nextSectionStart
+
+    let sectionContent = docsContent.substring(sectionStart, sectionEnd).trim()
+
+    sectionContent = sectionContent.replace(/\]\(([^)]+)\)/g, (match, url) => {
+      if (url.startsWith('http') || url.startsWith('docs/')) {
+        return match
+      }
+      return `](docs/${url})`
+    })
+
+    if (['Enumerations', 'Interfaces', 'Type Aliases'].includes(section.name)) {
+      if (!utilityTypesAdded) {
+        apiContent += '\n### Utility Types\n\n'
+        utilityTypesAdded = true
+      }
+      const lines = sectionContent.split('\n')
+      let listItems = lines.filter(line => line.startsWith('- ['))
+      if (section.name === 'Enumerations' && listItems.length > 0) {
+        listItems = listItems.map(item => item + ' (enumeration)')
+      }
+      if (listItems.length > 0) {
+        apiContent += listItems.join('\n') + '\n'
+      }
+    } else {
+      sectionContent = sectionContent.replace(
+        `## ${section.name}`,
+        `### ${section.newName}`
+      )
+      apiContent += '\n' + sectionContent + '\n'
+    }
+  }
+
+  return apiContent.trim()
+}
+
+function updateReadmeWithDocs() {
+  try {
+    const originalReadme = fs.readFileSync(README_PATH, 'utf-8')
+
+    const generatedDocs = fs.readFileSync(DOCS_PATH, 'utf-8')
+
+    const apiReferenceContent = extractCategorizedSections(generatedDocs)
+
+    const originalApiReferenceStart = originalReadme.indexOf('## API Reference')
+    const nextSectionStart = originalReadme.indexOf(
+      '## ',
+      originalApiReferenceStart + 1
+    )
+
+    if (originalApiReferenceStart === -1) {
+      console.error('Could not find "## API Reference" section in README.md')
+      process.exit(1)
+    }
+
+    const beforeApiReference = originalReadme.substring(
+      0,
+      originalApiReferenceStart
+    )
+
+    const afterApiReference =
+      nextSectionStart !== -1 ? originalReadme.substring(nextSectionStart) : ''
+
+    const newReadme =
+      beforeApiReference +
+      apiReferenceContent +
+      (afterApiReference ? '\n\n' + afterApiReference : '')
+
+    fs.writeFileSync(README_PATH, newReadme)
+
+    console.log('✅ README.md updated with categorized API documentation')
+  } catch (error) {
+    console.error('❌ Error updating README:', error)
+    process.exit(1)
+  }
+}
+
+updateReadmeWithDocs()