Output Format

Understanding the structure of UiPool scan reports.

Report Structure #

The generated report follows this JSON structure:

uipool-report.json

{
  "generatedAt": "2025-12-30T10:00:00.000Z",
  "projectName": "my-app",
  "entries": [
    {
      "patternId": "login-flow",
      "count": 4,
      "files": [
        "src/pages/LoginPage.tsx",
        "src/pages/SignupPage.tsx",
        "src/components/AuthModal.tsx"
      ]
    },
    {
      "patternId": "data-table",
      "count": 2,
      "files": [
        "src/components/UserTable.tsx"
      ]
    }
  ],
  "components": [
    {
      "componentId": "button-primary",
      "count": 12,
      "files": [
        "src/components/Button.tsx",
        "src/pages/HomePage.tsx"
      ]
    }
  ]
}

Field Reference #

Field	Description
generatedAt	ISO 8601 timestamp when the report was generated
projectName	Name of the project (from package.json or folder name)
entries	Array of pattern entries, sorted alphabetically by patternId
entries[].patternId	The pattern identifier from the annotation
entries[].count	Total occurrences across all files
entries[].files	Unique list of files containing the pattern
components	Array of component entries (only if components found)
components[].componentId	The component identifier
components[].count	Total component occurrences
components[].files	Files containing the component annotation

Notes #

The components array is only included if component annotations are found
File paths are relative to the scanned directory
Both arrays are sorted alphabetically by their respective IDs
Duplicate annotations in the same file increment the count