https://github.com/ainevsia/vscode-forcecomment

Visual Studio Code plugin for forcing you to comment from time to time.
https://github.com/ainevsia/vscode-forcecomment

force-comment vscode-extension

Last synced: 3 months ago
JSON representation

Visual Studio Code plugin for forcing you to comment from time to time.

• Host: GitHub
• URL: https://github.com/ainevsia/vscode-forcecomment
• Owner: Ainevsia
• License: bsd-3-clause
• Created: 2020-03-17T08:29:01.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-07-19T22:15:41.000Z (about 5 years ago)
• Last Synced: 2025-04-04T05:09:46.660Z (6 months ago)
• Topics: force-comment, vscode-extension
• Language: TypeScript
• Size: 8.74 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# vscode-forcecomment README

This is the README for the extension "vscode-forcecomment". It can help you to comment from time to time. It can also remind you of each tomato!

## How to get this extionsion

You can find it in the Vscode extionsion market [Here](https://marketplace.visualstudio.com/items?itemName=Ainevsia.vscode-forcecomment).

Or you can search the keyword `vscode-forcecomment` in the vscode extension marketplace directly.

## Usage

### Auto detect uncomment large blocks of codes

![propt](images/forcecomment.gif)

### Align comment

Command : `ForceComment: Align code`

Keyboard shortcut : `ctrl + shift + /`

![comment alignment](images/align.gif)

### Use Tomato Clock

![set-tomato-time](images/tomato.gif)

### Reset Tomato time

Command : `ForceComment: Set time for one tomato`

![set-tomato-time](images/changetomato.gif)

## Imported Commands

| Command                            | Title                                 | Description     |

| ---------------------------------- | ------------------------------------- | --------------- |

| `extension.forcecomment.aligncode` | ForceComment: Align code              | Align tail code |

| `extension.forcecomment.tomato`    | ForceComment: Set time for one tomato | Set a new timer |

## Activation Situations

Curruently only actived on `C/C++/Rust` codes.

## Known Issues

- no one has used it

## How to develop

- Clone the repository.

- In the repository, run `npm install`

- Open the repository using `Vscode` and then press `F5`

- Now you are debugging the extension!

## Release Notes

## v0.0.6

- Do dead-code removal and Specify that this extension can only used for C/C++/Rust in Readme.

- Prepare for a release.

## v0.0.5

* fix a bug: if not turn on auto-save, the blame view will not change. (Great Thanks to cyy).

### v0.0.4

- add status bar for the tomato clock and can set time

### v0.0.2

* add blame message to prompt the user for comment

 

### v0.0.1

- Add a simple tail-comment alignment functionality

***

## Changes

[Change Log](./CHANGELOG.md)

## License

[BSD 3-Clause License](./LICENSE)

## Unofficial Author's Words

> This is the tool I wanted but could not find so wrote myself.

> 

> I hope you will enjoy it!