dcortes92/vs-freemarker

FreeMarker language colorization extension for Visual Studio Code

⚠️ This repository or library is not maintained by me anymore. If you want to contribute, feel free to ping me and I'll transfer ownership of the repo ⚠️

FreeMarker for Visual Studio Code

FreeMarker language colorization extension for Visual Studio Code. You can read more about FreeMarker here.

Usage

Install the extension and open any .ftl file.

This is based on the TextMate bundle found on this repo.

Alternative FreeMarker syntax with square brackets is fully supported.

Snippets

Type # followed by the first letters of a FreeMarker tag name and the editor will propose you all the available autocomplete options. Snippets are also available for alternative FreeMarker syntax. They will have the same shortcuts of regular ones, with an underscore _ character at the end. For instance:

• with #if shortcut, you will get:

  <#if (condition)>
      
  </#if>
  

• while with #if_ shortcut the result will be:

  [#if (condition)]
      
  [/#if]
  

Snippets list

Shortcut	Description
dir	Directive
d	Simple Directive
mdef	Macro definition
ma	Macro
m	Simple Macro
a	#assign short
assign	#assign long
l	#local short
local	#local long
g	#global short
global	#global long
set	#setting short
setting	#setting long
if	#if
e	#else
eif	#elseif
li	#list
include	#include
imp	#import
function	#function / #return
sw	#switch / #case / #default
ca	#case
att	#attempt / #recover

Contributing

Contributions are welcome. Fork the repo and create a pull request with your changes.

vs-freemarker's Issues

Syntax Highlighting not working with VS Code Update

A recent update to Visual Studio Code 1.42.1 seems to have broken syntax highlighting.

• VS Code detects the file type.
• Uninstalling and reinstalling the extension did not help.

Selected Element Issue

When clicking a div, every other div on the page is being highlighted. Please can you fix it so that the when you select an opening div, only the matching closing div is selected?

Donations?

Our company has a donations program for open source projects that we use on the job.
But I don't see a way to donate for the development of this extension.

Some sequence hangs the syntax highlighting

Take the following example:

<script>
window.myVar=${myVar?c};
</script>

<#if myTest>
  <input type="text">
</#if>

<#if myTest>
</#if>

The second if statement has no syntax highlighting. Nor does most of the rest of the file. My original file is huge and almost half of it isn't highlighted. For some reason, at some point in the file, the highlighting returns.

Removing ?c makes it work. Removing the > in the first </#if makes it work. Removing the <input> makes it work. But as it is it doesn't work. I can't get my head around this one.

Parse *.ftlh and *.ftlx files as Freemarker

These are recommended file extensions for autoescaping of HTML (ftlh) and XML (ftlx).
See: https://freemarker.apache.org/docs/dgui_misc_autoescaping.html

Currently I cannot seem to find a way to automatically highlight them as Freemarker.
Adding "files.associations": { "*.ftlh": "Freemarker" } to settings.json does not seem to do the trick.

EDIT: After letting VSCode do the file association via the language menu, it worked fine.

VS Code freezes after you type ${

Per the below site, VS Code freezes when you ${ and there is no closing }.

microsoft/vscode#52886

multi-line highlight problem?

example:
<#assign map = {
"A" : "1" ,
"B" : "2" ,
"C" : "3" ,
"D" : "4" }
/>
sorry, my English is not good ：）

Add preview panel

Hi @dcortes92

I guess a nice to have could be an PREVIEW PANEL to test the template.

Based on Try FreeMarker, a developer could supply an source file (or directly a text) and the preview can run freemarker-cli in order to show how should be the expected result.

In this way we can help developers daily tasks and produce better and error prone templates.

Make sense?

The program freezes and falls off when using the plug-in "FreeMarker"

From @PavelHancharou on June 26, 2018 9:20

The program freezes and falls off when using the plug-in "FreeMarker"

• VSCode Version: 1.24.1
• OS Version: Win 10 x64
• Plugin for FreeMarker: https://github.com/dcortes92/vs-freemarker
• Version of plugin: 0.0.9

Steps to Reproduce:

1. Open VSC
2. Select Language Mode - FreeMarker (.ftl)
3. Write next text:
   ${abcdefghijklmnopqrstuvwxyzabcdefj
4. VSCode stop to work

The problem is currectly with FreeMarker Plugin, and when there is NO closing quote "}" in the text

Copied from original issue: microsoft/vscode#52886

Fix readme

There's a problem with the readme shown in the marketplace. Screenshot attached.

Add testing

Add testing to make merging process easier.

Add .ftlh as file extension

Following this issue, Spring Boot 2.2 changed the freemarker file extension from .ftl to .ftlh.

Please add .ftlh as a file extension managed by this plugin, so that the renamed files automatically get the correct syntax highlight.

Thank you very much for the excellent extension.

Add a Changelog

Need to add a changelog to keep track of the updates.

Integrates Freemarker Language Server.

It should be cool if we could have advanced features like syntax validation. To do that I have started a Freemarker Language Server https://github.com/angelozerr/freemarker-languageserver written in Java that you could consume it.

You could do the same thing than https://github.com/microclimate-devops/xml-language-server/blob/master/client-vscode/xml-client/client/extension.js which consumes an XML Language Server written in Java.

If you are interested:

• you can download the JAR at https://github.com/angelozerr/lsp4e-freemarker/tree/master/org.eclipse.lsp4e.freemarker/server
• and see the java command at https://github.com/angelozerr/lsp4e-freemarker/blob/master/org.eclipse.lsp4e.freemarker/src/org/eclipse/lsp4e/freemarker/FreemarkerLanguageServer.java#L16

vs-code freezes when using this extension with large files

If I enabled this extension and use it on a large file (4k+ lines) vs-code freezes

No problems with small ones.

Maybe is a bug similar to this I don't know...

Version: 1.29.0-insider (user setup)
Commit: 43823dae97f07760958ffbb5e16c7f219307159c
Date: 2018-10-24T05:21:57.644Z
Electron: 2.0.11
Chrome: 61.0.3163.100
Node.js: 8.9.3
V8: 6.1.534.41
Architecture: x64

Syntax highlighting for chained functions and multiline assignment breaking

Hi, please refer the following screenshot:

As you can see the items I have highlighted in red have a broken syntax highlighting.. Also in the bottom there is a multiline hash definition, which also breaks the syntax highlighting.

It would be great to have them fixed..

Possible to enable emmet for .ftl files?

Often much of the freemarker code we write is vanilla HTML. Would it be possible to add the ability to use emmet shortcuts within .ftl files?

How can I enable IntelliSense for HTML/Javascript in FreeMarker templates

Using the extension and editing a .ftl file usually contains a lot of HTML and JavaScript so it would be nice to use IntelliSense for these depending on the context.

For example, the PHP Intelephense extension does this too: https://marketplace.visualstudio.com/items?itemName=bmewburn.vscode-intelephense-client

Is it possible to do the same thing with the FreeMarker extension?

Syntax highlight bug with some #if statements

<#if (a>b) && b==2> the first > will be interpreted as the end of the #if statement.

Redesign logo

Current logo is good, but I'd like a different one for this year.

Support for FreeMarker Snippets in HTML file

I have a code ready to be push to new branch, for the Support for FreeMarker Snippets in HTML file, just need an access to the repo.