Migrate documentation to Docusaurus (#56)

Author: josefpihrt

.editorconfig

@@ -5,6 +5,11 @@ root = true
 
 # Code files
 [*.{cs,csx}]
+
+dotnet_sort_system_directives_first = true
+
+csharp_style_namespace_declarations = file_scoped:suggestion
+
 roslynator_accessibility_modifiers = explicit
 roslynator_accessor_braces_style = single_line_when_expression_is_on_single_line
 roslynator_array_creation_type_style = implicit_when_type_is_obvious
@@ -35,6 +40,8 @@ roslynator_use_var_instead_of_implicit_object_creation = true
 roslynator_infinite_loop_style = while
 roslynator_doc_comment_summary_style = multi_line
 roslynator_enum_flag_value_style = shift_operator
+roslynator_blank_line_after_file_scoped_namespace_declaration = true
+roslynator_null_check_style = pattern_matching
 
 dotnet_diagnostic.RCS0001.severity = suggestion
 dotnet_diagnostic.RCS0003.severity = suggestion
@@ -63,7 +70,6 @@ dotnet_diagnostic.RCS0039.severity = suggestion
 dotnet_diagnostic.RCS0041.severity = suggestion
 dotnet_diagnostic.RCS0042.severity = suggestion
 dotnet_diagnostic.RCS0043.severity = suggestion
-dotnet_diagnostic.RCS0044.severity = suggestion
 dotnet_diagnostic.RCS0046.severity = suggestion
 dotnet_diagnostic.RCS0048.severity = silent
 dotnet_diagnostic.RCS0049.severity = suggestion
@@ -75,6 +81,7 @@ dotnet_diagnostic.RCS0055.severity = suggestion
 dotnet_diagnostic.RCS0057.severity = suggestion
 dotnet_diagnostic.RCS0058.severity = suggestion
 dotnet_diagnostic.RCS0059.severity = suggestion
+dotnet_diagnostic.RCS0060.severity = suggestion
 dotnet_diagnostic.RCS1002.severity = silent
 dotnet_diagnostic.RCS1006.severity = suggestion
 dotnet_diagnostic.RCS1008.severity = suggestion
@@ -112,7 +119,6 @@ dotnet_diagnostic.RCS1083.severity = suggestion
 dotnet_diagnostic.RCS1090.severity = suggestion
 dotnet_diagnostic.RCS1091.severity = suggestion
 dotnet_diagnostic.RCS1096.severity = warning
-dotnet_diagnostic.RCS1111.severity = suggestion
 dotnet_diagnostic.RCS1124.severity = suggestion
 dotnet_diagnostic.RCS1126.severity = warning
 dotnet_diagnostic.RCS1129.severity = suggestion
@@ -130,10 +136,12 @@ dotnet_diagnostic.RCS1189.severity = suggestion
 dotnet_diagnostic.RCS1207.severity = suggestion
 dotnet_diagnostic.RCS1237.severity = none
 dotnet_diagnostic.RCS1244.severity = suggestion
+dotnet_diagnostic.RCS1248.severity = suggestion
 dotnet_diagnostic.RCS1250.severity = suggestion
 dotnet_diagnostic.RCS1252.severity = suggestion
 dotnet_diagnostic.RCS1253.severity = suggestion
 dotnet_diagnostic.RCS1254.severity = suggestion
+dotnet_diagnostic.RCS1255.severity = none
 
 dotnet_diagnostic.IDE0007.severity = none
 dotnet_diagnostic.IDE0007WithoutSuggestion.severity = none
@@ -180,83 +188,10 @@ dotnet_diagnostic.IDE0074.severity = none
 dotnet_diagnostic.IDE0074WithoutSuggestion.severity = none
 dotnet_diagnostic.IDE0079.severity = none
 dotnet_diagnostic.IDE0090.severity = none
+dotnet_diagnostic.IDE0220.severity = none
 dotnet_diagnostic.IDE1005.severity = suggestion
 dotnet_diagnostic.IDE1006.severity = suggestion
 
 dotnet_diagnostic.RS1024.severity = none # Compare symbols correctly
 dotnet_diagnostic.RS1025.severity = none
 dotnet_diagnostic.RS1026.severity = none
-
-[*.{cs,vb}]
-#### Naming styles ####
-
-# Naming rules
-
-dotnet_naming_rule.interface_should_be_begins_with_i.severity = suggestion
-dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface
-dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i
-
-dotnet_naming_rule.types_should_be_pascal_case.severity = suggestion
-dotnet_naming_rule.types_should_be_pascal_case.symbols = types
-dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case
-
-dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = suggestion
-dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members
-dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case
-
-# Symbol specifications
-
-dotnet_naming_symbols.interface.applicable_kinds = interface
-dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
-dotnet_naming_symbols.interface.required_modifiers = 
-
-dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum
-dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
-dotnet_naming_symbols.types.required_modifiers = 
-
-dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method
-dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
-dotnet_naming_symbols.non_field_members.required_modifiers = 
-
-# Naming styles
-
-dotnet_naming_style.begins_with_i.required_prefix = I
-dotnet_naming_style.begins_with_i.required_suffix = 
-dotnet_naming_style.begins_with_i.word_separator = 
-dotnet_naming_style.begins_with_i.capitalization = pascal_case
-
-dotnet_naming_style.pascal_case.required_prefix = 
-dotnet_naming_style.pascal_case.required_suffix = 
-dotnet_naming_style.pascal_case.word_separator = 
-dotnet_naming_style.pascal_case.capitalization = pascal_case
-
-dotnet_naming_style.pascal_case.required_prefix = 
-dotnet_naming_style.pascal_case.required_suffix = 
-dotnet_naming_style.pascal_case.word_separator = 
-dotnet_naming_style.pascal_case.capitalization = pascal_case
-dotnet_style_coalesce_expression = true:suggestion
-dotnet_style_null_propagation = true:suggestion
-dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
-dotnet_style_prefer_auto_properties = true:silent
-dotnet_style_object_initializer = true:suggestion
-dotnet_style_operator_placement_when_wrapping = beginning_of_line
-tab_width = 4
-indent_size = 4
-end_of_line = crlf
-dotnet_style_collection_initializer = true:suggestion
-
-[*.cs]
-csharp_using_directive_placement = outside_namespace:silent
-csharp_prefer_simple_using_statement = true:suggestion
-csharp_prefer_braces = true:silent
-csharp_style_namespace_declarations = block_scoped:silent
-csharp_style_prefer_method_group_conversion = true:silent
-csharp_style_expression_bodied_methods = false:silent
-csharp_style_expression_bodied_constructors = false:silent
-csharp_style_expression_bodied_operators = false:silent
-csharp_style_expression_bodied_properties = true:silent
-csharp_style_expression_bodied_indexers = true:silent
-csharp_style_expression_bodied_accessors = true:silent
-csharp_style_expression_bodied_lambdas = true:silent
-csharp_style_expression_bodied_local_functions = false:silent
-csharp_indent_labels = one_less_than_current

.github/workflows/build.yml

@@ -0,0 +1,166 @@
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - v*
+  pull_request:
+
+env:
+  Configuration: Release
+  TreatWarningsAsErrors: true
+  WarningsNotAsErrors: 1591,NU5128
+  Deterministic: true
+  RunCodeAnalysis: false
+
+jobs:
+  pre_build:
+    runs-on: ubuntu-20.04
+    outputs:
+      version: ${{ steps.version.outputs.version }}
+      version3: ${{ steps.version.outputs.version3 }}
+    defaults:
+      run:
+        working-directory: src
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - run: dotnet tool install -g GitVersion.Tool --version 5.10.0
+      - name: Resolve version
+        id: version
+        run: |
+          dotnet-gitversion > version.json
+          version="$(jq -r '.SemVer' version.json)"
+          version3="$(jq -r '.MajorMinorPatch' version.json)"
+          pr_version="$(jq -r '.MajorMinorPatch' version.json)-$(jq -r '.PreReleaseLabel' version.json).${{ github.run_number }}.${{ github.run_attempt }}"
+          if [ "${{ github.event_name }}" = "pull_request" ]; then version=$pr_version; fi
+          echo "Resolved version: $version"
+          echo "version=${version}" >> $GITHUB_OUTPUT
+          echo "Resolved version3: $version3"
+          echo "version3=${version3}" >> $GITHUB_OUTPUT
+
+  build_vs_extension:
+    needs: pre_build
+    runs-on: windows-latest
+    env:
+      Version: ${{ needs.pre_build.outputs.version }}
+      DeployExtension: false
+    defaults:
+      run:
+        working-directory: src
+    steps:
+      - uses: actions/checkout@v3
+      - run: (Get-Content source.extension.vsixmanifest) -replace 'Version="1.0.0"', 'Version="${{ needs.pre_build.outputs.version3 }}"' | Set-Content source.extension.vsixmanifest
+        working-directory: src/Snippetica.VisualStudio
+      - run: dotnet restore Tools/DocumentationGenerator/DocumentationGenerator.csproj
+      - run: dotnet build Tools/DocumentationGenerator/DocumentationGenerator.csproj --no-restore
+      - run: |
+          cd tools
+          ./generate_snippets.ps1
+        name: "Generate snippets"
+        working-directory: "."
+      - run: dotnet restore
+      - uses: microsoft/[email protected]
+      - run: msbuild -m
+      - uses: actions/upload-artifact@v3
+        name: "Upload vsix file"
+        with:
+          name: vs_extension
+          path: src/Snippetica.VisualStudio/bin/Release/*.vsix
+      - uses: actions/upload-artifact@v3
+        name: "Upload manifest file"
+        with:
+          name: vs_extension
+          path: src/Snippetica.VisualStudio/manifest.json
+      - uses: actions/upload-artifact@v3
+        name: "Upload Visual Studio snippets"
+        with:
+          name: vs_snippets
+          path: src/Snippetica.VisualStudio/**/*.snippet
+
+  build_vs_code_extensions:
+    needs: pre_build
+    runs-on: ubuntu-20.04
+    env:
+      Version: ${{ needs.pre_build.outputs.version }}
+      DefineConstants: VSCODE
+    strategy:
+      matrix:
+        component:
+          - name: cpp
+            directoryName: Snippetica.Cpp
+          - name: cs
+            directoryName: Snippetica.CSharp
+          - name: html
+            directoryName: Snippetica.Html
+          - name: json
+            directoryName: Snippetica.Json
+          - name: markdown
+            directoryName: Snippetica.Markdown
+          - name: vb
+            directoryName: Snippetica.VisualBasic
+          - name: xml
+            directoryName: Snippetica.Xml
+    defaults:
+      run:
+        working-directory: src/Snippetica.VisualStudioCode/${{ matrix.component.directoryName }}/package
+    steps:
+      - uses: actions/checkout@v3
+      - run: dotnet restore
+        working-directory: src/Tools/SnippetGenerator
+      - run: dotnet build --no-restore
+        working-directory: src/Tools/SnippetGenerator
+      - run: |
+          cd tools
+          ./generate_snippets.ps1
+        working-directory: "."
+        shell: pwsh
+        name: "Generate snippets"
+      - run: >
+          sed -i 's/"version": "1.0.0"/"version": "${{ needs.pre_build.outputs.version3 }}"/' "package.json"
+      - run: npm install -g @vscode/vsce
+      - run: vsce package
+      - uses: actions/upload-artifact@v3
+        with:
+          name: "vs_code_extension_${{ matrix.component.name }}"
+          path: "src/Snippetica.VisualStudioCode/${{ matrix.component.directoryName }}/package/*.vsix"
+
+  publish_vs_extension:
+    needs: build_vs_extension
+    runs-on: windows-latest
+    if: github.ref_type == 'tag' && startsWith(github.ref_name, 'v')
+    steps:
+      - uses: actions/download-artifact@v3
+        with:
+          name: vs_extension
+          path: vs_extension
+      - run: |
+          $visualStudioPath = vswhere -latest -products * -requires Microsoft.VisualStudio.Component.VSSDK -property installationPath
+          $vsixPublisher = Join-Path "$visualStudioPath" "VSSDK\VisualStudioIntegration\Tools\Bin\VsixPublisher.exe"
+          & "$vsixPublisher" publish -payload Snippetica.VisualStudio.vsix -publishManifest manifest.json -personalAccessToken ${{ secrets.VS_MARKETPLACE_TOKEN }}
+        working-directory: vs_extension
+        name: Publish VS extension to Marketplace
+
+  publish_vs_code_extension:
+    needs: build_vs_code_extensions
+    runs-on: ubuntu-20.04
+    if: github.ref_type == 'tag' && startsWith(github.ref_name, 'v')
+    strategy:
+      matrix:
+        component:
+          - name: cpp
+          - name: cs
+          - name: html
+          - name: json
+          - name: markdown
+          - name: vb
+          - name: xml
+    steps:
+      - uses: actions/download-artifact@v3
+        with:
+          name: vs_code_extension_${{ matrix.component.name }}
+          path: vs_code_extension
+      - run: npm install -g @vscode/vsce
+      - run: vsce publish -p ${{ secrets.VS_MARKETPLACE_TOKEN }}
+        working-directory: vs_code_extension

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "dotnet.defaultSolution": "src/Snippetica.sln"
+}

ChangeLog.md

@@ -10,6 +10,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 - Add snippet for 'while not' (`wx`) ([#54](https://github.com/josefpihrt/roslynator/pull/54)).
 
+### Changed
+
+- Migrate documentation to [Docusaurus](https://josefpihrt.github.io/docs/snippetica) ([#56](https://github.com/josefpihrt/roslynator/pull/56)).
+
 ## [1.0.0] - 2022-10-17
 
 ### Added

README.md

@@ -1,40 +1,32 @@
 # Snippetica
 
-* A collection of snippets for C\#, C\+\+, HTML, JSON, Markdown, VB, XAML and XML\.
-* [Release Notes](http://github.com/josefpihrt/snippetica/blob/main/ChangeLog.md)\.
+A collection of snippets for C\#, C\+\+, HTML, VB and other languages\.
 
-## Snippetica for Visual Studio
+## Snippets for Visual Studio
 
-* Browse all available snippets with [Snippet Browser](http://pihrt.net/snippetica/snippets?engine=vs)\.
-* Download extension from [Marketplace](http://marketplace.visualstudio.com/search?term=publisher%3A"Josef%20Pihrt"%20Snippetica&target=vs&sortBy=Name)\.
+### Installation
 
-### Snippets
+Install extension from [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=josefpihrt.Snippetica)\.
 
-Group|Count| |
------|-----|---:
-[Snippetica.Cpp](http://github.com/josefpihrt/snippetica/blob/main/src/Snippetica.VisualStudio/Snippetica.Cpp/README.md)|121|[Browse](http://pihrt.net/snippetica/snippets?engine=vs&language=cpp)
-[Snippetica.CSharp](http://github.com/josefpihrt/snippetica/blob/main/src/Snippetica.VisualStudio/Snippetica.CSharp/README.md)|581|[Browse](http://pihrt.net/snippetica/snippets?engine=vs&language=csharp)
-[Snippetica.Html](http://github.com/josefpihrt/snippetica/blob/main/src/Snippetica.VisualStudio/Snippetica.Html/README.md)|221|[Browse](http://pihrt.net/snippetica/snippets?engine=vs&language=html)
-[Snippetica.VisualBasic](http://github.com/josefpihrt/snippetica/blob/main/src/Snippetica.VisualStudio/Snippetica.VisualBasic/README.md)|517|[Browse](http://pihrt.net/snippetica/snippets?engine=vs&language=vb)
-[Snippetica.Xaml](http://github.com/josefpihrt/snippetica/blob/main/src/Snippetica.VisualStudio/Snippetica.Xaml/README.md)|91|[Browse](http://pihrt.net/snippetica/snippets?engine=vs&language=xaml)
-[Snippetica.Xml](http://github.com/josefpihrt/snippetica/blob/main/src/Snippetica.VisualStudio/Snippetica.Xml/README.md)|9|[Browse](http://pihrt.net/snippetica/snippets?engine=vs&language=xml)
-[Snippetica.Xml.CodeSnippet](http://github.com/josefpihrt/snippetica/blob/main/src/Snippetica.VisualStudio/Snippetica.Xml.CodeSnippet/README.md)|22|[Browse](http://pihrt.net/snippetica/snippets?engine=vs&language=xml)
+### Languages
 
-## Snippetica for Visual Studio Code
+- [C#](https://josefpihrt.github.io/docs/snippetica/vs/csharp)
+- [Visual Basic](https://josefpihrt.github.io/docs/snippetica/vs/vb)
+- [C++](https://josefpihrt.github.io/docs/snippetica/vs/cpp)
+- [HTML](https://josefpihrt.github.io/docs/snippetica/vs/html)
+- [XAML](https://josefpihrt.github.io/docs/snippetica/vs/xaml)
+- [XML](https://josefpihrt.github.io/docs/snippetica/vs/xml)
 
-* Browse all available snippets with [Snippet Browser](http://pihrt.net/snippetica/snippets?engine=vscode)\.
-* Download extension from [Marketplace](http://marketplace.visualstudio.com/search?term=publisher%3A"Josef%20Pihrt"%20Snippetica&target=vscode&sortBy=Name)\.
+## Snippets for VS Code
 
-### Snippets
+### Installation
 
-Group|Count| |
------|-----|---:
-[Snippetica.Cpp](http://github.com/josefpihrt/snippetica/blob/main/src/Snippetica.VisualStudio/Snippetica.Cpp/README.md)|121|[Browse](http://pihrt.net/snippetica/snippets?engine=vscode&language=cpp)
-[Snippetica.CSharp](http://github.com/josefpihrt/snippetica/blob/main/src/Snippetica.VisualStudio/Snippetica.CSharp/README.md)|227|[Browse](http://pihrt.net/snippetica/snippets?engine=vscode&language=csharp)
-[Snippetica.Html](http://github.com/josefpihrt/snippetica/blob/main/src/Snippetica.VisualStudio/Snippetica.Html/README.md)|221|[Browse](http://pihrt.net/snippetica/snippets?engine=vscode&language=html)
-[Snippetica.Json](http://github.com/josefpihrt/snippetica/blob/main/src/Snippetica.VisualStudio/Snippetica.Json/README.md)|18|[Browse](http://pihrt.net/snippetica/snippets?engine=vscode&language=json)
-[Snippetica.Markdown](http://github.com/josefpihrt/snippetica/blob/main/src/Snippetica.VisualStudio/Snippetica.Markdown/README.md)|47|[Browse](http://pihrt.net/snippetica/snippets?engine=vscode&language=markdown)
-[Snippetica.VisualBasic](http://github.com/josefpihrt/snippetica/blob/main/src/Snippetica.VisualStudio/Snippetica.VisualBasic/README.md)|178|[Browse](http://pihrt.net/snippetica/snippets?engine=vscode&language=vb)
-[Snippetica.Xml](http://github.com/josefpihrt/snippetica/blob/main/src/Snippetica.VisualStudio/Snippetica.Xml/README.md)|9|[Browse](http://pihrt.net/snippetica/snippets?engine=vscode&language=xml)
+Install extension from [VS Code Marketplace](https://marketplace.visualstudio.com/search?term=snippetica&target=VSCode&category=All%20categories&sortBy=Relevance)\.
 
-*\(Generated with [DotMarkdown](http://github.com/JosefPihrt/DotMarkdown)\)*
+### Languages
+
+- [C#](https://josefpihrt.github.io/docs/snippetica/vscode/csharp)
+- [Visual Basic](https://josefpihrt.github.io/docs/snippetica/vscode/vb)
+- [C++](https://josefpihrt.github.io/docs/snippetica/vscode/cpp)
+- [HTML](https://josefpihrt.github.io/docs/snippetica/vscode/html)
+- [XML](https://josefpihrt.github.io/docs/snippetica/vscode/xml)

docs/README.md

@@ -0,0 +1 @@
+# https://josefpihrt.github.io/docs/snippetica

src/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "dotnet.defaultSolution": "Snippetica.sln"
+}