Linguisto

简体中文

Introduction

Linguisto is a high-performance code language analysis tool based on github-linguist. Built with Rust and providing Node.js bindings via NAPI-RS, it quickly scans directories to count files, calculate byte sizes, and determine language percentages, while intelligently filtering out third-party dependencies and ignored files.

Features

• Superior Performance: Written in Rust, leveraging multi-threading for fast file system traversal.
• Smart Filtering: Automatically respects .gitignore, skips hidden files, and excludes vendored files (e.g., node_modules).
• Precise Detection: Based on robust language detection algorithms, supporting filename, extension, and content-based disambiguation.
• Beautiful Output: Provides a colorful terminal UI with progress bars, supporting sorting by bytes or file count.
• Data Integration: Supports JSON output for easy integration with other tools.
• Cross-platform: Supports macOS, Linux, Windows, and WASI environments.

Table of Contents

• Install
• Usage
  • CLI Usage
  • Programmatic Usage
• References
  • analyzeDirectory(dir)
  • analyzeDirectorySync(dir)
  • LanguageStat
• License

Install

For CLI

If you have Rust installed, you can install it via Cargo:

cargo install linguisto

Or install it globally via npm:

npm install -g @homy/linguist

For API

Install it as a dependency in your Node.js project:

npm install @homy/linguist

Usage

CLI Usage

Run it in the current directory to see an intuitive language distribution chart (sorted by byte size by default):

linguisto

Analyze a specific directory:

linguisto /path/to/your/project

Common Options

• --json: Output results in JSON format.
• --all: Show all detected files (by default, it only shows programming languages and filters out some configuration files).
• --sort <type>: Sort results. type can be file_count (descending) or bytes (descending, default).
• --max-lang <number>: Maximum number of languages to display individually. Remaining languages will be grouped into "Other" (default: 6).

Example

# Get JSON stats for the current project sorted by file count
linguisto . --json --sort=file_count

Programmatic Usage

You can call the API provided by @homy/linguist directly in your Node.js or TypeScript code.

const { analyzeDirectory, analyzeDirectorySync } = require('@homy/linguist');

// Asynchronous analysis (recommended for large directories)
async function run() {
  const stats = await analyzeDirectory('./src');
  console.log(stats);
}

run();

// Synchronous analysis
const syncStats = analyzeDirectorySync('./src');
console.log(syncStats);

References

analyzeDirectory(dir)

• Type: (dir: string) => Promise<LanguageStat[]>

Asynchronously analyzes the target directory and returns an array of language statistics.

analyzeDirectorySync(dir)

• Type: (dir: string) => LanguageStat[]

Synchronously analyzes the target directory and returns an array of language statistics.

LanguageStat

Each statistical object contains the following fields:

Credits

• github-linguist/linguist - The project that inspired this tool and provides the language detection logic.
• drshade/linguist - A Rust implementation of linguist that served as a reference.

License

MIT © Homyee King