ci: Enable markdown linting and spell checking (#990)

Author: agneszitte

CODE_OF_CONDUCT.md

@@ -1,6 +1,6 @@
 # Code of Conduct
 
-This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. This code of conduct has been adopted by many other open source communities and we feel it expresses our values well. 
+This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. This code of conduct has been adopted by many other open source communities and we feel it expresses our values well.
 
 As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
 

LICENSE.md

@@ -1,4 +1,4 @@
-MIT License
+# MIT License
 
 Copyright (c) 2021 Uno Platform
 

README.md

@@ -1,16 +1,17 @@
+# Uno Toolkit
+
 <p align="center">
-  <img src="doc/assets/material-toolkit-design-system.png">
+  <img src="doc/assets/material-toolkit-design-system.png" alt="Material Toolkit Design System">
 </p>
 
-# Uno Toolkit
-
-[![Open Uno in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/unoplatform/uno.toolkit.ui) 
+[![Open Uno in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/unoplatform/uno.toolkit.ui)
 [![Azure DevOps](https://uno-platform.visualstudio.com/Uno%20Platform/_apis/build/status/Uno%20Platform/Uno.WindowsCommunityToolkit%20-%20CI?branchName=unorel%2F7.1)](https://uno-platform.visualstudio.com/Uno%20Platform/_build/latest?definitionId=14&branchName=unorel%2F7.1)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
 
 Uno Toolkit provides a set of higher-level UI Controls designed specifically for multi-platform, responsive applications.
 
 ## Packages
+
 Package|Stable|Preview
 -|-|-
 Uno.Toolkit.UI|[![NuGet stable](https://img.shields.io/nuget/v/Uno.Toolkit.UI?label=stable)](https://www.nuget.org/packages/Uno.Toolkit.UI)|[![NuGet preview](https://img.shields.io/nuget/vpre/Uno.Toolkit.UI?label=preview)](https://www.nuget.org/packages/Uno.Toolkit.UI)
@@ -21,34 +22,39 @@ Uno.Toolkit.WinUI.Material|[![NuGet stable](https://img.shields.io/nuget/v/Uno.T
 Uno.Toolkit.WinUI.Cupertino|[![NuGet stable](https://img.shields.io/nuget/v/Uno.Toolkit.WinUI.Cupertino?label=stable)](https://www.nuget.org/packages/Uno.Toolkit.WinUI.Cupertino)|[![NuGet preview](https://img.shields.io/nuget/vpre/Uno.Toolkit.WinUI.Cupertino?label=preview)](https://www.nuget.org/packages/Uno.Toolkit.WinUI.Cupertino)
 
 ## Getting Started
+
 See the complete [documentation](#documentation) for starting with this library.
 For a larger example and features demo, visit the [Uno Gallery](https://github.com/unoplatform/uno.gallery) repository.
 
 ## Documentation
+
 All documentation for `Uno.Toolkit.UI` can be found on our [website](https://platform.uno/docs/articles/external/uno.toolkit.ui/doc/getting-started.html).
 
 ## Contributing
-Please read our [contributing guide](https://github.com/unoplatform/uno/blob/master/CONTRIBUTING.md) to learn about our development process and how to propose bug fixes and improvements. 
+
+Please read our [contributing guide](https://github.com/unoplatform/uno/blob/master/CONTRIBUTING.md) to learn about our development process and how to propose bug fixes and improvements.
 Come visit us on our [Discord Channel #uno-platform](https://discord.gg/eBHZSKG) for help on how to contribute!
 
 Contribute to Uno in your browser using [GitPod.io](https://gitpod.io), follow [our guide here](https://platform.uno/docs/articles/features/working-with-gitpod.html).
 
 Be also mindful of our [Code of Conduct](CODE_OF_CONDUCT.md).
 
 ## Acknowledgments
+
 - [Uno Platform](https://platform.uno)
 - [Material Design 3](https://m3.material.io/)
 - [Material Design](https://material.io/design)
 - [Cupertino - Human Interface Guideline styling](https://developer.apple.com/design/human-interface-guidelines)
 - [WinUI](https://microsoft.github.io/microsoft-ui-xaml/)
 
 ## License
+
 This project is licensed under the Apache 2.0 license - see the [LICENSE](LICENSE) file for details.
 
 ## Contributors
+
 Thanks go to these wonderful people (List made with [contrib.rocks](https://contrib.rocks)):
 
 [![Uno.Toolkit.UI Contributors](https://contrib.rocks/image?repo=unoplatform/uno.toolkit.ui)](https://github.com/unoplatform/uno.toolkit.ui/graphs/contributors)
 
 💖 Thank you.
-

build/workflow/.markdownlint.json

@@ -0,0 +1,9 @@
+{
+	"default": true,
+	"line-length": false,
+	"commands-show-output": false,
+	"no-bare-urls": false,
+	"no-inline-html": false,
+	"no-duplicate-heading": false,
+	"no-emphasis-as-heading": false
+}

build/workflow/cspell.json

@@ -0,0 +1,204 @@
+{
+	"version": "0.2",
+	"language": "en",
+	"words": [
+		"Avalonia",
+		"ambiently",
+		"binlog",
+		"Blazor",
+		"blockquotes",
+		"Bootstrapper",
+		"brotli",
+		"browsersync",
+		"bytecode",
+		"Callout",
+		"chatops",
+		"codebases",
+		"Codespace",
+		"Codespaces",
+		"Contoso",
+		"Cupertino",
+		"customizability",
+		"databinding",
+		"datacontext",
+		"datagrid",
+		"devs",
+		"Dismissable",
+		"Docfx",
+		"ellipsize",
+		"Expando",
+		"flyouts",
+		"Framebuffer",
+		"Gamepad",
+		"gamepads",
+		"Geolocation",
+		"globbing",
+		"Gyrometer",
+		"Hanja",
+		"hectopascals",
+		"Inlines",
+		"interactable",
+		"keychain",
+		"laggy",
+		"layouter",
+		"layouting",
+		"Listview",
+		"LLRM",
+		"mergeable",
+		"MSAL",
+		"msbuild",
+		"MVUX",
+		"MVVM",
+		"NETSDK",
+		"netstandard",
+		"oidc",
+		"Omnisharp",
+		"overscroll",
+		"Packt",
+		"parameterless",
+		"pickable",
+		"Pluralsight",
+		"POSIX",
+		"reentrantly",
+		"Resizetizer",
+		"resw",
+		"roadmap",
+		"safearea",
+		"sandboxed",
+		"Segoe",
+		"Silverlight",
+		"Skia",
+		"skiasharp",
+		"Storyboarded",
+		"struct",
+		"Syncfusion",
+		"templatable",
+		"templating",
+		"timespan",
+		"Tizen",
+		"TLDR",
+		"toolkits",
+		"triaging",
+		"UI's",
+		"unmanaged",
+		"Uno's",
+		"unoplatform",
+		"UWP's",
+		"VSIX",
+		"walkthrough",
+		"WEBASSEMBLY",
+		"Haptics"
+	],
+	"ignoreWords": [
+		"ADAL",
+		"addin",
+		"AEHD",
+		"appsettings",
+		"Authenticode",
+		"automagically",
+		"Divio's",
+		"emcc",
+		"emscripten",
+		"Findlay",
+		"Flatpickr",
+		"Giesel",
+		"GNSS",
+		"GPIO",
+		"Grigorik",
+		"hdpi",
+		"Headered",
+		"Hoefling",
+		"HRESULT",
+		"Icaza",
+		"IDBFS",
+		"Ilya",
+		"Infragistics",
+		"jonathanpeppers's",
+		"Krueger",
+		"libgtk",
+		"Liu's",
+		"Logpoints",
+		"macios",
+		"Matteo",
+		"McCaffrey",
+		"mdpi",
+		"Mergify",
+		"mlaunch",
+		"muxc",
+		"netstd",
+		"nventive",
+		"odel",
+		"Onoh",
+		"pdate",
+		"Ronica",
+		"Serilog",
+		"Singh",
+		"slnf",
+		"Stetho",
+		"Talkin",
+		"UADO",
+		"Udemy",
+		"UNOB",
+		"unpackaged",
+		"winappsdk",
+		"winui",
+		"xhdpi",
+		"xxhdpi",
+		"xxxhdpi",
+		"Yowza"
+	],
+	"patterns": [
+		{
+			"name": "Markdown uid",
+			"pattern": "^(?=uid:).*$",
+			"description": ""
+		},
+		{
+			"name": "Markdown links",
+			"pattern": "\\((.*)\\)",
+			"description": ""
+		},
+		{
+			"name": "Markdown code blocks",
+			"pattern": "/^(\\s*`{3,}).*[\\s\\S]*?^\\1/gmx",
+			"description": "Taken from the cSpell example at https://cspell.org/configuration/patterns/#verbose-regular-expressions"
+		},
+		{
+			"name": "Inline code blocks",
+			"pattern": "\\`([^\\`\\r\\n]+?)\\`",
+			"description": "https://stackoverflow.com/questions/41274241/how-to-capture-inline-markdown-code-but-not-a-markdown-code-fence-with-regex"
+		},
+		{
+			"name": "Link contents",
+			"pattern": "\\<a(.*)\\>",
+			"description": ""
+		},
+		{
+			"name": "Snippet references",
+			"pattern": "-- snippet:(.*)",
+			"description": ""
+		},
+		{
+			"name": "Snippet references 2",
+			"pattern": "\\<\\[sample:(.*)",
+			"description": "another kind of snippet reference"
+		},
+		{
+			"name": "Multi-line code blocks",
+			"pattern": "/^\\s*```[\\s\\S]*?^\\s*```/gm"
+		}
+	],
+	"ignoreRegExpList": [
+		"Markdown uid",
+		"Markdown links",
+		"Markdown code blocks",
+		"Inline code blocks",
+		"Link contents",
+		"Snippet references",
+		"Snippet references 2",
+		"Multi-line code blocks"
+	],
+	"ignorePaths": [
+		"../doc/index.md"
+	]
+}

build/workflow/pipeline.yml

@@ -45,10 +45,22 @@ variables:
   IsCanaryBranch: $[startsWith(variables['Build.SourceBranch'], 'refs/heads/canaries/')]
   IsReleaseBranch: $[or(eq(variables['Build.SourceBranch'], 'refs/heads/main'), startsWith(variables['Build.SourceBranch'], 'refs/heads/feature/'), startsWith(variables['Build.SourceBranch'], 'refs/heads/release/'))]
 
-jobs:
-- template: stage-build-packages.yml
-- template: stage-uitests-wasm.yml
-- template: stage-build-ios.yml
-- template: stage-build-android.yml
-- template: stage-uitests-ios.yml
-- template: stage-uitests-android.yml
+stages:
+- stage: Validations
+  displayName: Validations
+  jobs:
+  - template: stage-validations.yml
+
+- stage: Packages
+  dependsOn: Validations
+  jobs:
+  - template: stage-build-packages.yml
+
+- stage: Tests
+  dependsOn: Validations
+  jobs:
+  - template: stage-uitests-wasm.yml
+  - template: stage-build-ios.yml
+  - template: stage-uitests-ios.yml
+  - template: stage-build-android.yml
+  - template: stage-uitests-android.yml

build/workflow/stage-validations.yml

@@ -0,0 +1,42 @@
+jobs:
+- job: spell_checking
+  displayName: 'Spell Checking Validation'
+
+  pool:
+    vmImage: 'ubuntu-latest'
+
+  steps:
+  - checkout: self
+    fetchDepth: 1
+    clean: true
+
+  - task: NodeTool@0
+    inputs:
+      versionSpec: '18.x'
+
+  - bash: npm install -g cspell
+    displayName: Install cSpell
+
+  - bash: cspell --config $(Build.SourcesDirectory)/build/workflow/cspell.json "**/*.md" --no-progress
+    displayName: Run Spell Checking
+
+- job: markdown_link
+  displayName: 'Markdown Validation'
+
+  pool:
+    vmImage: 'ubuntu-latest'
+
+  steps:
+  - checkout: self
+    fetchDepth: 1
+    clean: true
+
+  - task: NodeTool@0
+    inputs:
+      versionSpec: '18.x'
+
+  - bash: npm install -g markdownlint-cli
+    displayName: Install markdownlint-cli
+
+  - bash: markdownlint -c $(Build.SourcesDirectory)/build/workflow/.markdownlint.json "**/*.md"
+    displayName: Run Markdown Linter