Skip to content

VS Code extension for directory content visualization

License

Notifications You must be signed in to change notification settings

romot-co/matomeru

Repository files navigation

Matomeru

Combine your entire project into one LLM-ready Markdown.

プロジェクトを一つのMarkdownにまとめる、LLMに投げる

Matomeru Icon

English | 日本語

English

Features

  • Generate Markdown documentation for your directory structures and file contents
  • Automatically format and organize:
    • Directory tree structure
    • Markdown-compatible output
  • Support for multiple output formats:
    • Display in editor
    • Copy to clipboard
    • Send to ChatGPT (macOS only)
  • Customizable directory structure display:
    • Emoji icons for directories and files
    • Configurable indentation
    • Optional file extension display
  • Localization support (English/Japanese)

Installation

  1. Install from VSCode Marketplace
  2. Or download the .vsix file and install manually:
    code --install-extension matomeru-0.0.1.vsix

Usage

  1. Right-click on a directory or file in the explorer
  2. Select "Matomeru: Summarize Directory/File"
  3. Choose output destination:
    • Open in Editor
    • Copy to Clipboard
    • Send to ChatGPT (macOS only)

Configuration

{
  "matomeru.maxFileSize": 1048576,
  "matomeru.excludePatterns": [
    "node_modules/**",
    ".git/**",
    "dist/**",
    "build/**",
    "coverage/**"
  ],
  "matomeru.chatGptIntegration": false,
  "matomeru.directoryStructure.directoryIcon": "📁",
  "matomeru.directoryStructure.fileIcon": "📄",
  "matomeru.directoryStructure.indentSize": 2,
  "matomeru.directoryStructure.showFileExtensions": true,
  "matomeru.directoryStructure.useEmoji": true,
  "matomeru.prefixText": {
    "type": "string",
    "default": "",
    "description": "Text to be added at the beginning of the generated Markdown"
  }
}

Requirements

  • VSCode 1.085.0 or later
  • For ChatGPT integration:
    • macOS
    • Google Chrome
    • ChatGPT account

License

MIT License


Japanese

機能

  • 選択したディレクトリ構造とファイル内容をMarkdown形式で自動生成
  • 自動的にフォーマットして整理
    • ディレクトリツリー構造
    • Markdown互換の出力
  • 複数の出力形式に対応:
    • エディタでの表示
    • クリップボードへのコピー
    • ChatGPTへの送信(macOSのみ)
  • カスタマイズ可能なディレクトリ構造表示:
    • ディレクトリとファイルの絵文字アイコン
    • インデントの設定
    • ファイル拡張子の表示/非表示
  • 多言語対応(英語/日本語)

インストール

  1. VSCode マーケットプレイスからインストール
  2. または、.vsixファイルをダウンロードして手動でインストール:
    code --install-extension matomeru-0.0.1.vsix

使い方

  1. エクスプローラーでディレクトリまたはファイルを右クリック
  2. 「Matomeru: ディレクトリ/ファイルをまとめる」を選択
  3. 出力先を選択:
    • エディタで開く
    • クリップボードにコピー
    • ChatGPTに送信(macOSのみ)

設定例

{
  "matomeru.maxFileSize": 1048576,
  "matomeru.excludePatterns": [
    "node_modules/**",
    ".git/**",
    "dist/**",
    "build/**",
    "coverage/**"
  ],
  "matomeru.chatGptIntegration": false,
  "matomeru.directoryStructure.directoryIcon": "📁",
  "matomeru.directoryStructure.fileIcon": "📄",
  "matomeru.directoryStructure.indentSize": 2,
  "matomeru.directoryStructure.showFileExtensions": true,
  "matomeru.prefixText": "# Project Overview\nThis is a sample project."
}

出力例

# Project Overview
This is a sample project.

# Directory Structure
📁 src
  📄 index.ts
  📄 utils.ts
📁 tests
  📄 index.test.ts

# File Contents

## src/index.ts
- Size: 1.2 KB
- Language: TypeScript

```typescript
// ... file content ...

src/utils.ts

...


### 必要要件

- VSCode 1.85.0以降
- ChatGPT連携機能を使用する場合:
  - macOS
  - Google Chrome
  - ChatGPTアカウント

### ライセンス

MIT License

About

VS Code extension for directory content visualization

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published