🛠️ Build.prop Syntax Highlighting for VS Code
✨ Build Prop Syntax Highlighting is a Visual Studio Code extension that provides syntax highlighting for build.prop files commonly found in Android system images. This extension makes it easier to read and edit configuration properties by highlighting comments, keys, values, and common formatting errors.
📑 Features
✅ Syntax Highlighting:
- Supports comments (
#)
- Highlights common property names and values
- Detects numeric values and lists
- Flags common formatting errors (e.g., spaces before
=)
💬 Comments Support:
- Easily identifies lines that start with
#, marking them as comments for better visibility.
📝 Enhanced Readability:
- Colors keys, values, and comments distinctly, making
build.prop files easier to navigate.
🚀 Fast and Lightweight:
- Minimal impact on your VS Code performance.
🖥️ Installation
From the VS Code Marketplace
- Open the Extensions view in VS Code (
Ctrl+Shift+X).
- Search for "Build Prop Syntax Highlighting".
- Click Install.
Manual Installation
Download the .vsix file from the Releases page.
Open a terminal and run:
code --install-extension buildprop-syntax-1.1.0.vsix
🛠️ Usage
- Open any
.prop file in VS Code (e.g., build.prop).
- The extension will automatically detect the file and apply syntax highlighting.
- Enjoy improved readability and error detection!
🖌️ Syntax Highlighting Details
Example
####################################
# from generate-common-build-props
####################################
ro.product.system.brand=Android
ro.product.system.device=generic
ro.system.product.cpu.abilist32=armeabi-v7a,armeabi
media.stagefright.enable-player=true
mmp.enable.3g2=true
ro.product.system.marketname=
Highlighted Elements
| Element |
Example |
Description |
| 🔹 Comment |
# This is a comment |
Lines starting with # |
| 🔸 Property Key |
ro.product.system.brand= |
Configuration keys |
| 🟢 Value (String) |
Android, true |
String values |
| 🟡 Value (List) |
armeabi-v7a,armeabi |
List of values separated by , |
| 🔴 Formatting Error |
ro.product.system.cert = |
Space before = detected |
⚙️ Configuration
This extension works out of the box. No additional configuration is required.
🐞 Troubleshooting
Common Issues
No syntax highlighting applied:
- Make sure the file has a
.prop extension.
- Try restarting VS Code if the highlighting does not appear.
Incorrect highlighting:
🤝 Contributing
Contributions are welcome! If you have suggestions for improvements or new features:
- Fork the repository.
- Create a new branch (
feature/your-feature).
- Submit a pull request.
📄 License
This project is licensed under the MIT License - see the LICENSE file for details.
🙏 Acknowledgements
- Inspired by the need for better Android development tools.
- Thanks to the open-source community for support and contributions.
📬 Feedback
We value your feedback! Please let us know if you encounter any issues or have feature requests by creating an issue.
⭐ Enjoying the extension? Don’t forget to give it a star on GitHub and leave a review in the VS Code Marketplace!
