@cuekit-cli/expo

Expo Router project analyzer for Cuekit CLI. Analyzes Expo Router projects using file-based routing to detect navigation routes, components, and interactive elements.

Overview

This package provides specialized analysis for Expo Router projects, supporting the file-based routing system in the app/ directory. It automatically detects route files and maps them to navigation paths while identifying navigator types and component structures.

Features

• File-based Routing: Analyzes route files in the app/ directory
• Navigator Detection: Identifies Stack, Tab, and Drawer navigators from layout files
• Route Groups: Supports route grouping with parentheses (group)
• Dynamic Routes: Handles parameterized routes ([id])
• Nested Layouts: Analyzes _layout.tsx files and nested navigation
• Modal Routes: Detects modal route patterns
• Deep Linking: Supports deep linking route analysis
• Component Analysis: Extracts component descriptions and features
• Interactive Elements: Identifies UI elements and their properties

Installation

npm install @cuekit-cli/expo

Configuration

To upload analysis results to the Cuekit dashboard, create a configuration file in your project's root directory.

The CLI searches for one of the following files:

• cuekit.config.json
• cuekit.config.js
• cuekit.config.mjs
• cuekit.config.ts

Required Fields

• apiKey (string): Your Cuekit API key
• appId (string): The App ID for your project

Example Configuration

{
  "apiKey": "your-cuekit-api-key-here",
  "appId": "your-app-id-here"
}

Usage

Basic Analysis

npx cuekit-cli scan .

Output Options

# JSON output
npx cuekit-cli scan . --json

# Save to markdown file
npx cuekit-cli scan . --out routes.md

# Use AI for component summarization
npx cuekit-cli scan . --ai

Examples

# Analyze an Expo Router project
npx cuekit-cli scan ./my-expo-app

# Generate JSON output
npx cuekit-cli scan ./my-expo-app --json

# Create documentation file
npx cuekit-cli scan ./my-expo-app --out routes.md

# With AI-powered component descriptions
npx cuekit-cli scan ./my-expo-app --ai

Supported Patterns

File-based Routing (app/ directory)

• app/index.tsx → /
• app/about.tsx → /about
• app/profile/[id].tsx → /profile/[id]
• app/(tabs)/home.tsx → /home (route group)
• app/_layout.tsx → Layout file (Stack/Tab/Drawer)

Navigator Types

The analyzer detects navigator types from layout files:

• Stack Navigator: Default for most routes
• Tab Navigator: Detected from createBottomTabNavigator or similar
• Drawer Navigator: Detected from createDrawerNavigator

Route Groups

• app/(auth)/login.tsx → /login (grouped routes)
• app/(tabs)/home.tsx → /home (tab group)

Output Format

The analyzer provides structured output including:

• Route names and paths
• Component file locations
• Navigator types (Stack, Tab, Drawer)
• Component descriptions
• Interactive elements
• Feature analysis

Development

# Build the package
npm run build

# Development mode with watch
npm run dev

# Type checking
npm run check-types

License

MIT License - see LICENSE file for details.