66 </picture>
77</p >
88
9- # Coding Comments Snippets
9+ # TODO NUKEM - Coding Comments Generator
1010
1111[ ![ The MIT License] ( https://img.shields.io/badge/license-MIT-orange.svg?style=flat-square )] ( http://opensource.org/licenses/MIT )
12- [ ![ GitHub Marketplace] ( https://img.shields.io/badge/Marketplace-Snippet -blue.svg?colorA=24292e&colorB=0366d6&style=flat&longCache=true&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAYAAAAfSC3RAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAM6wAADOsB5dZE0gAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAERSURBVCiRhZG/SsMxFEZPfsVJ61jbxaF0cRQRcRJ9hlYn30IHN/+9iquDCOIsblIrOjqKgy5aKoJQj4O3EEtbPwhJbr6Te28CmdSKeqzeqr0YbfVIrTBKakvtOl5dtTkK+v4HfA9PEyBFCY9AGVgCBLaBp1jPAyfAJ/AAdIEG0dNAiyP7+K1qIfMdonZic6+WJoBJvQlvuwDqcXadUuqPA1NKAlexbRTAIMvMOCjTbMwl1LtI/6KWJ5Q6rT6Ht1MA58AX8Apcqqt5r2qhrgAXQC3CZ6i1+KMd9TRu3MvA3aH/fFPnBodb6oe6HM8+lYHrGdRXW8M9bMZtPXUji69lmf5Cmamq7quNLFZXD9Rq7v0Bpc1o/tp0fisAAAAASUVORK5CYII= )] ( https://marketplace.visualstudio.com/items?itemName=jolution.todo-nukem-snippet -vscode )
12+ [ ![ GitHub Marketplace] ( https://img.shields.io/badge/Marketplace-Generator -blue.svg?colorA=24292e&colorB=0366d6&style=flat&longCache=true&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAYAAAAfSC3RAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAM6wAADOsB5dZE0gAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAERSURBVCiRhZG/SsMxFEZPfsVJ61jbxaF0cRQRcRJ9hlYn30IHN/+9iquDCOIsblIrOjqKgy5aKoJQj4O3EEtbPwhJbr6Te28CmdSKeqzeqr0YbfVIrTBKakvtOl5dtTkK+v4HfA9PEyBFCY9AGVgCBLaBp1jPAyfAJ/AAdIEG0dNAiyP7+K1qIfMdonZic6+WJoBJvQlvuwDqcXadUuqPA1NKAlexbRTAIMvMOCjTbMwl1LtI/6KWJ5Q6rT6Ht1MA58AX8Apcqqt5r2qhrgAXQC3CZ6i1+KMd9TRu3MvA3aH/fFPnBodb6oe6HM8+lYHrGdRXW8M9bMZtPXUji69lmf5Cmamq7quNLFZXD9Rq7v0Bpc1o/tp0fisAAAAASUVORK5CYII= )] ( https://marketplace.visualstudio.com/items?itemName=jolution.todo-nukem-generator -vscode )
1313<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
1414[ ![ All Contributors] ( https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square )] ( #contributors- )
1515<!-- ALL-CONTRIBUTORS-BADGE:END -->
1616
1717** Working Draft**
1818
19- A snippet extension for generation TODO messages with emojis for easier comprehension and organization, see [ TODO NUKEM Convention] ( https://github.com/jolution/todo-nukem/blob/main/README.md ) .
19+ A VS Code extension for generating structured TODO comments with emojis following the [ TODO NUKEM Convention] ( https://github.com/jolution/todo-nukem/blob/main/README.md ) . Combines both ** interactive command-based generation ** and ** quick snippets ** for maximum flexibility .
2020
21- ### 🎬 Demo
21+ <!-- ### 🎬 Demo -->
2222
23- #### Generate Comment
24-
25- ![ generate-demo.gif] ( ./images/generate-demo.gif )
23+ <!-- #### Generate Comment -->
24+ <!--  -->
2625
2726## 📰 Installation
2827
29- Install this extension from the [ VSCode Marketplace] ( https://marketplace.visualstudio.com/items?itemName=jolution.todo-nukem-snippet -vscode )
28+ Install this extension from the [ VSCode Marketplace] ( https://marketplace.visualstudio.com/items?itemName=jolution.todo-nukem-generator -vscode )
3029
3130## 🚀 Usage
3231
33- In supported languages, you can type "todo" or "fixme" and then press the Tab key to activate the different options.
32+ This extension offers ** two ways** to create TODO NUKEM comments:
33+
34+ ### 1. 🎯 Interactive Command (Recommended)
35+
36+ Open the Command Palette (` Cmd+Shift+P ` or ` Ctrl+Shift+P ` ) and search for:
37+
38+ ```
39+ Insert TODO NUKEM Comment
40+ ```
41+
42+ Follow the guided prompts:
43+
44+ 1 . ** Priority** : 🟩 Low / 🔶 Medium / 🔴 High
45+ 2 . ** Type** : ✨ Feature / 🐛 Fix
46+ 3 . ** Context** : 🎨 Design / 📚 Doc / 🧪 Test / ⚡ Perf / etc.
47+ 4 . ** Message** : Your TODO description
48+ 5 . ** Meta Blocks** (optional): 💬 TBD / 🎯 Scope / 🎫 Ticket / 📅 Until / etc.
49+
50+ ** Example output:**
51+
52+ ``` typescript
53+ // TODO: 🔴 ✨ 🎨 Refactor button component [🎫 JIRA-123] [📅 2025-12-31]
54+ ```
55+
56+ ### 2. ⚡ Quick Snippets
57+
58+ In supported languages, type ` todo ` or ` fixme ` and press ` Tab ` to activate snippet templates:
3459
3560``` todo ⇥ ```
3661``` fixme ⇥ ```
3762
63+ This provides pre-defined templates for quick TODO insertion.
64+
3865## ✨ Supported Languages
3966
4067_ Defined in the ``` package.json ``` file, the following languages are supported with either line or block comments:_
4168
42- ### Line Comment:
69+ ### Line Comment
70+
4371``` TypeScript, JavaScript ```
4472
45- ### Block Comment:
46- ``` CSS, PostCSS, SCSS, Less, HTML, Python, Java, C#, C++, Ruby, Swift, PHP, Go, Rust, Dart, Perl, Lua, Shell Script ```
73+ ### Block Comment
4774
48- For example, CSS uses block comments like ``` /* ... */ ``` .
75+ ``` CSS, PostCSS, SCSS, Less, HTML, Python, Java, C#, C++, Ruby, Swift, PHP, Go, Rust, Dart, Perl, Lua, Shell Script ```
4976
50- And TypeScript could use line comments like ``` // ... ``` .
77+ For example, CSS uses block comments like ``` /* ... */ ``` .
5178
79+ And TypeScript could use line comments like ``` // ... ``` .
5280
5381** If a language you need is missing, feel free to open a PR and contribute!**
5482
@@ -66,6 +94,7 @@ In User Settings search for `quickSuggestions` and enable the following options:
6694 "strings" : true
6795}
6896```
97+
6998</p >
7099</details >
71100
@@ -79,17 +108,11 @@ If you find this project helpful, please consider giving it the Convention Repo
79108
80109We do not currently offer direct support for this project.
81110
82- ## 🗺️ Roadmap
83-
84- - [x] Publish this package to the Visual Studio Extension Store
85- - [ ] Add optional block support
86- - [ ] Add a combination of Emoji and Text support
87-
88111## 💎 Sponsor
89112
90- ### Eviden
113+ ### Atos
91114
92- We appreciate the support from [ Eviden ] ( https://eviden.com ) , helping us continue our open source work.
115+ We appreciate the support from [ Atos ] ( https://atos.net ) , helping us continue our open source work.
93116
94117### ✍️ Authors (in alphabetical order)
95118
0 commit comments