https://github.com/pouyakary/vscode-comment-justifier
A Visual Studio Code extension that lets you justify comments to be less than 40 characters and so easy to read.
https://github.com/pouyakary/vscode-comment-justifier
comments justification justify-content vscode vscode-extension
Last synced: 15 days ago
JSON representation
A Visual Studio Code extension that lets you justify comments to be less than 40 characters and so easy to read.
- Host: GitHub
- URL: https://github.com/pouyakary/vscode-comment-justifier
- Owner: pouyakary
- License: gpl-3.0
- Created: 2023-09-03T19:42:08.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-16T11:52:54.000Z (over 2 years ago)
- Last Synced: 2025-05-14T05:24:42.940Z (about 1 year ago)
- Topics: comments, justification, justify-content, vscode, vscode-extension
- Language: TypeScript
- Homepage:
- Size: 199 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Comment Justifier
This is the most basic version of a comment justifier, it is so basic and unsafe that you probably should not use, until I can make the time to build the system fully. It lets you justify comments to be less than 40 characters. I didn't include any option to change the size because I think it should enforce that length, the length makes sure that it is the easiest thing to read.
> **🧨 Very Important Remark**
> The current implementation doesn't have a markdown parser and
> therefore is not safe for justifying structured markdown comments.
> It will mess up the code blocks and other formatting that you might
> have. Only use it on plain and simple comments like the Go's
> simple comment system.
> **🧨 Very Important Remark**
> This extension is only to test and develop the system. Once the
> system is complete and I'm satisfied with it. (When it has been
> battle tested for a while, and probably supports Markdown
> Structures), It will be moved inside the
> [Comment 6 Extension](https://marketplace.visualstudio.com/items?itemName=karyfoundation.comment)
> And removed from here.
To justify a comment, move your cursor over it and apply the command. It's called `Justify Commend` and the command is `control`+`option`+`command`+`h`. The (`h` in Dvorak layout is j and funny enough, the h and j on the keyboard sit very near each other, so the command is perfect for both QWERTY and Dvorak users)