Skip to content

jolution/todo-nukem-snippet-vscode

Repository files navigation

Shows the banner of TODO NUKEM, with its logo

Coding Comments Snippets

The MIT License GitHub Marketplace

All Contributors

Working Draft

A snippet extension for generation TODO messages with emojis for easier comprehension and organization, see TODO NUKEM Convention.

🎬 Demo

Generate Comment

generate-demo.gif

📰 Installation

Install this extension from the VSCode Marketplace

🚀 Usage

In supported languages, you can type "todo" or "fixme" and then press the Tab key to activate the different options.

todo ⇥ fixme ⇥

✨ Supported Languages

Defined in the package.json file, the following languages are supported with either line or block comments:

Line Comment:

TypeScript, JavaScript

Block Comment:

CSS, PostCSS, SCSS, Less, HTML, Python, Java, C#, C++, Ruby, Swift, PHP, Go, Rust, Dart, Perl, Lua, Shell Script

For example, CSS uses block comments like /* ... */ .

And TypeScript could use line comments like // ... .

If a language you need is missing, feel free to open a PR and contribute!

❓FAQ

How can I enable snippet suggestions in comments in VSCode?

By default, snippet suggestions are not active in comments in VSCode. If you want to enable this feature, you need to adjust your settings.

In User Settings search for quickSuggestions and enable the following options:

"editor.quickSuggestions": {
    "comments": true,
    "strings": true
}

For more questions and answers, please visit our Q&A Discussions.

❤️ Support

If you find this project helpful, please consider giving it the Convention Repo a star on GitHub.

Star this repository

We do not currently offer direct support for this project.

🗺️ Roadmap

  • Publish this package to the Visual Studio Extension Store
  • Add optional block support
  • Add a combination of Emoji and Text support

💎 Sponsor

Eviden

We appreciate the support from Eviden, helping us continue our open source work.

✍️ Authors (in alphabetical order)

⚖️ License

See the LICENSE file for details.

ℹ️ Disclaimer

Please note that this project, TODO NUKEM, is not officially associated with or endorsed by the Duke Nukem franchise or its creators. It is an independent project developed by the open-source community and does not claim any rights to the Duke Nukem trademark or any related materials.

✨ Contributors

Thanks goes to these wonderful people (emoji key):

Jochen Simon
Jochen Simon

🎨
Julian Kasimir
Julian Kasimir

🤔 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

About

Vscode Snippet Extension for TODO NUKEM

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published