https://github.com/eepp/formol-vscode-ext
Reformat whole document or block comments under the caret following eepp's plain text format
https://github.com/eepp/formol-vscode-ext
Last synced: 24 days ago
JSON representation
Reformat whole document or block comments under the caret following eepp's plain text format
- Host: GitHub
- URL: https://github.com/eepp/formol-vscode-ext
- Owner: eepp
- License: mit
- Created: 2026-05-20T18:38:52.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2026-05-20T18:50:25.000Z (about 1 month ago)
- Last Synced: 2026-05-21T00:25:53.515Z (about 1 month ago)
- Language: TypeScript
- Homepage:
- Size: 10.7 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Formol for VS Code
Reformat a whole plain text document or a block comment under the caret to follow [eepp's plain text format](https://0x3b.org/files/eepp-plain-text-format.html) using [Formol](https://github.com/eepp/formol).
Only applies whole document reformatting for plain text and Git commit message documents.
For comment reformatting, this extension supports most popular languages that use:
* C-style block comments:
```
/*
* ...
*/
```
* Python-style comments:
```
# ...
# ...
# ...
```
**Disclaimer**: I don't use VS Code myself, therefore I vibe-coded this whole extension. Use at your own risk, although it defers the bulk of the work to Formol (Python).
## Usage
Run **Formol: Reformat** (default keybinding: Meta+E):
* In a plain text file: reformats the whole file.
* In a Git commit message: reformats the whole message, leaving the
trailing `#` comment block that Git generates untouched.
* In any other supported language: place a single caret between `/*`
and `*/` (C-style block comment) or on a `#`-prefixed comment line
(Python-style comment), then run the command to reformat that
comment.
## Configuration
| Setting | Default | Description |
| -------------------------- | ----------- | -------------------------------------------- |
| `formol.maxLineLength` | `72` | Max line length in visual columns. |
| `formol.pythonBin` | `"python3"` | Python interpreter that can `import formol`. |
## Requirements
The `formol` Python package must be importable by the configured interpreter.
To install globally:
```
$ sudo pip install formol --break-system-packages
```
## Build and try
```
$ npm install
$ npm run compile
```
Press F5 in VS Code to launch an Extension Development Host.