Reorg for v4.0.0

michaelblyons · michaelblyons · commit 3a62e5fce093 · 2020-05-17T15:16:07.000-04:00
- Add a scope suffix to ASP.Net/WebForms to differentiate from Razor.

    + *Breaking change:* The Razor syntax now "owns" the `.cshtml` file
      extension. If you need it bound to WebForms-style pages, use the "Open
      all with current extension as..." option from the Syntax selector menu
      in the bottom-right.

    + This also means that completions and so on can be more easily targeted at
      one or the other syntax.

- Move some completions to snippets

    + *Breaking change:* The `exp*` completions have been removed in favor of
      typing the `&lt;%*` expressions themselves.

- Enable autocomplete by default in ASP.Net, and on `@` for Razor.

- Razor gets comment block toggling (although it's not perfect).
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,4 +1,4 @@
-Copyright 2016-2019 Michael Lyons
+Copyright 2016-2020 Michael Lyons
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # [HTML (C#)][pkg]
 
-[Sublime Text 3][st3] [syntax highlighting][ss-docs] for `.cshtml`, `.aspx`, and similar files.
+[Sublime Text][st] [syntax highlighting][ss-docs] for `.cshtml`, `.aspx`, and similar files.
 
 ## Current support
 
@@ -14,16 +14,15 @@
 
 - Hotkey comment/uncomment server-side comments (<kbd>Ctrl</kbd>+<kbd>/</kbd> or <kbd>Cmd</kbd>+<kbd>/</kbd>)
 
-- Snippets for `<%` expressions (Try typing `exp`)
-    + These are subject to change.
+- Snippets for `<%`-ish expressions
 - Snippets for some directives (Try `page` or `import`)
     + Default attributes are subject to change.
 - Snippets may require <kbd>Ctrl</kbd>+<kbd>space</kbd>, depending on your environment.
 - Some autocomplete within directives.
 
 ### Razor syntax
 
-Huge thank-you to @keith-hall for this!
+A huge thank-you to [@keith-hall][keith] for this!
 
 ## Future support (maybe)
 
@@ -53,5 +52,6 @@ Huge thank-you to @keith-hall for this!
     ```
 
 [pkg]: https://packagecontrol.io/packages/HTML%20(C%23)
-[st3]: https://www.sublimetext.com/
-[ss-docs]: https://www.sublimetext.com/docs/3/syntax.html
+[st]: https://www.sublimetext.com/
+[ss-docs]: https://www.sublimetext.com/docs/syntax.html
+[keith]: https://github.com/keith-hall
diff --git a/aspnet.sublime-syntax b/aspnet.sublime-syntax
@@ -6,9 +6,8 @@ file_extensions:
   - aspx
   - ascx
   - asax
-  - cshtml
   - master
-scope: embedding.cshtml
+scope: embedding.cshtml.aspnet
 contexts:
   main:
     - include: html
@@ -152,6 +151,8 @@ contexts:
     - match: ''
       set: scope:text.html.basic
       with_prototype:
+        - match: <(?=<)
+          scope: invalid.illegal.cshtml
         - include: comments
         - include: script-tag-cs
         - include: directive
diff --git a/completions/cshtml.sublime-completions b/completions/cshtml.sublime-completions
diff --git a/completions/directives/root.sublime-completions b/completions/directives/root.sublime-completions
diff --git a/cshtml.sublime-settings b/cshtml.sublime-settings
@@ -0,0 +1,9 @@
+{
+    "auto_complete_selector": "embedding.cshtml.aspnet - comment",
+    "auto_complete_triggers": [
+        {
+            "characters": "@",
+            "selector": "embedding.cshtml.razor",
+        }
+    ]
+}
diff --git a/messages/4.0.0.md b/messages/4.0.0.md
@@ -0,0 +1,21 @@
+v4.0.0 (2020-05-17)
+===================
+
+- Add a scope suffix to ASP.Net/WebForms to differentiate from Razor.
+
+    + *Breaking change:* The Razor syntax now "owns" the `.cshtml` file
+      extension. If you need it bound to WebForms-style pages, use the "Open
+      all with current extension as..." option from the Syntax selector menu
+      in the bottom-right.
+
+    + This also means that completions and so on can be more easily targeted at
+      one or the other syntax.
+
+- Move some completions to snippets
+
+    + *Breaking change:* The `exp*` completions have been removed in favor of
+      typing the `<%*` expressions themselves.
+
+- Enable autocomplete by default in ASP.Net, and on `@` for Razor.
+
+- Razor gets comment block toggling (although it's not perfect).
diff --git a/messaging.json b/messaging.json
@@ -1,3 +1,4 @@
 {
+    "4.0.0": "messages/4.0.0.md",
     "3.0.0": "messages/3.0.0.md"
 }
diff --git a/support/ASP.Net/Comments.tmPreferences b/support/ASP.Net/Comments.tmPreferences
@@ -5,8 +5,8 @@
     <string>Comments</string>
     <key>scope</key>
     <string>
-        embedding.cshtml,
-        embedding.cshtml text.html
+        embedding.cshtml.aspnet,
+        embedding.cshtml.aspnet text.html
     </string>
     <key>settings</key>
     <dict>
diff --git a/support/ASP.Net/code-blocks/code-block.sublime-snippet b/support/ASP.Net/code-blocks/code-block.sublime-snippet
@@ -0,0 +1,8 @@
+<snippet>
+    <scope>embedding.cshtml.aspnet - source.cs</scope>
+    <tabTrigger>&lt;%</tabTrigger>
+    <content><![CDATA[<%
+    ${1}
+%>]]></content>
+    <description>&lt;% … %&gt;</description>
+</snippet>
diff --git a/support/ASP.Net/code-blocks/foreach-block.sublime-snippet b/support/ASP.Net/code-blocks/foreach-block.sublime-snippet
@@ -0,0 +1,8 @@
+<snippet>
+    <scope>embedding.cshtml.aspnet - source.cs</scope>
+    <tabTrigger>foreach</tabTrigger>
+    <content><![CDATA[<% foreach (var ${1:item} in ${2:Enumerable}) { %>
+    ${3}
+<% } %>]]></content>
+    <description>&lt;% foreach (…) { %&gt;</description>
+</snippet>
diff --git a/support/ASP.Net/code-blocks/if-block.sublime-snippet b/support/ASP.Net/code-blocks/if-block.sublime-snippet
@@ -0,0 +1,8 @@
+<snippet>
+    <scope>embedding.cshtml.aspnet - source.cs</scope>
+    <tabTrigger>if</tabTrigger>
+    <content><![CDATA[<% if (${1:true}) { %>
+    ${2}
+<% } %>]]></content>
+    <description>&lt;% if (…) { %&gt;</description>
+</snippet>
diff --git a/support/ASP.Net/controls/Repeater.sublime-snippet b/support/ASP.Net/controls/Repeater.sublime-snippet
@@ -0,0 +1,10 @@
+<snippet>
+    <scope>embedding.cshtml.aspnet - source.cs</scope>
+    <tabTrigger>&lt;asp:Repeater</tabTrigger>
+    <content><![CDATA[<asp:Repeater runat="server">
+    <ItemTemplate>
+        <%# Eval("${1:Property}") %>
+    </ItemTemplate>
+</asp:Repeater>]]></content>
+    <description>Control</description>
+</snippet>
diff --git a/support/ASP.Net/directives/OutputCache.sublime-completions b/support/ASP.Net/directives/OutputCache.sublime-completions
@@ -1,6 +1,6 @@
 {
     // https://msdn.microsoft.com/en-us/library/hdxfb6cy(v=vs.100).aspx
-    "scope": "embedding.cshtml meta.block.processing-directive.contents.outputcache",
+    "scope": "embedding.cshtml.aspnet meta.block.processing-directive.contents.outputcache",
     "completions": [
         { "trigger": "Duration\tOutputCache", "contents": "Duration=\"${1:120}\" " },
         { "trigger": "Location\tOutputCache", "contents": "Location=\"${1:Any | Client | Downstream | Server | None | ServerAndClient}\" " },
diff --git a/support/ASP.Net/directives/directive types.sublime-completions b/support/ASP.Net/directives/directive types.sublime-completions
@@ -0,0 +1,92 @@
+{
+    // https://msdn.microsoft.com/en-us/library/xz702w3e(v=vs.100).aspx
+    "scope": "embedding.cshtml.aspnet meta.block.processing-directive - meta.block.processing-directive.contents",
+    "completions": [
+        {
+            "trigger": "Application\tDirective",
+            "contents": "Application",
+            "annotation": "Directive",
+            "kind": "keyword",
+            "details": "Define file as <code>Application</code>",
+        },
+        {
+            "trigger": "Page\tDirective",
+            "contents": "Page",
+            "annotation": "Directive",
+            "kind": "keyword",
+            "details": "Define file as <code>Page</code>",
+        },
+        {
+            "trigger": "Control\tDirective",
+            "contents": "Control",
+            "annotation": "Directive",
+            "kind": "keyword",
+            "details": "Define file as <code>UserControl</code>",
+        },
+        {
+            "trigger": "Import\tDirective",
+            "contents": "Import Namespace=\"${1:System.Net}\" ",
+            "annotation": "Directive",
+            "kind": "snippet",
+            "details": "Import a namespace for use in this file",
+        },
+        {
+            "trigger": "Implements\tDirective",
+            "contents": "Implements Interface=\"${1:IFoo}\" ",
+            "annotation": "Directive",
+            "kind": "snippet",
+        },
+        {
+            "trigger": "Register\tDirective",
+            "contents": "Register",
+            "annotation": "Directive",
+            "kind": "keyword",
+            "details": "Register a tag prefix",
+        },
+        {
+            "trigger": "Assembly\tDirective",
+            "contents": "Assembly",
+            "annotation": "Directive",
+            "kind": "keyword",
+        },
+        {
+            "trigger": "OutputCache\tDirective",
+            "contents": "OutputCache Duration=\"${1:120}\" ",
+            "annotation": "Directive",
+            "kind": "snippet",
+        },
+        {
+            "trigger": "Reference\tDirective",
+            "contents": "Reference",
+            "annotation": "Directive",
+            "kind": "keyword",
+        },
+        {
+            "trigger": "Master\tDirective",
+            "contents": "Master",
+            "annotation": "Directive",
+            "kind": "keyword",
+            "details": "Define file as a <code>Master</code> page",
+
+        },
+        {
+            "trigger": "PreviousPageType\tDirective",
+            "contents": "PreviousPageType",
+            "annotation": "Directive",
+            "kind": "keyword",
+        },
+        {
+            "trigger": "MasterType\tDirective",
+            "contents": "MasterType",
+            "annotation": "Directive",
+            "kind": "keyword",
+        },
+        // // Web Handlers are their own kind of file
+        // {
+        //     "trigger": "WebHandler\tDirective",
+        //     "contents": "WebHandler",
+        //     "annotation": "Directive",
+        //     "kind": "keyword",
+        // },
+    ]
+}
diff --git a/support/ASP.Net/expressions/appsetting.sublime-snippet b/support/ASP.Net/expressions/appsetting.sublime-snippet
@@ -0,0 +1,6 @@
+<snippet>
+    <scope>embedding.cshtml.aspnet - source.cs</scope>
+    <tabTrigger>&lt;%$</tabTrigger>
+    <content><![CDATA[<%\$ ${1:AppSettings}: ${2:key} %>]]></content>
+    <description>&lt;%$ … %&gt;</description>
+</snippet>
diff --git a/support/ASP.Net/expressions/databound-encoded.sublime-snippet b/support/ASP.Net/expressions/databound-encoded.sublime-snippet
@@ -0,0 +1,6 @@
+<snippet>
+    <scope>embedding.cshtml.aspnet - source.cs</scope>
+    <tabTrigger>&lt;%#:</tabTrigger>
+    <content><![CDATA[<%#: Eval(\"${1:Property}\") %>]]></content>
+    <description>&lt;%#: Eval(…) %&gt;</description>
+</snippet>
diff --git a/support/ASP.Net/expressions/databound.sublime-snippet b/support/ASP.Net/expressions/databound.sublime-snippet
@@ -0,0 +1,6 @@
+<snippet>
+    <scope>embedding.cshtml.aspnet - source.cs</scope>
+    <tabTrigger>&lt;%#</tabTrigger>
+    <content><![CDATA[<%# Eval("${1:Property}") %>]]></content>
+    <description>&lt;%# Eval(…) %&gt;</description>
+</snippet>
diff --git a/support/ASP.Net/expressions/directive.sublime-snippet b/support/ASP.Net/expressions/directive.sublime-snippet
@@ -0,0 +1,6 @@
+<snippet>
+    <scope>embedding.cshtml.aspnet - source.cs</scope>
+    <tabTrigger>&lt;%@</tabTrigger>
+    <content><![CDATA[<%@ ${1:Directive} %>]]></content>
+    <description>&lt;%@ … %&gt;</description>
+</snippet>
diff --git a/support/ASP.Net/expressions/encoded.sublime-snippet b/support/ASP.Net/expressions/encoded.sublime-snippet
@@ -0,0 +1,6 @@
+<snippet>
+    <scope>embedding.cshtml.aspnet - source.cs</scope>
+    <tabTrigger>&lt;%:</tabTrigger>
+    <content><![CDATA[<%: ${1:Object} %>]]></content>
+    <description>&lt;%: … %&gt;</description>
+</snippet>
diff --git a/support/ASP.Net/expressions/literal.sublime-snippet b/support/ASP.Net/expressions/literal.sublime-snippet
@@ -0,0 +1,6 @@
+<snippet>
+    <scope>embedding.cshtml.aspnet - source.cs</scope>
+    <tabTrigger>&lt;%=</tabTrigger>
+    <content><![CDATA[<%= ${1:Object} %>]]></content>
+    <description>&lt;%= … %&gt;</description>
+</snippet>
diff --git a/support/ASP.Net/root.sublime-completions b/support/ASP.Net/root.sublime-completions
@@ -0,0 +1,26 @@
+{
+    "scope": "embedding.cshtml.aspnet - source.cs",
+    "completions": [
+        // Directives
+        {
+            "trigger": "directive\t<%@ … %>",
+            "contents": "<%@ ${1:Directive} %>",
+            "kind": "snippet",
+        },
+        {
+            "trigger": "page\t<%@ Page … %>",
+            "contents": "<%@ Page${1: Language=\"C#\"}${2: Inherits=\"${3:System.Web.UI.Page}\"} %>",
+            "kind": "snippet",
+        },
+        {
+            "trigger": "control\t<%@ Control … %>",
+            "contents": "<%@ Control${1: Language=\"C#\"}${2: Inherits=\"${3:System.Web.UI.UserControl}\"} %>",
+            "kind": "snippet",
+        },
+        {
+            "trigger": "import\t<%@ Import … %>",
+            "contents": "<%@ Import Namespace=\"${1:System.Net}\" %>",
+            "kind": "snippet",
+        },
+    ]
+}
diff --git a/support/Razor/Comments.tmPreferences b/support/Razor/Comments.tmPreferences
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<plist version="1.0">
+<dict>
+    <key>name</key>
+    <string>Comments</string>
+    <key>scope</key>
+    <string>
+        embedding.cshtml.razor,
+        embedding.cshtml.razor text.html
+    </string>
+    <key>settings</key>
+    <dict>
+        <key>shellVariables</key>
+        <array>
+            <dict>
+                <key>name</key>
+                <string>TM_COMMENT_START</string>
+                <key>value</key>
+                <string><![CDATA[@* ]]></string>
+            </dict>
+            <dict>
+                <key>name</key>
+                <string>TM_COMMENT_END</string>
+                <key>value</key>
+                <string><![CDATA[ *@]]></string>
+            </dict>
+        </array>
+    </dict>
+</dict>
+</plist>
diff --git a/support/Symbol List Directives.tmPreferences b/support/Symbol List Directives.tmPreferences
diff --git a/tests/syntax_test_aspx.aspx b/tests/syntax_test_aspx.aspx
@@ -1,4 +1,4 @@
-// SYNTAX TEST "Packages/HTML (C#)/cshtml.sublime-syntax"
+// SYNTAX TEST "Packages/HTML (C#)/aspnet.sublime-syntax"
 
 <%@ Page Debug="true" Title="" AutoEventWireup="true" Inherits="System.Web.UI.Page" %>
 // <-                 punctuation.section.embedded.begin.cshtml

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Copyright 2016-2019 Michael Lyons`
	`1`	`+Copyright 2016-2020 Michael Lyons`
`2`	`2`
`3`	`3`	`Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
`1`	`1`	`{`
	`2`	`+ "4.0.0": "messages/4.0.0.md",`
`2`	`3`	`"3.0.0": "messages/3.0.0.md"`
`3`	`4`	`}`