lokalise-mcp/dist/domains/comments/comments.formatter.d.ts

The Lokalise MCP Server brings Lokalise's localization power to Claude and AI assistants—manage projects, keys, and translations by chat.

import type { Comment, CommentDeleted, PaginatedResult } from "@lokalise/node-api";
/**
 * Comments formatter functions for converting API responses to user-friendly Markdown.
 * Comments are attached to translation keys and allow team collaboration.
 */
/**
 * Format a list of comments for a specific key into Markdown.
 * @param commentsData - API response containing comments list
 * @param keyId - The key ID for context
 * @returns Formatted Markdown string
 */
export declare function formatKeyCommentsList(commentsData: PaginatedResult<Comment>, keyId: number): string;
/**
 * Format all project comments into Markdown.
 * @param commentsData - API response containing all project comments
 * @returns Formatted Markdown string
 */
export declare function formatProjectCommentsList(commentsData: PaginatedResult<Comment>): string;
/**
 * Format comment details into Markdown.
 * @param comment - Comment data from API
 * @returns Formatted Markdown string
 */
export declare function formatCommentDetails(comment: Comment): string;
/**
 * Format comments creation result into Markdown.
 * @param comments - The created comments data
 * @param keyId - The key ID for context
 * @returns Formatted Markdown string
 */
export declare function formatCreateCommentsResult(comments: Comment[], keyId: number): string;
/**
 * Format comment deletion result into Markdown.
 * @param result - The deletion result from API
 * @returns Formatted Markdown string
 */
export declare function formatDeleteCommentResult(result: CommentDeleted): string;