convert README

The project's README from github.com/p2r3/convert. As one markdown file: README.md.

Convert to it!

Truly universal online file converter.

Many online file conversion tools are boring and insecure. They only allow conversion between two formats in the same medium (images to images, videos to videos, etc.), and they require that you upload your files to some server.

This is not just terrible for privacy, it's also incredibly lame. What if you really need to convert an AVI video to a PDF document? Try to find an online tool for that, I dare you.

Convert.to.it aims to be a tool that "just works". You're almost guaranteed to get an output - perhaps not always the one you expected, but it'll try its best to not leave you hanging.

For a semi-technical overview of this tool, check out the video: https://youtu.be/btUbcsTbVA8

Usage

  1. Go to convert.to.it
  2. Click the big blue box to add your file (or just drag it on to the window).
  3. An input format should have been automatically selected. If it wasn't, yikes! Try searching for it, or if it's really not there, see the "Issues" section below.
  4. Select an output format from the second list. If you're on desktop, that's the one on the right side. If you're on mobile, it'll be somewhere lower down.
  5. Click Convert!
  6. Hopefully, after a bit (or a lot) of thinking, the program will spit out the file you wanted. If not, see the "Issues" section below.

Issues

Ever since the YouTube video released, we've been getting spammed with issues suggesting the addition of all kinds of niche file formats. To keep things organized, I've decided to specify what counts as a valid issue and what doesn't.

[!IMPORTANT] SIMPLY ASKING FOR A FILE FORMAT TO BE ADDED IS NOT A MEANINGFUL ISSUE!

There are thousands of file formats out there. It can take hours to add support for just one. The math is simple - we can't possibly support every single file. As such, simply listing your favorite file formats is not helpful. We already know that there are formats we don't support, we don't need tickets to tell us that.

When suggesting a file format, you must at minimum:

If this seems like a lot, please remember - a developer will have to do 100x more work to actually implement the format. Doing a bit of research not only saves them precious time, it also weeds out "unserious" proposals that would only bloat our to-do list.

If you're submitting a bug report, you only need to do step 1 - check if the problem isn't already reported by someone else. Bug reports are generally quite important otherwise.

Though please note, "converting X to Y doesn't work" is not a bug report. However, "converting X to Y works but not how I expected" likely is a bug report.

Deployment

Local development (Bun + Vite)

  1. Clone this repository WITH SUBMODULES. You can use git clone --recursive https://github.com/p2r3/convert for that. Omitting submodules will leave you missing a few dependencies.
  2. Install Bun.
  3. Run bun install to install dependencies.
  4. Run bunx vite to start the development server.

The following steps are optional, but recommended for performance:

When you first open the page, it'll take a while to generate the list of supported formats for each tool. If you open the console, you'll see it complaining a bunch about missing caches.

After this is done (indicated by a Built initial format list message in the console), use printSupportedFormatCache() to get a JSON string with the cache data. You can then save this string to cache.json to skip that loading screen on startup.

If you run into issues where your changes seem to not be applying, try disabling this cache.

Docker (prebuilt image)

Docker compose files live in the docker/ directory, so run compose with -f from the repository root:

docker compose -f docker/docker-compose.yml up -d

Alternatively download the docker-compose.yml separately and start it by executing docker compose up -d in the same directory.

This runs the container on http://localhost:8080/convert/.

Docker (local build for development)

Use the override file to build the image locally:

docker compose -f docker/docker-compose.yml -f docker/docker-compose.override.yml up --build -d

The first Docker build is expected to be slow because Chromium and related system packages are installed in the build stage (needed for puppeteer in buildCache.js). Later builds are usually much faster due to Docker layer caching.

Contributing

The best way to contribute is by adding support for new file formats (duh). If you don't have a format to add but are eager to help, take a look at our issues. There are plenty of suggestions there.

Here's how adding a format works works:

Creating a handler

Each "tool" used for conversion has to be normalized to a standard form - effectively a "wrapper" that abstracts away the internal processes. These wrappers are available in src/handlers.

Below is a super barebones handler that does absolutely nothing. You can use this as a starting point for adding a new format:

// file: dummy.ts

import type { FileData, FileFormat, FormatHandler } from "../FormatHandler.ts";
import CommonFormats, { Category } from "src/CommonFormats.ts";

class dummyHandler implements FormatHandler {

  public name: string = "dummy";
  public supportedFormats: FileFormat[] = [
    // Example PNG format, with both input and output disabled
    CommonFormats.PNG.builder("png")
      .markLossless()
      .allowFrom(false)
      .allowTo(false),

    // Alternatively, if you need a custom format, define it like so:
    {
      name: "CompuServe Graphics Interchange Format (GIF)",
      format: "gif",
      extension: "gif",
      mime: "image/gif",
      from: false,
      to: false,
      internal: "gif",
      category: [Category.IMAGE, CATEGORY.VIDEO], // See src/CommonFormats.ts for valid categories
      lossless: false
    },
  ];
  public ready: boolean = false;

  async init () {
    this.ready = true;
  }

  async doConvert (
    inputFiles: FileData[],
    inputFormat: FileFormat,
    outputFormat: FileFormat
  ): Promise<FileData[]> {
    const outputFiles: FileData[] = [];
    return outputFiles;
  }

}

export default dummyHandler;

For more details on how all of these components work, refer to the doc comments in src/FormatHandler.ts. You can also take a look at existing handlers to get a more practical example.

There are a few additional things that I want to point out in particular:

Testing

This project currently uses two levels of tests:

Not every handler needs a dedicated unit test, but handlers with non-trivial custom internal logic may benefit from having one.

Adding dependencies

If your tool requires an external dependency (which it likely does), there are currently two well-established ways of going about this:

Please try to avoid CDNs (Content Delivery Networks). They're really cool on paper, but they don't work well with TypeScript, and each one introduces a tiny bit of instability. For a project that leans heavily on external dependencies, those bits of instability can add up fast.

AI Usage Policy

If you intend to use an LLM, agent-enabled IDE, or other AI-driven tool for your contribution, please follow these guidelines:

Not adhering to these rules will likely get your pull request closed.

I figure that there are people who'd prefer if I merged zero AI-written code, but I believe that's simply not feasible. Just from a code integrity perspective, it's much safer to be transparent about AI usage and define clear guidelines than to make it a taboo and risk people "sneaking in" unvetted AI code. Making things illegal doesn't stop everyone from doing those things - some will still do them, just in secret and with less oversight.

convert (p2r3/convert)

Searching Database…

4.2K ·GitHub
Что это такое?Универсальный онлайн-конвертер файлов на convert.to.it: вы даёте ему любой файл, выбираете целевой формат, и он справляется даже с переходами между типами носителей — например, видео в AVI в документ PDF, от чего обычные онлайн-сервисы обычно отказываются.
Чем он отличается от других онлайн-конвертеров?Большинство из них конвертируют только внутри одного типа (изображение в изображение, видео в видео) и требуют загружать файлы на их сервер. Этот умеет пересекать типы файлов и работает целиком в вашем браузере.
Как мне конвертировать файл?Откройте convert.to.it, перетащите файл на большую синюю область (входной формат определится автоматически), выберите формат на выходе из второго списка — справа на компьютере, ниже на телефоне — и нажмите Convert.
Он поддерживает вообще все форматы файлов?Нет — форматов существуют тысячи, а добавление поддержки одного может занять часы, поэтому экзотические просто отсутствуют: на выходе может получиться странная вещь или не получиться ничего.
Могу ли я поднять свой собственный экземпляр?Да — есть готовый Docker-образ: возьмите compose-файл из каталога docker/ и запустите docker compose up -d. Для разработки склонируйте репозиторий вместе с сабмодулями, установите Bun, затем выполните bun install и bunx vite.
Мои файлы куда-то загружаются при конвертации?Нет — конвертация происходит локально в вашем браузере, а не на удалённом сервере, и это главный аргумент проекта против конвертеров, требующих загружать к ним файлы.
Что на самом деле делает конвертацию под капотом?Портированные в WebAssembly известные инструменты, встроенные в страницу: FFmpeg для видео и аудио, ImageMagick для изображений, 7-zip и zstd для архивов, а также рендерер Typst и рендерер PPTX для документов. Новые инструменты конвертации добавляются как npm-пакеты или git-сабмодули в src/handlers.
Почему автор создал этот проект?Потому что существующие онлайн-конвертеры, по словам автора, «скучные и небезопасные» — они привязаны к парам файлов одного типа и требуют загрузки на сервер. Цель — конвертер, который «просто работает» и почти никогда не оставляет вас без результата, даже с необычными запросами между типами файлов.
Как добиться добавления нового формата файлов?Заявка, в которой указан только сам формат, будет отклонена. Нужно проверить, что формат ещё не поддерживается и не был запрошен, описать, что именно должна делать конвертация, и приложить ссылку на реализацию-образец или браузерное решение с лицензией, совместимой с GPL-2.0. В коде формат становится классом-обёрткой «handler» в src/handlers, названным по образцу dummyHandler в dummy.ts.
Creator
p2r3
Size
49.9 MB
Stars
4.2K
Age
10mo
Commits · 90 Days