File Attributes VS Code Extension README

This is a VS Code Extension that refers to .gitattributes and .gitignore, and displays a message at the top of files that are either auto-generated or not under source control.

Support languages: English(en), Čeština(cs), Deutsch(de), Español(es), Français(fr), Magyar(hu), Italiano(it), 日本語(ja), 한국어(ko), Polski(pl), Português Brasileiro(pt-br), Русский(ru), Türkçe(tr), 简体中文(zh-cn), 繁體中文(zh-tw)

Screenshots

Screenshot: "This file is auto-generated." Screenshot: "This file is ignored by source control."

Tutorial

0. ⬇️ Install File Attributes

Show extension side bar within VS Code(Mac:Command+Shift+X, Windows and Linux: Ctrl+Shift+X), type file-attributes-vscode and press Enter and click Install. Restart VS Code when installation is completed.

1. ✨️ Automatic Warning Display

This extension has no settings or commands. When you open files that are specified as auto-generated in .gitattributes or ignored by .gitignore, a warning message is automatically displayed at the top of the file.

Enjoy!

Indicating Auto-Generated Files in `.gitattributes`

To explicitly mark files as auto-generated in your repository, you can use the .gitattributes file. By specifying certain attributes, you inform tools and contributors that these files are generated automatically and should not be manually edited.

For example, you can add the following line to your .gitattributes file:

# Mark all files in the 'generated/' directory as auto-generated
generated/* linguist-generated=true

Or, to mark specific file types as auto-generated:

# Mark all .pb.go files as auto-generated
*.pb.go linguist-generated=true

The linguist-generated=true attribute is recognized by many tools (such as GitHub) to identify generated files. This extension also uses this attribute to display a message at the top of the file in VS Code, warning users that the file is auto-generated.

Note: You can adjust the file patterns as needed for your project structure.

No further configuration is required—just maintain your .gitattributes file as usual.

Indicating Ignored Files in `.gitignore`

To have this extension display a warning for files ignored by source control, add file patterns to your .gitignore file as you normally would. For example:

# Ignore all log files
*.log

# Ignore build output directories
/dist/
/build/

When you open a file in VS Code that matches a pattern in .gitignore, the extension will automatically show a message at the top of the file indicating it is ignored by source control.

No additional configuration is required—just maintain your .gitignore as usual.

Release Notes

see ChangLog on marketplace or github

Support

GitHub Issues

License

Boost Software License

Download VSIX file ( for VS Code compatible softwares )

Releases · wraith13/file-attributes-vscode

Other extensions of wraith13's work

Icon	Name	Description
	Unsaved Files	Easy access to unsaved files for VS Code.
	File Path Bar	Show active file path in status bar.
	Open in GitHub Desktop	Open in GitHub Desktop from VS Code.