@injurkx/prompt-gen v0.0.3

Генератор Промптов для AI из Проекта (@injurkx/prompt-gen)

Консольная утилита для сканирования директории вашего проекта, сбора текстовых и кодовых файлов (с учетом правил .gitignore) и объединения их в один текстовый файл. Этот файл подходит для использования в качестве контекстного промпта для больших языковых моделей (LLM).

Как использовать

После установки или сборки проекта, вы можете использовать CLI.

Глобальная установка или через NPX (Рекомендуется для частого использования):**

• Установка:

  • Если пакет опубликован на npm:

    npm install -g @injurkx/prompt-gen

  • Если вы находитесь в корневой папке вашего локального проекта (prompt-generator) и хотите установить его глобально из локальных исходников:

    npm install -g .

• Использование через NPX (без глобальной установки):

  npx @injurkx/prompt-gen [опции]

  Пример:

  npx @injurkx/prompt-gen --directory ./src --output src_prompt.md

• Использование после глобальной установки (если bin настроен на prompt-gen):

  # Собрать промпт из текущей директории в prompt.txt (настройки по умолчанию)
  prompt-gen
  
  # Указать директорию и выходной файл
  prompt-gen --directory ./src --output src_prompt.md
  
  # Указать только нужные расширения и максимальный размер файла (100KB)
  prompt-gen -e ts,tsx,css -m 100
  
  # Игнорировать .gitignore и использовать структурированный формат
  prompt-gen --no-gitignore --format structured
  
  # Исключить папки тестов и файлы .spec, добавить префикс
  prompt-gen --exclude-paths "**/test*,**/*.spec.ts,**/node_modules/**" --prefix "Вот контекст проекта:"
  
  # Показать справку
  prompt-gen --help

Локальный запуск из исходников (Для разработки или разового использования):**

• Предварительно:
  • Убедитесь, что зависимости установлены: npm install
  • Скомпилируйте проект (если еще не сделали): npm run build
• Запуск скомпилированного кода: Используйте node для запуска dist/index.js:

  node dist/index.js --directory ../another-project -o ../another-project/prompt.txt

• Запуск в режиме разработки (через ts-node): Используйте скрипт dev из package.json. Обратите внимание на -- перед передачей аргументов самому скрипту:

  npm run dev -- --directory ./src -o dev_prompt.txt --no-gitignore

Опции командной строки

Пример вывода (prompt.txt с опцией --format flat)

== Project Prompt ==
Generated: 2023-10-27T10:30:00.123Z
Source Directory: /path/to/your/project
Included Files: 15
Total Size: 85.67 KB
Format: flat
====================

--- File: src/index.ts ---

#!/usr/bin/env node

import { Command } from 'commander';
import chalk from 'chalk';
// ... остальное содержимое index.ts ...

--- File: src/utils/helpers.ts ---

export function utilityFunction() {
  // ... содержимое helpers.ts ...
}

--- File: README.md ---

# Название Проекта
// ... содержимое README.md ...

--- File: package.json ---

{
  "name": "my-project",
  // ... содержимое package.json ...
}