monoformat 0.1.0b3

A tool that formats all kinds of languages consistently

Monoformat

Opinionated and "zero config" formatters like Black and Prettier are amazing in the sense that they remove any need for thinking about formatting. However, they still require you to:

• Be used separately (one is Python and the other is Node)
• Be configured for the language version and so forth

Monoformat does this automatically. You can only use the language version that monoformat allows and you can configure literally nothing except which files it's going to reformat and which it's not.

Installation

Monoformat is available on PyPI:

pip install monoformat

Usage

Monoformat is a command line tool. You can run it with:

monoformat .

This will reformat all files in the current directory and its subdirectories.

It will take care to avoid .git and other special directories. There is a default pattern embedded but you can change it with the --do-not-enter flag, which is a pattern matching folder or file names you don't want to consider.

On addition to the --do-not-enter rule, it will by default check all .gitignore files and .formatignore files (which use the .gitignore syntax but only affect the decision of whether to format a file or not, not to put them in git) and.

Default project

Let's say you have a Django project. It contains lots of files, including a node_modules somewhere and a a lot of big migration files.

You might want to have at the root of your repo a .gitignore file that looks like that:

node_modules
.idea
.vscode
.env
*.pyc

And then specifically to avoid formatting migrations (which can be super expensive), and to avoid running prettier on Django templates (which ends up badly) add a .formatignore file that looks like that:

**/migrations/*
**/templates/*

Then you can run monoformat . and it will only format the files that are relevant to your project.

Without install

I've actually spent an absurd amount of time to make it extremely simple to run Python and JS code without installing anything. You can do this with:

curl -s https://pypi.run/monoformat | python3.10 - .

Doing so will entirely reformat with black, isort and prettier the current directory.

Supported languages

Monoformat supports the following languages:

• Python 3.10 (Black)
• JavaScript (Prettier)
• TypeScript (Prettier)
• JSON (Prettier)
• Markdown (Prettier)
• YAML (Prettier)
• HTML (Prettier)
• CSS (Prettier)
• SCSS (Prettier)
• Vue (Prettier)
• Svelte (Prettier)
• PHP (Prettier)