Skip to content

wix-incubator/jo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Jo - Git Codebase Analyzer

A command-line tool for analyzing Git repositories and extracting code structure information. Supports both Python and TypeScript codebases.

Installation

  1. Install Python dependencies:
pip install -r requirements.txt
  1. Install Node.js dependencies (required for TypeScript analysis):
npm install -g typescript
npm install -g ts-node

Usage

  1. Start analyzing a Git repository:
jo start /path/to/repository
  1. View the detailed analysis:
jo map /path/to/repository

You can also get the output in JSON format:

jo map /path/to/repository --format json

Clear all cached analyses:

jo drop

The analysis will:

  1. Analyze all Python and TypeScript files in the repository
  2. Extract information about:
    • Functions and methods (with parameters and return types for TypeScript)
    • Classes (with properties and inheritance for TypeScript)
    • Interfaces (TypeScript)
    • Type aliases (TypeScript)
  3. Store relationships between code elements
  4. Cache results in a local SQLite database

Features

  • Extracts functions, methods, and classes from Python code
  • Analyzes TypeScript-specific features:
    • Interfaces and their properties
    • Type aliases and definitions
    • Function parameter types and return types
    • Class properties and inheritance
  • Stores results in a local cache for quick access
  • Simple command-line interface
  • Multiple output formats (text and JSON)

Requirements

  • Python 3.6+
  • Node.js 14+ and npm (for TypeScript analysis)
  • Git

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages