As developers, we’ve all experienced the challenge of keeping track of file context when sharing code snippets across platforms. The Insert Filename as Comment extension for Visual Studio Code aims to simplify this process by automatically adding the filename (and optional relative path) as a comment at the top of your files.
This lightweight tool can provide added clarity when collaborating with teammates (and, not to forget, future you!), posting snippets on social media, or interacting with AI assistants. You can instantly provide context without manual effort by including the filename in a comment.
Key features:
Automatic file context on save: Each save adds the filename as a comment at the top.
Customizable comment style: Match the comment style to your language.
Supports key file types: Works out of the box for JavaScript, TypeScript, and React.
Install the extension from the VS Code Marketplace or search for it directly in VS Code (or Cursor). Once active, the extension automatically adds the filename as a comment each time you save a supported file type. If needed, you can fine-tune its settings:
Filename only or include relative path: Choose between displaying just the filename or the relative path from your project root for even more context. Default: filename only.
Comment style: Select a style that fits your language — //, /* */, or #. Default: //.
File types: Control which file types trigger the comment insertion, set by file suffix. Default includes JavaScript (.js), TypeScript (.ts), and React (.jsx, .tsx)
These options provide flexibility to align with your preferences and project requirements. You can access these settings through VS Code’s User or Workspace settings.
While a small change, automatically adding context helps keep you in your coding flow and makes collaboration easier. Give Insert Filename as Comment a try and see if it enhances your workflow. Feedback is welcome on GitHub or the VS Code Marketplace.
If you find the extension helpful, share it with fellow developers. Together, we can make coding a tiny fraction of a tiny fraction more intuitive, one filename at a time.
Happy coding! 💚