VNF Scripting Language Extension for Visual Studio Code

Enhance your Visual Studio Code experience with syntax highlighting for VNF scripting language files. This extension provides an intuitive and efficient workflow for scripting in VNF, making it easier and more enjoyable.

Table of Contents

• Table of Contents
• Features
• Getting Started
  • Prerequisites
  • ⭐ Recommended Installation
  • Manual Installation
  • Running from Source
• Advanced Use & Customization
• Known Issues
• License
• FAQ / Troubleshooting
• Credits

Features

• Syntax highlighting specifically designed for VNF scripting language.

Getting Started

Prerequisites

• Visual Studio Code

⭐ Recommended Installation

The easiest way to install the VNF Scripting Language Extension is directly through the Visual Studio Code Extension Marketplace:

1. Open Visual Studio Code.
2. Go to Extensions (Ctrl+Shift+X or Cmd+Shift+X on Mac).
3. In the search bar, type vnf.
4. Find the VNF Scripting Language Extension in the search results and click on Install.

Manual Installation

If you prefer to install the extension manually, follow these steps:

1. Visit the Releases page.

2. Select the latest version.

3. Download the .vsix file.

   Visual Guide for Download

   1. Navigate to the Releases tab on the right side of the repository.

      

   2. Select the latest release and download the .vsix file.

      

      Hint: Version numbers follow the format where 1.2 is newer than 1.0, and 2.0 is newer than 1.2

4. Open Visual Studio Code.

5. Go to Extensions (Ctrl+Shift+X or Cmd+Shift+X on Mac).

6. Click on the "..." menu and select Install from VSIX.

   

7. Navigate to the downloaded .vsix file and select 'Install'.

8. Reload Visual Studio Code if prompted.

9. Create a new file (File > New File).

10. Type VNF and select the relevant option.

    Note: Make sure to name the file with a .vnf extension. Example: Chapter 1.vnf.

11. Start creating your novel with VNF!

Running from Source

Running from Source

1. Open a new VSCode window.
2. Go to File > Open Folder and select the vnf-scripting-language folder.
3. Press F5 to run.
4. A new VSCode instance will open with the extension loaded.

Note: Building from source requires the vsce npm package. To install it, run npm install -g vsce.

Advanced Use & Customization

This extension utilizes VS Code's tokenization engine.

VS Code's tokenization engine is powered by TextMate grammars. TextMate grammars are a structured collection of regular expressions and are written as a plist (XML) or JSON files.

For further documentation, please see the ADVANCED.md file.

Known Issues

• Inconsistent highlighting in some instances of [].

License

This project is licensed under the MIT License - see the LICENSE.txt for details.

FAQ / Troubleshooting

Q: Can I contribute to the development of this extension? A: Absolutely! Contributions are welcome.

Credits

Prototyping & Testing:
wsan

Acknowledgments:
Special thanks to all the contributors who have helped make this extension a reality. Your efforts and dedication have been invaluable in developing and maintaining this project.

(back to top)