HTML Parsing Extension for preview pane markdown renderer #1108
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| // Copyright (c) Microsoft Corporation | ||
| // The Microsoft Corporation licenses this file to you under the MIT license. | ||
| // See the LICENSE file in the project root for more information. | ||
|
|
||
| using System; | ||
| using System.IO; | ||
| using Markdig; | ||
| using Markdig.Extensions.Figures; | ||
| using Markdig.Extensions.Tables; | ||
| using Markdig.Renderers; | ||
| using Markdig.Renderers.Html; | ||
| using Markdig.Syntax; | ||
| using Markdig.Syntax.Inlines; | ||
|
|
||
| namespace MarkDownPreviewHandler | ||
| { | ||
| /// <summary> | ||
| /// Markdig Extension to process html nodes in markdown AST. | ||
| /// </summary> | ||
| internal class HTMLParsingExtension : IMarkdownExtension | ||
| { | ||
| /// <summary> | ||
| /// Initializes a new instance of the <see cref="HTMLParsingExtension"/> class. | ||
| /// </summary> | ||
| public HTMLParsingExtension(string baseUrl = "") | ||
| { | ||
| this.BaseUrl = baseUrl; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets path to directory containing markdown file. | ||
| /// </summary> | ||
| public string BaseUrl { get; set; } | ||
|
|
||
| /// <inheritdoc/> | ||
| public void Setup(MarkdownPipelineBuilder pipeline) | ||
| { | ||
| // Make sure we don't have a delegate twice | ||
| pipeline.DocumentProcessed -= this.PipelineOnDocumentProcessed; | ||
| pipeline.DocumentProcessed += this.PipelineOnDocumentProcessed; | ||
| } | ||
|
|
||
| /// <inheritdoc/> | ||
| public void Setup(MarkdownPipeline pipeline, IMarkdownRenderer renderer) | ||
| { | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Process nodes in markdown AST. | ||
| /// </summary> | ||
| /// <param name="document">Markdown Document.</param> | ||
| public void PipelineOnDocumentProcessed(MarkdownDocument document) | ||
| { | ||
| foreach (var node in document.Descendants()) | ||
| { | ||
| if (node is Block) | ||
| { | ||
| if (node is Table) | ||
| { | ||
| node.GetAttributes().AddClass("table table-striped table-bordered"); | ||
| } | ||
| else if (node is QuoteBlock) | ||
| { | ||
| node.GetAttributes().AddClass("blockquote"); | ||
| } | ||
| else if (node is Figure) | ||
| { | ||
| node.GetAttributes().AddClass("figure"); | ||
| } | ||
| else if (node is FigureCaption) | ||
| { | ||
| node.GetAttributes().AddClass("figure-caption"); | ||
| } | ||
|
There was a problem hiding this comment. I didn't see a test for this case. There was a problem hiding this comment. Thanks for pointing this out! I have updated tests |
||
| } | ||
| else if (node is Inline) | ||
| { | ||
| if (node is LinkInline link && link.IsImage) | ||
| { | ||
| if (!Uri.TryCreate(link.Url, UriKind.Absolute, out Uri uriLink)) | ||
| { | ||
| link.Url = link.Url.TrimStart('/'); | ||
|
There was a problem hiding this comment. This can be There was a problem hiding this comment. @udit. Is this the only way that 'TryCreate' can fail? I would add some unit tests where the base url has a trailing '/', and the link url has a starting '/'. There was a problem hiding this comment. Sure! I will add tests for these |
||
| this.BaseUrl = this.BaseUrl.TrimEnd('/'); | ||
| uriLink = new Uri(Path.Combine(this.BaseUrl, link.Url)); | ||
| link.Url = uriLink.ToString(); | ||
| } | ||
|
|
||
| link.GetAttributes().AddClass("img-fluid"); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| <?xml version="1.0" encoding="utf-8"?> | ||
| <Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003"> | ||
| <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> | ||
| <ProjectGuid>{6A71162E-FC4C-4A2C-B90F-3CF94F59A9BB}</ProjectGuid> | ||
| <OutputType>Library</OutputType> | ||
| <AppDesignerFolder>Properties</AppDesignerFolder> | ||
| <RootNamespace>MarkDownPreviewHandler</RootNamespace> | ||
| <AssemblyName>MarkDownPreviewHandler</AssemblyName> | ||
| <TargetFrameworkVersion>v4.8</TargetFrameworkVersion> | ||
| <FileAlignment>512</FileAlignment> | ||
| <Deterministic>true</Deterministic> | ||
| </PropertyGroup> | ||
| <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x64' "> | ||
| <DebugSymbols>true</DebugSymbols> | ||
| <DebugType>full</DebugType> | ||
| <Optimize>false</Optimize> | ||
| <OutputPath>bin\Debug\</OutputPath> | ||
| <DefineConstants>DEBUG;TRACE</DefineConstants> | ||
| <ErrorReport>prompt</ErrorReport> | ||
| <WarningLevel>4</WarningLevel> | ||
| <TreatWarningsAsErrors>true</TreatWarningsAsErrors> | ||
| <DocumentationFile>bin/Debug/MarkdownPreviewPaneDocumentation.xml</DocumentationFile> | ||
| <PlatformTarget>x64</PlatformTarget> | ||
| </PropertyGroup> | ||
| <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x64' "> | ||
| <DebugType>pdbonly</DebugType> | ||
| <Optimize>true</Optimize> | ||
| <OutputPath>bin\Release\</OutputPath> | ||
| <DefineConstants>TRACE</DefineConstants> | ||
| <ErrorReport>prompt</ErrorReport> | ||
| <WarningLevel>4</WarningLevel> | ||
| <TreatWarningsAsErrors>true</TreatWarningsAsErrors> | ||
| <DocumentationFile>bin/Release/commonDocumentation.xml</DocumentationFile> | ||
| <PlatformTarget>x64</PlatformTarget> | ||
| </PropertyGroup> | ||
| <ItemGroup> | ||
| <Reference Include="System" /> | ||
| <Reference Include="System.Core" /> | ||
| <Reference Include="System.Xml.Linq" /> | ||
| <Reference Include="System.Data.DataSetExtensions" /> | ||
| <Reference Include="Microsoft.CSharp" /> | ||
| <Reference Include="System.Data" /> | ||
| <Reference Include="System.Net.Http" /> | ||
| <Reference Include="System.Xml" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <Compile Include="HTMLParsingExtension.cs" /> | ||
| <Compile Include="Properties\AssemblyInfo.cs" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <PackageReference Include="Markdig.Signed"> | ||
| <Version>0.18.0</Version> | ||
| </PackageReference> | ||
| <PackageReference Include="StyleCop.Analyzers"> | ||
| <Version>1.1.118</Version> | ||
| <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets> | ||
| <PrivateAssets>all</PrivateAssets> | ||
| </PackageReference> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <AdditionalFiles Include="..\..\..\codeAnalysis\StyleCop.json"> | ||
| <Link>StyleCop.json</Link> | ||
| </AdditionalFiles> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <ProjectReference Include="..\common\Common.csproj"> | ||
| <Project>{af2349b8-e5b6-4004-9502-687c1c7730b1}</Project> | ||
| <Name>Common</Name> | ||
| </ProjectReference> | ||
| </ItemGroup> | ||
| <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" /> | ||
| </Project> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| // Copyright (c) Microsoft Corporation | ||
| // The Microsoft Corporation licenses this file to you under the MIT license. | ||
| // See the LICENSE file in the project root for more information. | ||
|
|
||
| using System.Reflection; | ||
| using System.Runtime.CompilerServices; | ||
| using System.Runtime.InteropServices; | ||
|
|
||
| // General Information about an assembly is controlled through the following | ||
| // set of attributes. Change these attribute values to modify the information | ||
| // associated with an assembly. | ||
| [assembly: AssemblyTitle("MarkDownPreviewHandler")] | ||
| [assembly: AssemblyDescription("")] | ||
| [assembly: AssemblyConfiguration("")] | ||
| [assembly: AssemblyCompany("")] | ||
| [assembly: AssemblyProduct("MarkDownPreviewHandler")] | ||
| [assembly: AssemblyCopyright("Copyright © 2020")] | ||
| [assembly: AssemblyTrademark("")] | ||
| [assembly: AssemblyCulture("")] | ||
|
|
||
| // Make assembly visible to UnitTest Project | ||
| [assembly: InternalsVisibleTo("PreviewPaneUnitTests")] | ||
|
|
||
| // Setting ComVisible to false makes the types in this assembly not visible | ||
| // to COM components. If you need to access a type in this assembly from | ||
| // COM, set the ComVisible attribute to true on that type. | ||
| [assembly: ComVisible(false)] | ||
|
|
||
| // The following GUID is for the ID of the typelib if this project is exposed to COM | ||
| [assembly: Guid("6a71162e-fc4c-4a2c-b90f-3cf94f59a9bb")] | ||
|
|
||
| // Version information for an assembly consists of the following four values: | ||
| // | ||
| // Major Version | ||
| // Minor Version | ||
| // Build Number | ||
| // Revision | ||
| // | ||
| // You can specify all the values or you can default the Build and Revision Numbers | ||
| // by using the '*' as shown below: | ||
| // [assembly: AssemblyVersion("1.0.*")] | ||
| [assembly: AssemblyVersion("1.0.0.0")] | ||
| [assembly: AssemblyFileVersion("1.0.0.0")] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| using System; | ||
| using Markdig; | ||
| using MarkDownPreviewHandler; | ||
| using Microsoft.VisualStudio.TestTools.UnitTesting; | ||
|
|
||
| namespace PreviewPaneUnitTests | ||
| { | ||
| [TestClass] | ||
| public class MarkDownPreviewHandlerHTMLParsingExtensionTest | ||
| { | ||
| public MarkdownPipeline TestBase(IMarkdownExtension extension) | ||
|
There was a problem hiding this comment. Should this be private? Also another 'nit' comment, but the method name doesn't really seem to describe what it does. Maybe something like BuidPipelineWithExtention or just BuildPipeline as the 'with extension' is implied by the signature. |
||
| { | ||
| MarkdownPipelineBuilder pipelineBuilder = new MarkdownPipelineBuilder().UseAdvancedExtensions(); | ||
| pipelineBuilder.Extensions.Add(extension); | ||
| return pipelineBuilder.Build(); | ||
| } | ||
|
|
||
| [TestMethod] | ||
| public void Extension_UpdatesTablesClass_WhenUsed() | ||
| { | ||
| // Arrange | ||
| String mdString = "| A | B |\n| -- | -- | "; | ||
| HTMLParsingExtension htmlParsingExtension = new HTMLParsingExtension(); | ||
| MarkdownPipeline markdownPipeline = TestBase(htmlParsingExtension); | ||
|
|
||
| // Act | ||
| String html = Markdown.ToHtml(mdString, markdownPipeline); | ||
|
|
||
| // Assert | ||
| Assert.AreEqual(html, "<table class=\"table table-striped table-bordered\">\n<thead>\n<tr>\n<th>A</th>\n<th>B</th>\n</tr>\n</thead>\n</table>\n"); | ||
| } | ||
|
|
||
|
|
||
| [TestMethod] | ||
| public void Extension_UpdatesBlockQuotesClass_WhenUsed() | ||
| { | ||
| // Arrange | ||
| String mdString = "> Blockquotes."; | ||
| HTMLParsingExtension htmlParsingExtension = new HTMLParsingExtension(); | ||
| MarkdownPipeline markdownPipeline = TestBase(htmlParsingExtension); | ||
|
|
||
| // Act | ||
| String html = Markdown.ToHtml(mdString, markdownPipeline); | ||
|
|
||
| // Assert | ||
| Assert.AreEqual(html, "<blockquote class=\"blockquote\">\n<p>Blockquotes.</p>\n</blockquote>\n"); | ||
| } | ||
|
|
||
| [TestMethod] | ||
| public void extension_updatesFigureClassAndRelativeUrltoAbsolute_whenused() | ||
|
There was a problem hiding this comment. nit: First word should be capatalized -- E, U W |
||
| { | ||
| // arrange | ||
| String mdString = "![text](a.jpg \"Figure\")"; | ||
| HTMLParsingExtension htmlParsingExtension = new HTMLParsingExtension("C:\\Users\\"); | ||
| MarkdownPipeline markdownPipeline = TestBase(htmlParsingExtension); | ||
|
|
||
| // Act | ||
| String html = Markdown.ToHtml(mdString, markdownPipeline); | ||
|
|
||
| // Assert | ||
| Assert.AreEqual(html, "<p><img src=\"file:///C:/Users/a.jpg\" class=\"img-fluid\" alt=\"text\" title=\"Figure\" /></p>\n"); | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| <?xml version="1.0" encoding="utf-8"?> | ||
| <Project ToolsVersion="15.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003"> | ||
| <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> | ||
| <ProjectGuid>{A2B51B8B-8F90-424E-BC97-F9AB7D76CA1A}</ProjectGuid> | ||
| <OutputType>Library</OutputType> | ||
| <AppDesignerFolder>Properties</AppDesignerFolder> | ||
| <RootNamespace>PreviewPaneUnitTests</RootNamespace> | ||
| <AssemblyName>PreviewPaneUnitTests</AssemblyName> | ||
| <TargetFrameworkVersion>v4.8</TargetFrameworkVersion> | ||
| <FileAlignment>512</FileAlignment> | ||
| <ProjectTypeGuids>{3AC096D0-A1C2-E12C-1390-A8335801FDAB};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}</ProjectTypeGuids> | ||
| <VisualStudioVersion Condition="'$(VisualStudioVersion)' == ''">15.0</VisualStudioVersion> | ||
| <VSToolsPath Condition="'$(VSToolsPath)' == ''">$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)</VSToolsPath> | ||
| <ReferencePath>$(ProgramFiles)\Common Files\microsoft shared\VSTT\$(VisualStudioVersion)\UITestExtensionPackages</ReferencePath> | ||
| <IsCodedUITest>False</IsCodedUITest> | ||
| <TestProjectType>UnitTest</TestProjectType> | ||
| <NuGetPackageImportStamp> | ||
| </NuGetPackageImportStamp> | ||
| </PropertyGroup> | ||
| <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x64' "> | ||
| <DebugSymbols>true</DebugSymbols> | ||
| <DebugType>full</DebugType> | ||
| <Optimize>false</Optimize> | ||
| <OutputPath>bin\Debug\</OutputPath> | ||
| <DefineConstants>DEBUG;TRACE</DefineConstants> | ||
| <ErrorReport>prompt</ErrorReport> | ||
| <WarningLevel>4</WarningLevel> | ||
| <PlatformTarget>x64</PlatformTarget> | ||
| </PropertyGroup> | ||
| <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x64' "> | ||
| <DebugType>pdbonly</DebugType> | ||
| <Optimize>true</Optimize> | ||
| <OutputPath>bin\Release\</OutputPath> | ||
| <DefineConstants>TRACE</DefineConstants> | ||
| <ErrorReport>prompt</ErrorReport> | ||
| <WarningLevel>4</WarningLevel> | ||
| <PlatformTarget>x64</PlatformTarget> | ||
| </PropertyGroup> | ||
| <ItemGroup> | ||
| <Reference Include="System" /> | ||
| <Reference Include="System.Core" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <Compile Include="MarkDownPreviewHandlerHTMLParsingExtensionTest.cs" /> | ||
| <Compile Include="Properties\AssemblyInfo.cs" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <PackageReference Include="Markdig.Signed"> | ||
| <Version>0.18.0</Version> | ||
| </PackageReference> | ||
| <PackageReference Include="MSTest.TestAdapter"> | ||
| <Version>1.3.2</Version> | ||
| </PackageReference> | ||
| <PackageReference Include="MSTest.TestFramework"> | ||
| <Version>1.3.2</Version> | ||
| </PackageReference> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <ProjectReference Include="..\MarkDownPreviewHandler\MarkDownPreviewHandler.csproj"> | ||
| <Project>{6a71162e-fc4c-4a2c-b90f-3cf94f59a9bb}</Project> | ||
| <Name>MarkDownPreviewHandler</Name> | ||
| </ProjectReference> | ||
| </ItemGroup> | ||
| <Import Project="$(VSToolsPath)\TeamTest\Microsoft.TestTools.targets" Condition="Exists('$(VSToolsPath)\TeamTest\Microsoft.TestTools.targets')" /> | ||
| <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" /> | ||
| </Project> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this version of 'Setup' initialize the delegate as well?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Setup(MarkdownPipeline pipeline, IMarkdownRenderer renderer)is called from inside renderers. But we are not using any renderer in this parsing context. The first setup function is called while building pipelineThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this actually called, but from our perspective is a 'no-op', or is it not called. If it's the former, you might want to add a comment about why we are implementing this interface, but don't have to provide an implementation for this override of 'Setup'. If it's the latter you might want to throw a NotImplemented exception, so that it is will explicitly fail if the call patterns of markdig change.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is first case i.e It is called but from our perspective is a 'no-op' because it is independent of renderer context.