Handlebars Navigator

🚀 Visual Studio Code extension for easy Handlebars navigation.

Features

• Navigate with Ease: Quickly jump to the definition of Handlebars partials, by simply CTRL + Click on the Partial. Ex: _{{>partial-name}}.

• Handlebars Highlighting: Tailored support for Handlebars syntax, highlighting the handlebar mustaches and the partial names.

Installation

1. Open Visual Studio Code
2. Go to Extensions (Ctrl+Shift+X)
3. Search for "Handlebars Navigator"
4. Click Install to add the extension to your environment

Usage

Navigate to Partial Definition

1. Open an HTML file with handlebars in Visual Studio Code

2. Use Ctrl+Click on a partial. Ex: {{>_partial-name}}

3. _partial-name.html will be opened

   Please note, Partials should exist as an html file in the "src>partials" folder. Can be any subfolders after that.

Comment out HTML using Handlebars Comment

1. Select the lines that you would like commented
2. Press CTRL + SHIFT + /

Running Locally to Debug and Test

To test the extension locally in a development environment, follow these steps:

1. Clone the repository:

   git clone https://github.com/adilasif-io/handlebars-navigator.git
   

2. Navigate to the project directory:

   cd handlebars-navigator
   

3. Install dependencies:

   npm install
   

4. Open file src > extension.ts

5. Run Debug mode by pressing F5 on your keyboard and select VS Code Extension Development

Building Locally

To build the extension locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/adilasif-io/handlebars-navigator.git
   

2. Navigate to the project directory:

   cd handlebars-navigator
   

3. Install dependencies:

   npm install
   

4. Build the extension:

   npx tsc
   

Building VSIX

To build the VSIX package, follow these steps:

1. Clone the repository:

   git clone https://github.com/adilasif-io/handlebars-navigator.git
   

2. Navigate to the project directory:

   cd handlebars-navigator
   

3. Install dependencies:

   npm install
   

4. Install Visual Studio Code CLI:

   npm install -g @vscode/vsce
   

5. Run the packaging process:

   vsce package
   

Contributing

Contributions are welcome! Whether you find a bug, have a feature request, or want to contribute code, please feel free to open an issue or submit a pull request.

License

This project is licensed under the MIT License.