A tool that formats all kinds of languages consistently
Project description
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)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file monoformat-0.2.0.tar.gz
.
File metadata
- Download URL: monoformat-0.2.0.tar.gz
- Upload date:
- Size: 8.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.6.1 CPython/3.10.12 Linux/5.15.0-1041-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 69f5feaf1e76b380f80e57dd047d9e5555fa56d9a834b22a984105c41a716865 |
|
MD5 | a2002218ff3047fafca7f667cec4ab9a |
|
BLAKE2b-256 | 9ec71a4f595e68288746b6a0b29ea9f33c84c8c207acd81810622904ea743462 |
File details
Details for the file monoformat-0.2.0-py3-none-any.whl
.
File metadata
- Download URL: monoformat-0.2.0-py3-none-any.whl
- Upload date:
- Size: 9.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.6.1 CPython/3.10.12 Linux/5.15.0-1041-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c9a74657bdd2de7114dc4aa78f0e26796133c88394c03aa760d835dd48b1915d |
|
MD5 | c62af408bf6aba6fc7a79353d895f759 |
|
BLAKE2b-256 | 46a7c403675395b848917e655962d38ee56f0a9120adde7a2e1966a59ee44400 |