Skip to content

Commit 196e227

Browse files
Updated README and Icons
1 parent 735174d commit 196e227

4 files changed

Lines changed: 2553 additions & 79 deletions

File tree

README.md

Lines changed: 117 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -5,107 +5,145 @@
55
</p>
66

77
<p align="center">
8-
<a href="https://marketplace.visualstudio.com/items?itemName=ChristliebDela.comment-cleaner-pro">
9-
<img src="https://img.shields.io/visual-studio-marketplace/v/ChristliebDela.comment-cleaner-pro" alt="Version">
10-
</a>
11-
<a href="https://marketplace.visualstudio.com/items?itemName=ChristliebDela.comment-cleaner-pro">
12-
<img src="https://img.shields.io/visual-studio-marketplace/d/ChristliebDela.comment-cleaner-pro" alt="Downloads">
13-
</a>
14-
<a href="https://github.com/christliebdela/Comment-Cleaner-Pro/blob/main/LICENSE">
15-
<img src="https://img.shields.io/github/license/christliebdela/Comment-Cleaner-Pro" alt="License">
16-
</a>
8+
<a href="https://marketplace.visualstudio.com/items?itemName=ChristliebDela.comment-cleaner-pro"><img src="https://img.shields.io/visual-studio-marketplace/v/ChristliebDela.comment-cleaner-pro?style=flat-square&color=000000&labelColor=222222" alt="Version"></a>
9+
<a href="https://marketplace.visualstudio.com/items?itemName=ChristliebDela.comment-cleaner-pro"><img src="https://img.shields.io/visual-studio-marketplace/d/ChristliebDela.comment-cleaner-pro?style=flat-square&color=000000&labelColor=222222" alt="Downloads"></a>
10+
<a href="https://github.com/christliebdela/Comment-Cleaner-VsCode-Ext/blob/main/LICENSE"><img src="https://img.shields.io/github/license/christliebdela/Comment-Cleaner-VsCode-Ext?style=flat-square&color=000000&labelColor=222222" alt="License"></a>
11+
<a href="https://github.com/christliebdela/Comment-Cleaner-VsCode-Ext/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/christliebdela/Comment-Cleaner-VsCode-Ext/ci.yml?branch=main&style=flat-square&color=000000&labelColor=222222" alt="CI"></a>
12+
<a href="https://github.com/christliebdela/Comment-Cleaner-VsCode-Ext/issues"><img src="https://img.shields.io/github/issues/christliebdela/Comment-Cleaner-VsCode-Ext?style=flat-square&color=000000&labelColor=222222" alt="Issues"></a>
13+
<a href="https://github.com/christliebdela/Comment-Cleaner-VsCode-Ext/pulls"><img src="https://img.shields.io/github/issues-pr/christliebdela/Comment-Cleaner-VsCode-Ext?style=flat-square&color=000000&labelColor=222222" alt="Pull Requests"></a>
1714
</p>
1815

19-
<p align="center">
20-
<a href="https://github.com/christliebdela/Comment-Cleaner-Pro/actions/workflows/ci.yml">
21-
<img src="https://github.com/christliebdela/Comment-Cleaner-Pro/actions/workflows/ci.yml/badge.svg" alt="CI">
22-
</a>
23-
<a href="https://github.com/christliebdela/Comment-Cleaner-Pro/issues">
24-
<img src="https://img.shields.io/github/issues/christliebdela/Comment-Cleaner-Pro" alt="Issues">
25-
</a>
26-
<a href="https://github.com/christliebdela/Comment-Cleaner-Pro/pulls">
27-
<img src="https://img.shields.io/github/issues-pr/christliebdela/Comment-Cleaner-Pro" alt="Pull Requests">
28-
</a>
29-
</p>
16+
## Overview
3017

31-
Clean, streamlined code at your fingertips. Remove comments from your source files across 20+ programming languages with just a click..
18+
Comment Cleaner Pro is a powerful VS Code extension for removing comments from source code files. It helps you streamline your code by efficiently removing all types of comments (line, block, and documentation) across 20+ programming languages while preserving the core functionality of your code.
3219

33-
## Features
20+
## Key Features
3421

35-
- **Multi-language Support** - Works with 20+ popular programming languages including Python, JavaScript, TypeScript, HTML, CSS, C/C++, Java, Ruby, Go, and more.
36-
- **Context Menu Integration** - Right-click in your editor to clean comments from the current file.
37-
- **Batch Processing** - Clean multiple files at once using glob patterns.
38-
- **Backup Options** - Create automatic backups before removing comments.
39-
- **Customizable Processing** - Options to handle unknown file types and recursive directory processing.
22+
### Comprehensive Language Support
23+
- **20+ Programming Languages** - Supports all major languages including Python, JavaScript, TypeScript, HTML, CSS, C/C++, Java, Ruby, Go, PHP, SQL, Swift, Rust, Kotlin, and more
24+
- **Intelligent Comment Detection** - Accurately identifies and removes all comment types specific to each language
25+
- **Preservation of Code Structure** - Maintains code indentation and formatting while removing comments
4026

41-
![Comment Cleaner Demo](media/demo.gif)
27+
### Flexible Processing Options
28+
- **Single File Processing** - Clean comments from the current file with a single click
29+
- **Batch Processing** - Process multiple files simultaneously using glob patterns
30+
- **Automatic Backups** - Create safety backups before removing comments
31+
- **Customizable Rules** - Configure how unknown file types and special comments are handled
4232

43-
## Supported Languages
33+
### Seamless Integration
34+
- **Context Menu Integration** - Right-click access in the editor
35+
- **Command Palette Support** - Quick access through VS Code's command palette
36+
- **Status Bar Feedback** - Real-time processing status indicators
37+
- **History Tracking** - Keep track of recently processed files
4438

45-
- Python
46-
- JavaScript/TypeScript
47-
- HTML/CSS
48-
- C/C++
49-
- Java
50-
- Ruby
51-
- Go
52-
- PHP
53-
- SQL
54-
- Swift
55-
- Rust
56-
- Kotlin
57-
- Bash/Shell
58-
- PowerShell
59-
- Lua
60-
- Perl
61-
- YAML
62-
- Haskell
63-
- Dart
64-
- MATLAB
65-
- R
66-
- C#
67-
- And more...
68-
69-
## Usage
70-
71-
### Clean Current File
72-
73-
1. Open a source code file
74-
2. Right-click in the editor and select "Comment Cleaner Pro: Clean Current File"
75-
3. Alternatively, open the command palette (Ctrl+Shift+P) and search for "Comment Cleaner Pro: Clean Current File"
76-
77-
### Clean Multiple Files
78-
79-
1. Open the command palette (Ctrl+Shift+P)
80-
2. Search for "Comment Cleaner Pro: Clean Multiple Files"
81-
3. Enter a file pattern (e.g., `*.js`, `src/**/*.py`)
82-
4. Follow the prompts to configure backup and processing options
83-
84-
## Requirements
39+
![Comment Cleaner Pro in action](media/demo.gif)
8540

41+
## Supported Languages
42+
43+
| Language Group | Supported Languages |
44+
|---------------|---------------------|
45+
| **Web Development** | JavaScript, TypeScript, HTML, CSS, PHP |
46+
| **Systems Programming** | C, C++, Rust, Go |
47+
| **Enterprise** | Java, C#, Kotlin |
48+
| **Scripting** | Python, Ruby, Perl, Bash, PowerShell, Lua |
49+
| **Data & Analysis** | SQL, YAML, R, MATLAB |
50+
| **Mobile Development** | Swift, Dart |
51+
| **Functional** | Haskell |
52+
53+
## Installation
54+
55+
1. Open VS Code
56+
2. Go to Extensions view (Ctrl+Shift+X)
57+
3. Search for "Comment Cleaner Pro"
58+
4. Click Install
59+
60+
**Requirements:**
61+
- Visual Studio Code 1.50.0 or higher
8662
- Python 3.6 or higher
8763

88-
## Extension Settings
64+
## Usage Guide
65+
66+
### Method 1: Clean Current File
67+
1. Open a source code file in the editor
68+
2. Right-click anywhere in the editor
69+
3. Select "Comment Cleaner Pro: Clean Current File"
70+
4. Choose whether to create a backup
71+
5. The editor will refresh automatically with comments removed
72+
73+
### Method 2: Command Palette
74+
1. Press `Ctrl+Shift+P` (Windows/Linux) or `Cmd+Shift+P` (Mac)
75+
2. Type "Comment Cleaner Pro"
76+
3. Select "Comment Cleaner Pro: Clean Current File" or "Comment Cleaner Pro: Clean Multiple Files"
77+
4. Follow the prompts to configure options
78+
79+
### Method 3: Activity Bar Integration
80+
1. Click the Comment Cleaner Pro icon in the Activity Bar
81+
2. Choose "Clean Current File" or "Clean Multiple Files"
82+
3. View your recently cleaned files in the "Cleaned Files" section
83+
84+
### Batch Processing Options
85+
When cleaning multiple files:
86+
1. Enter a glob pattern to match files (e.g., `*.js`, `src/**/*.py`)
87+
2. Choose whether to create backups
88+
3. Decide if unknown file types should be processed
89+
4. Monitor progress in the notification area
90+
91+
## Technical Details
92+
93+
Comment Cleaner Pro uses a sophisticated regex-based parsing system to identify and remove comments while preserving code structure. The extension:
8994

90-
This extension doesn't require any configuration settings.
95+
- Handles nested comment structures
96+
- Preserves important comments like license headers when configured
97+
- Detects and properly processes character escapes in strings
98+
- Maintains code indentation and whitespace
9199

92-
## Known Issues
100+
## Performance Considerations
93101

94-
Please report any issues on our [GitHub repository](https://github.com/christliebdela/Comment-Cleaner-Pro/issues).
102+
- **Large Files**: Processing is optimized but may take longer with extremely large files
103+
- **Memory Usage**: Minimal memory footprint even when processing multiple files
104+
- **Workspace Impact**: Non-destructive operation with backup options
105+
106+
## FAQ
107+
108+
**Q: Does Comment Cleaner Pro modify my original files?**
109+
A: Yes, but you can enable backups which create `.bak` files before processing.
110+
111+
**Q: Can I undo the comment removal?**
112+
A: If you've enabled backups, you can restore from the `.bak` files. Standard undo operations work for single file processing if you haven't saved yet.
113+
114+
**Q: Does it work with all programming languages?**
115+
A: It supports 20+ major languages. For unlisted languages, you can try the "force" option, but results may vary.
116+
117+
## Privacy & Security
118+
119+
Comment Cleaner Pro:
120+
- Processes all files locally on your machine
121+
- Does not send any code or data externally
122+
- Requires no authentication or online services
123+
- Has minimal extension permissions
95124

96125
## Release Notes
97126

98-
### 0.1.0
127+
### 0.1.0 (2025-05-28)
128+
129+
- Initial release with support for 20+ languages
130+
- Single file and batch processing capabilities
131+
- Context menu and command palette integration
132+
- Backup creation options
133+
- Activity bar integration with file history
134+
135+
## Contributing
99136

100-
- Initial release of Comment Cleaner Pro
101-
- Support for 20+ programming languages
102-
- Single file and batch processing features
103-
- Backup creation option
137+
Contributions are welcome! See [CONTRIBUTING.md](https://github.com/christliebdela/Comment-Cleaner-Pro/blob/main/CONTRIBUTING.md) for guidelines.
104138

105139
## License
106140

107141
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
108142

109143
## Author
110144

111-
[Christlieb Dela](https://github.com/christliebdela)
145+
Created and maintained by [Christlieb Dela](https://github.com/christliebdela).
146+
147+
---
148+
149+
<p align="center"><em>Clean code is readable code.</em></p>

media/icon-small.png

4.39 KB
Loading

media/icon.png

4.39 KB
Loading

0 commit comments

Comments
 (0)