draft

microsoft · Feb 15, 2024 · bd8c2ed · bd8c2ed
1 parent cfde219
commit bd8c2ed
Show file tree

Hide file tree

Showing 7 changed files with 384 additions and 0 deletions.
diff --git a/LSP/Sample/Example-language-configuration.json b/LSP/Sample/Example-language-configuration.json
@@ -0,0 +1,44 @@
+{
+    "comments": {
+      "lineComment": "***",
+      "blockComment": ["{*", "*}"]
+    },
+    "brackets": [
+      ["@", "@"],
+      ["#", "#"],
+      ["$", "$"],
+      ["(", ")"]
+    ],
+    "autoClosingPairs": [
+      { "open": "{", "close": "}" },
+      { "open": "@", "close": "@" },
+      { "open": "#", "close": "#" },
+      { "open": "$", "close": "$" },
+      { "open": "(", "close": ")" },
+      { "open": "'", "close": "'", "notIn": ["string", "comment"] },
+      { "open": "\"", "close": "\"", "notIn": ["string"] },
+    ],
+    "autoCloseBefore": ";:.,=}])>` \n\t",
+    "surroundingPairs": [
+      ["@", "@"],
+      ["#", "#"],
+      ["$", "$"],
+      ["[", "]"],
+      ["(", ")"],
+      ["'", "'"],
+      ["\"", "\""],
+      ["`", "`"]
+    ],
+    "folding": {
+      "markers": {
+        "start": "^\\s*//\\s*#?region\\b",
+        "end": "^\\s*//\\s*#?endregion\\b"
+      }
+    },
+    "wordPattern": "(-?\\d*\\.\\d\\w*)|([^\\`\\~\\!\\@\\#\\%\\^\\&\\*\\(\\)\\-\\=\\+\\[\\{\\]\\}\\\\\\|\\;\\:\\'\\\"\\,\\.\\<\\>\\/\\?\\s]+)",
+    "indentationRules": {
+      "increaseIndentPattern": "^((?!\\/\\/).)*(\\{[^}\"'`]*|\\([^)\"'`]*|\\[[^\\]\"'`]*)$",
+      "decreaseIndentPattern": "^((?!.*?\\/\\*).*\\*/)?\\s*[\\)\\}\\]].*$"
+    }
+  }
+
diff --git a/LSP/Sample/ExampleVSIXProject.csproj b/LSP/Sample/ExampleVSIXProject.csproj
@@ -0,0 +1,84 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="15.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <PropertyGroup>
+    <MinimumVisualStudioVersion>17.0</MinimumVisualStudioVersion>
+    <VSToolsPath Condition="'$(VSToolsPath)' == ''">$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)</VSToolsPath>
+  </PropertyGroup>
+  <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />
+  <PropertyGroup>
+    <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
+    <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
+    <SchemaVersion>2.0</SchemaVersion>
+    <ProjectTypeGuids>{82b43b9b-a64c-4715-b499-d71e9ca2bd60};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}</ProjectTypeGuids>
+    <ProjectGuid>{990D31C8-5BB5-4ADD-A55D-D723CC00DA71}</ProjectGuid>
+    <OutputType>Library</OutputType>
+    <AppDesignerFolder>Properties</AppDesignerFolder>
+    <RootNamespace>ExampleVSIXProject</RootNamespace>
+    <AssemblyName>ExampleVSIXProject</AssemblyName>
+    <TargetFrameworkVersion>v4.7.2</TargetFrameworkVersion>
+    <GeneratePkgDefFile>true</GeneratePkgDefFile>
+    <UseCodebase>true</UseCodebase>
+    <IncludeAssemblyInVSIXContainer>true</IncludeAssemblyInVSIXContainer>
+    <IncludeDebugSymbolsInVSIXContainer>false</IncludeDebugSymbolsInVSIXContainer>
+    <IncludeDebugSymbolsInLocalVSIXDeployment>false</IncludeDebugSymbolsInLocalVSIXDeployment>
+    <CopyBuildOutputToOutputDirectory>true</CopyBuildOutputToOutputDirectory>
+    <CopyOutputSymbolsToOutputDirectory>true</CopyOutputSymbolsToOutputDirectory>
+    <StartAction>Program</StartAction>
+    <StartProgram Condition="'$(DevEnvDir)' != ''">$(DevEnvDir)devenv.exe</StartProgram>
+    <StartArguments>/rootsuffix Exp</StartArguments>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
+    <DebugSymbols>true</DebugSymbols>
+    <DebugType>full</DebugType>
+    <Optimize>false</Optimize>
+    <OutputPath>bin\Debug\</OutputPath>
+    <DefineConstants>DEBUG;TRACE</DefineConstants>
+    <ErrorReport>prompt</ErrorReport>
+    <WarningLevel>4</WarningLevel>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
+    <DebugType>pdbonly</DebugType>
+    <Optimize>true</Optimize>
+    <OutputPath>bin\Release\</OutputPath>
+    <DefineConstants>TRACE</DefineConstants>
+    <ErrorReport>prompt</ErrorReport>
+    <WarningLevel>4</WarningLevel>
+  </PropertyGroup>
+  <ItemGroup>
+    <Compile Include="Properties\AssemblyInfo.cs" />
+    <Compile Include="ExampleVSIXProjectPackage.cs" />
+  </ItemGroup>
+  <ItemGroup>
+    <Content Include="Example-language-configuration.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+      <IncludeInVSIX>true</IncludeInVSIX>
+    </Content>
+    <Content Include="Test.pkgdef">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+      <IncludeInVSIX>true</IncludeInVSIX>
+    </Content>
+    <Content Include="Grammars\Example.tmlanguage">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+      <IncludeInVSIX>true</IncludeInVSIX>
+    </Content>
+    <None Include="source.extension.vsixmanifest">
+      <SubType>Designer</SubType>
+    </None>
+  </ItemGroup>
+  <ItemGroup>
+    <Reference Include="System" />
+  </ItemGroup>
+  <ItemGroup>
+    <PackageReference Include="Microsoft.VisualStudio.SDK" Version="17.0.32112.339" ExcludeAssets="runtime" />
+    <PackageReference Include="Microsoft.VSSDK.BuildTools" Version="17.10.29-preview1" />
+  </ItemGroup>
+  <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
+  <Import Project="$(VSToolsPath)\VSSDK\Microsoft.VsSDK.targets" Condition="'$(VSToolsPath)' != ''" />
+  <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
+       Other similar extension points exist, see Microsoft.Common.targets.
+  <Target Name="BeforeBuild">
+  </Target>
+  <Target Name="AfterBuild">
+  </Target>
+  -->
+</Project>
diff --git a/LSP/Sample/ExampleVSIXProjectPackage.cs b/LSP/Sample/ExampleVSIXProjectPackage.cs
@@ -0,0 +1,53 @@
+using Microsoft.VisualStudio.Shell;
+using System;
+using System.Runtime.InteropServices;
+using System.Threading;
+using Task = System.Threading.Tasks.Task;
+
+namespace ExampleVSIXProject
+{
+  /// <summary>
+  /// This is the class that implements the package exposed by this assembly.
+  /// </summary>
+  /// <remarks>
+  /// <para>
+  /// The minimum requirement for a class to be considered a valid package for Visual Studio
+  /// is to implement the IVsPackage interface and register itself with the shell.
+  /// This package uses the helper classes defined inside the Managed Package Framework (MPF)
+  /// to do it: it derives from the Package class that provides the implementation of the
+  /// IVsPackage interface and uses the registration attributes defined in the framework to
+  /// register itself and its components with the shell. These attributes tell the pkgdef creation
+  /// utility what data to put into .pkgdef file.
+  /// </para>
+  /// <para>
+  /// To get loaded into VS, the package must be referred by &lt;Asset Type="Microsoft.VisualStudio.VsPackage" ...&gt; in .vsixmanifest file.
+  /// </para>
+  /// </remarks>
+  [PackageRegistration(UseManagedResourcesOnly = true, AllowsBackgroundLoading = true)]
+  [Guid(ExampleVSIXProjectPackage.PackageGuidString)]
+  public sealed class ExampleVSIXProjectPackage : AsyncPackage
+  {
+    /// <summary>
+    /// ExampleVSIXProjectPackage GUID string.
+    /// </summary>
+    public const string PackageGuidString = "3315cf24-8c22-4c23-862b-ee113d0bea8b";
+
+    #region Package Members
+
+    /// <summary>
+    /// Initialization of the package; this method is called right after the package is sited, so this is the place
+    /// where you can put all the initialization code that rely on services provided by VisualStudio.
+    /// </summary>
+    /// <param name="cancellationToken">A cancellation token to monitor for initialization cancellation, which can occur when VS is shutting down.</param>
+    /// <param name="progress">A provider for progress updates.</param>
+    /// <returns>A task representing the async work of package initialization, or an already completed task if there is none. Do not return null from this method.</returns>
+    protected override async Task InitializeAsync(CancellationToken cancellationToken, IProgress<ServiceProgressData> progress)
+    {
+      // When initialized asynchronously, the current thread may be a background thread at this point.
+      // Do any initialization that requires the UI thread after switching to the UI thread.
+      await this.JoinableTaskFactory.SwitchToMainThreadAsync(cancellationToken);
+    }
+
+    #endregion
+  }
+}
diff --git a/LSP/Sample/Grammars/Example.tmlanguage b/LSP/Sample/Grammars/Example.tmlanguage
@@ -0,0 +1,169 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+    <dict>
+        <key>uuid</key>
+        <string>E07EC438-7B75-4437-8AA1-DA94C1E6EACC</string>
+        <key>patterns</key>
+        <array>
+            <dict>
+                <key>name</key>
+                <string>keyword.command.dosbatch</string>
+                <key>match</key>
+                <string>\b(?i)(?:append|assoc|at|attrib|break|cacls|cd|chcp|chdir|chkdsk|chkntfs|cls|cmd|color|comp|compact|convert|copy|date|del|dir|diskcomp|diskcopy|doskey|echo|endlocal|erase|fc|find|findstr|format|ftype|graftabl|help|keyb|label|md|mkdir|mode|more|move|path|pause|popd|print|prompt|pushd|rd|recover|ren|rename|replace|restore|rmdir|set|setlocal|shift|sort|start|subst|time|title|tree|type|ver|verify|vol|xcopy)\b</string>
+            </dict>
+            <dict>
+                <key>name</key>
+                <string>keyword.control.statement.dosbatch</string>
+                <key>match</key>
+                <string>\b(?i)(?:goto|call|exit)\b</string>
+            </dict>
+            <dict>
+                <key>name</key>
+                <string>keyword.control.conditional.if.dosbatch</string>
+                <key>match</key>
+                <string>\b(?i)if\s+((not)\s+)(exist|defined|errorlevel|cmdextversion)\b</string>
+            </dict>
+            <dict>
+                <key>name</key>
+                <string>keyword.control.conditional.dosbatch</string>
+                <key>match</key>
+                <string>\b(?i)(?:if|else)\b</string>
+            </dict>
+            <dict>
+                <key>name</key>
+                <string>keyword.control.repeat.dosbatch</string>
+                <key>match</key>
+                <string>\b(?i)for\b</string>
+            </dict>
+            <dict>
+                <key>name</key>
+                <string>keyword.operator.dosbatch</string>
+                <key>match</key>
+                <string>\b(?:EQU|NEQ|LSS|LEQ|GTR|GEQ)\b</string>
+            </dict>
+            <dict>
+                <key>name</key>
+                <string>comment.line.rem.dosbatch</string>
+                <key>match</key>
+                <string>\b(?i)rem(?:$|\s.*$)</string>
+            </dict>
+            <dict>
+                <key>name</key>
+                <string>comment.line.colons.dosbatch</string>
+                <key>match</key>
+                <string>\s*:\s*:.*$</string>
+            </dict>
+            <dict>
+                <key>captures</key>
+                <dict>
+                    <key>1</key>
+                    <dict>
+                        <key>name</key>
+                        <string>variable.parameter.function.begin.shell</string>
+                    </dict>
+                </dict>
+                <key>name</key>
+                <string>variable.parameter.function.dosbatch</string>
+                <key>match</key>
+                <string>(?i)(%)(~(?:f|d|p|n|x|s|a|t|z|\$[^:]*:)*)?\d</string>
+            </dict>
+            <dict>
+                <key>captures</key>
+                <dict>
+                    <key>1</key>
+                    <dict>
+                        <key>name</key>
+                        <string>variable.parameter.loop.begin.shell</string>
+                    </dict>
+                </dict>
+                <key>name</key>
+                <string>variable.parameter.loop.dosbatch</string>
+                <key>match</key>
+                <string>(?i)(%%)(~(?:f|d|p|n|x|s|a|t|z|\$[^:]*:)*)?[a-z]</string>
+            </dict>
+            <dict>
+                <key>captures</key>
+                <dict>
+                    <key>1</key>
+                    <dict>
+                        <key>name</key>
+                        <string>variable.other.parsetime.begin.shell</string>
+                    </dict>
+                    <key>2</key>
+                    <dict>
+                        <key>name</key>
+                        <string>variable.other.parsetime.end.shell</string>
+                    </dict>
+                </dict>
+                <key>name</key>
+                <string>variable.other.parsetime.dosbatch</string>
+                <key>match</key>
+                <string>(%)[^%]+(%)</string>
+            </dict>
+            <dict>
+                <key>captures</key>
+                <dict>
+                    <key>1</key>
+                    <dict>
+                        <key>name</key>
+                        <string>variable.other.delayed.begin.shell</string>
+                    </dict>
+                    <key>2</key>
+                    <dict>
+                        <key>name</key>
+                        <string>variable.other.delayed.end.shell</string>
+                    </dict>
+                </dict>
+                <key>name</key>
+                <string>variable.other.delayed.dosbatch</string>
+                <key>match</key>
+                <string>(!)[^!]+(!)</string>
+            </dict>
+            <dict>
+                <key>begin</key>
+                <string>"</string>
+                <key>endCaptures</key>
+                <dict>
+                    <key>0</key>
+                    <dict>
+                        <key>name</key>
+                        <string>punctuation.definition.string.end.shell</string>
+                    </dict>
+                </dict>
+                <key>beginCaptures</key>
+                <dict>
+                    <key>0</key>
+                    <dict>
+                        <key>name</key>
+                        <string>punctuation.definition.string.begin.shell</string>
+                    </dict>
+                </dict>
+                <key>name</key>
+                <string>string.quoted.double.dosbatch</string>
+                <key>end</key>
+                <string>"|$</string>
+            </dict>
+            <dict>
+                <key>name</key>
+                <string>keyword.operator.pipe.dosbatch</string>
+                <key>match</key>
+                <string>[|]</string>
+            </dict>
+            <dict>
+                <key>name</key>
+                <string>keyword.operator.redirect.shell</string>
+                <key>match</key>
+                <string>&amp;&gt;|\d*&gt;&amp;\d*|\d*(&gt;&gt;|&gt;|&lt;)|\d*&lt;&amp;|\d*&lt;&gt;</string>
+            </dict>
+        </array>
+        <key>name</key>
+        <string>Example File</string>
+        <key>scopeName</key>
+        <string>source.Example</string>
+        <key>fileTypes</key>
+        <array>
+          <string>Example</string>
+        </array>
+    </dict>
+</plist>
diff --git a/LSP/Sample/ReadMe.md b/LSP/Sample/ReadMe.md
@@ -0,0 +1,6 @@
+## Language Configuration Sample Documentation
+
+This is a sample project that shows how language configuration works and can be used as an example for creating your own. 
+
+This VSIX project contains pckgdef file, language-configuration.json, grammar file.  All together this provide information that enables the Visual Studio editor to make formatting, colorization, and completion decisions without the delay of making an asynchronous query to the LSP server. 
+
diff --git a/LSP/Sample/Test.pkgdef b/LSP/Sample/Test.pkgdef
@@ -0,0 +1,5 @@
+[$RootKey$\TextMate\Repositories]
+"ExampleGrammars"="$PackageFolder$\Grammars"
+
+[$RootKey$\TextMate\LanguageConfiguration\GrammarMapping]
+"source.Example"="$PackageFolder$\Example-language-configuration.json"
diff --git a/LSP/Sample/source.extension.vsixmanifest b/LSP/Sample/source.extension.vsixmanifest
@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="utf-8"?>
+<PackageManifest Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vsx-schema/2011" xmlns:d="http://schemas.microsoft.com/developer/vsx-schema-design/2011">
+  <Metadata>
+    <Identity Id="ExampleVSIXProject.77726167-b776-4ca1-8c0b-357159ee6465" Version="1.0" Language="en-US" Publisher="Eptisam Kassim" />
+    <DisplayName>ExampleVSIXProject</DisplayName>
+    <Description>Empty VSIX Project.</Description>
+  </Metadata>
+  <Installation>
+    <InstallationTarget Id="Microsoft.VisualStudio.Community" Version="[17.0, 18.0)">
+      <ProductArchitecture>amd64</ProductArchitecture>
+    </InstallationTarget>
+  </Installation>
+  <Dependencies>
+    <Dependency Id="Microsoft.Framework.NDP" DisplayName="Microsoft .NET Framework" d:Source="Manual" Version="[4.5,)" />
+  </Dependencies>
+  <Prerequisites>
+    <Prerequisite Id="Microsoft.VisualStudio.Component.CoreEditor" Version="[17.0,18.0)" DisplayName="Visual Studio core editor" />
+  </Prerequisites>
+  <Assets>
+    <Asset Type="Microsoft.VisualStudio.VsPackage" d:Source="Project" d:ProjectName="%CurrentProject%" Path="|%CurrentProject%;PkgdefProjectOutputGroup|" />
+		<Asset Type="Microsoft.VisualStudio.VsPackage" Path="Test.pkgdef"/>
+  </Assets>
+</PackageManifest>