adrhumphreys / vscode-silverstripe

Basic template syntax highlighting for Silver Stripe template files.

Silverstripe

Provides SilverStripe syntax highlighting and snippets.

Features

• Reads the project composer.lock file to determine the available snippets.
• Php snippets follow psr-2 standards
• Snippets inject use item if available and possible.
• Supports 4.* and 3.*.
• Uses full word prefixes so you don't have to remember abbreviations.
• Includes snippets for addons modules such as tagfield and linkable.
• .ss templates include scope and conditional indentation.
• .ss templates support go to definition for <% include %>, <% themedCSS %> and <% themeJavascript %>.
• .ss templates autocomplete paths include, themedCSS and themeJavascript. ie. includepagination will complete to <% include SilverStripe/Blog/Pagination %> if found in the appropriate directory.

Options

Add your own snippets

Enable emmet

Open Preferences -> Settings

Add below settings to enable Emmet for .ss files:

"emmet.includeLanguages": {
    "silverstripe": "html"
}

Contributions

Go for gold, if it adds value, add it and I'll merge it.

vscode-silverstripe's Issues

Extension causes high cpu load

• Issue Type: Performance
• Extension Name: silverstripe
• Extension Version: 1.0.6
• OS Version: Darwin x64 18.7.0
• VSCode version: 1.50.1

⚠️ Make sure to attach this file from your home-directory:
⚠️/var/folders/p6/g17bqnqx65dg9yqz8b122hzw0000gn/T/adrianhumphreys.silverstripe-unresponsive.cpuprofile.txt

Find more details here: https://github.com/microsoft/vscode/wiki/Explain-extension-causes-high-cpu-load

It wrecks html

Possible to disable snippets?

Recent updates have added a lot of snippets, which is nice, but they are appearing before the Emmet snippets in templates and before the PHP Intelephense snippets in PHP files and I find myself using those other snippets much more frequently. This means I've got to cycle through all the snippets from this plugin to get to the ones I want.

I primarily use this plugin for syntax highlighting, and I'm not opposed to some snippets too but I'm finding it to be a whole lot of noise right now, especially with both SS3 and SS4 snippets showing up. More configurability would be much appreciated.

Auto indent support

Thanks for this extension! It seems to work pretty well although I'm finding some of the things I can do with an html file don't work with a SS file. One example is auto indent... I like it when VSCode indents my lines automatically when I move them around. It seems a definition could be added to this extension to make that work, here is the info: https://code.visualstudio.com/updates/v1_14#_auto-indent-on-type-move-lines-and-paste

I'm not really following what is going on there but maybe it means something to you. I guess the indent rules could be copied from the html definition?

Snippets Overview/Cheatsheet

I think it would be really helpful to have an overview/cheatsheet of what snippets are available by default (like just a markdown file or something). If this is already available please point it out to me because I've had a look and haven't been able to find anything.

HTML Formatting

I noticed that the formatting breaks on the "id" html attribute. Escaping the the equals restores formatting. As far as I can tell so far It only occurs on that tag, If I experience any other issues related to formatting caused by attributes I'll add them here.

Broken:
<div class="row" id="MainContent">...blah.blah.blah...</div>

Temporary fix:
<div class="row" id\="MainContent">...blah.blah.blah...</div>

Edited: Forgot to escape my sample code...

Need HTML Snippet

I've added Silverstripe into VScode and while I have all the snippets setup for SilverStripe. I lost all the HTML snippets.

Is there a way to inherit the snippets from HTML file types?

Poor Intellisense performance in project with SilverStripe CMS requirement

I've been having on-and-off bad performance with Intellisense in PHP for the past few days, and seem to have tracked it down to only occurring when I have this module enabled, and a specific folder open (either on its own, or as part of a workspace).

In the composer.json for that folder:

{
    ...
    "type": "silverstripe-vendormodule",
    "require": {
        "silverstripe/cms": "^4.0"
    },
    ...
}

When I've got this folder open, it takes a few seconds for the Intellisense list to be populated, and if I close the folder, or roll this module back to 0.0.5, it seems to be working normally.

This doesn't appear to be happening when working in a proper SilverStripe project, i.e. no type key in the composer.json.

Any idea why this could be happening?

Extension issue

• Issue Type: Bug
• Extension Name: silverstripe
• Extension Version: 1.0.6
• OS Version: Darwin x64 20.3.0
• VS Code version: 1.68.1

{
	"messages": [],
	"activationTimes": {
		"codeLoadingTime": 465,
		"activateCallTime": 41905,
		"activateResolvedTime": 15,
		"activationReason": {
			"startup": false,
			"extensionId": {
				"value": "adrianhumphreys.silverstripe",
				"_lower": "adrianhumphreys.silverstripe"
			},
			"activationEvent": "onStartupFinished"
		}
	},
	"runtimeErrors": [],
	"runningLocation": {
		"affinity": 0,
		"kind": 1
	}
}

Extension issue

• Issue Type: Bug
• Extension Name: silverstripe
• Extension Version: 1.0.6
• OS Version: Darwin x64 19.6.0
• VSCode version: 1.50.1

⚠️ We have written the needed data into your clipboard. Please paste! ⚠️

Feature Suggestion: Go to Definition

With VSCode (and PHP Storm) you can use cmd/ctrl + click to navigate to a PHP class definition if you click on a place that it's used in the code.
In PHP Storm this also works inside silverstripe template files, if you click on the name inside an include tag.
For example:
if you were to use cmd+click on the text "PageHead" inside this: <% include PageHead %>, then the editor would attempt to navigate to the PageHead.ss file.
This would be super useful functionality to add for larger sites with more template files.

Sorry if this is the wrong place to suggest this, I'm not even sure if it's possible, I'm not well versed in vscode plugins.

Commenting Shortcut

Would be helpful if you could use the commenting shortcut for a line, just like HTML syntax... e.g. cmd+/ would comment the whole line.

id attribute breaks syntax highlighting for the rest of the file

<div class="id" id="test">
    <div>
        <div>
        </div>
    </div>
</div>

This code highlighting fails after the id="

With id:

Without id:

formatting

it seems that using this, it removes the ability to format html. any idea how to handle this?

by simply setting the association in "files.associations" I can format .ss files, but obviously snippets and colors are gone.

Highlighting breaks after invalid css in <style> tag

Smallest reproducable example is

<style>a</style>

data- attributes are highlighted differently for some reason.
Adding {}</style> anywhere else in the file after the highlighting is broken will fix it.

<span class="foo" style="baz" data-foo="qux">bar</span>
<style>a</style>
<span class="foo" style="baz">bar</span>
<span class="foo" style="baz" data-foo="qux">bar</span>
{}</style>
<span class="foo" style="baz">bar</span>
<span class="foo" style="baz" data-foo="qux">bar</span>

I came accross this editing an email template that has HTML comment markers around the style content

<style>
  <!--
    .foo { bar: baz; }
  -->
</style>

However in this case I think its just treating --> as an unfinished selector.

The highlighting changes depending on the last bit of code before the closing </style> tag. The following three each have different results.

--> Not working
-->{ Not working, but different
-->{} OK

Quick suggestions popup isn't populated with SilverStripe snippets

Following on from #17 (comment),

The quick suggestions popup doesn't get populated with SilverStripe snippets - to get them, I need to hit esc, then ctrl+space to bring up the suggestion popup again.

My bindings for ctrl+space are the defaults:

102 second startup time

• Issue Type: Bug
• Extension Name: silverstripe
• Extension Version: 1.0.6
• OS Version: Windows_NT x64 10.0.18362
• VSCode version: 1.49.0-insider

{
	"messages": [],
	"activationTimes": {
		"codeLoadingTime": 219,
		"activateCallTime": 102047,
		"activateResolvedTime": 10,
		"activationReason": {
			"startup": false,
			"extensionId": {
				"value": "adrianhumphreys.silverstripe",
				"_lower": "adrianhumphreys.silverstripe"
			},
			"activationEvent": "onStartupFinished"
		}
	},
	"runtimeErrors": []
}

The project is a basic Craft CMS website template, with no SilverStripe template files. Running over Remote SSH, though opening empty projects over SSH works fine.

Highlights break with SS tags inside quotes

The default Page.ss template that the "Simple" theme includes breaks the highlighting, specifically this line:

<body class="$ClassName.ShortName<% if not $Menu(2) %> no-sidebar<% end_if %>" <% if $i18nScriptDirection %>dir="$i18nScriptDirection"<% end_if %>>

Attaching image of how it breaks: