Adding spellchecker at pre-commit (#90)

Co-authored-by: Limor Lahiani <limorl@zhenghao5.redmond.corp.microsoft.com>

.github/ISSUE_TEMPLATE/user_story.md

@@ -13,7 +13,7 @@ As a ...
 I want to ...
 So that ...
 
-## Acceptance critiera
+## Acceptance criteria
 
 - [ ] Criteria 1
 - [ ] Criteria 2

.gitignore

@@ -171,3 +171,6 @@ terraform.rc
 
 # vscode
 .vscode/
+
+# node
+node_modules

.pre-commit-config.yaml

@@ -3,3 +3,7 @@ repos:
       rev: v1.2.3
       hooks:
       - id: flake8
+  -   repo: https://github.com/hcodes/yaspeller
+      rev: v7.0.0
+      hooks:
+      -   id: yaspeller

.yaspellerrc.json

@@ -0,0 +1,68 @@
+{
+    "excludeFiles": [
+        ".yaspeller*",
+        "**/*devcontainer*",
+        ".git",
+        ".gitignore",
+        "node_modules",
+        "LICENSE",
+        "**/.dockerignore",
+        "**/Dockerfile",
+        "**/*.tf*",
+        "**/*.terraform*",
+        "**/requirements.txt",
+        "**/*.py",
+        "**/*.yml",
+        "**/*.yaml"
+    ],
+    "fileExtensions": [
+        ".md"
+    ],
+    "lang": "en",
+    "ignoreTags": ["code", "script"],
+    "ignoreUrls": true,
+    "ignoreUppercase": true,
+    "ignoreDigits": true,
+    "dictionary": [
+        "api",
+        "AspNet",
+        "az",
+        "AzureTRE",
+        "Codespaces",
+        "Conda",
+        "dataset",
+        "datasets",
+        "dev",
+        "Dev",
+        "DevOps",
+        "DotNet",
+        "exfiltration",
+        "Endpoints",
+        "GitHub",
+        "lifecycle",
+        "maintainer",
+        "maintainers",
+        "PowerShell",
+        "PyPi",
+        "QuickStart",
+        "repo",
+        "repos",
+        "screenshots",
+        "terraform",
+        "Terraform",
+        "tfvars",
+        "tmpl",
+        "TREs",
+        "Xamarin"
+    ],
+    "ignoreText": [
+        // Code sections (anything between ``` and ``` or ` and `)
+        "`{1,3}([^`]{1,3})*`{1,3}",
+
+        // Markdown file paths
+        "(\\(|\\[)([\/]|[.\/])?([\\w\\.\\s]*\/)*[\\w\\s\\.]*(\\)|\\])",
+
+        // Email addresses (http://emailregex.com/)
+        "(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9])|[a-z0-9-]*[a-z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])"
+    ] 
+}

SECURITY.md

@@ -12,7 +12,7 @@ Instead, please report them to the Microsoft Security Response Center (MSRC) at
 
 If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com).  If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc).
 
-You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).
+You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [Microsoft Security Response Center](https://www.microsoft.com/msrc).
 
 Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
 

core/README.md

@@ -64,4 +64,4 @@ This will start the API on [http://127.0.0.1:8000](http://127.0.0.1:8000) and yo
 - Login to Azure with your credentials `az login`
 - Create a resource group that you want to automatically deploy the solution to `az group create -g MyResourceGroup -l westeurope`
 - Create a service credential to run the pipeline with `az ad sp create-for-rbac --name MySPNName --role Contributor --scope /subscriptions/{MySubscriptionId}/resourceGroups/{MyResourceGroup} --sdk-auth`
-- In your repository, use Add secret to create a new secret named AZURE_CREDENTIALS and paste the entire JSON object produced by the az ad sp create-for-rbac command as the secret value and save the secret.
+- In your repository, use Add secret to create a new secret named AZURE_CREDENTIALS and paste the entire JSON object produced by the `az ad sp create-for-rbac` command as the secret value and save the secret.

docs/quickstart.md

@@ -6,13 +6,13 @@ The AzureTRE uses Terraform infrastructure as code templates that pull down Dock
 The most straightforward way to get up and running is to deploy direct from the `microsoft/AzureTRE` repository. Production deployments should take advantage of your chosen DevOps CD tooling.
 
 ### Clone the repository
-Clone the repository to your local machine ( `git clone https://github.com/microsoft/AzureTRE.git` ) or you may choose to use our preconfigured dev container via GitHub Codespaces.
+Clone the repository to your local machine ( `git clone https://github.com/microsoft/AzureTRE.git` ) or you may choose to use our pre-configured dev container via GitHub Codespaces.
 
 ![Clone Options](../docs/assets/clone_options.png)
 
 ### Pre-requisites
 
-You will require the following pre requisites installed. They will already be present if using GitHub CodeSpaces, or use our Dev Container in VSCode.
+You will require the following pre requisites installed. They will already be present if using GitHub Codespaces, or use our Dev Container in VS Code.
 - Terraform >= v0.15.3. The following instructions use local terraform state, you may want to consider [storing you state remotely in Azure](https://docs.microsoft.com/en-us/azure/developer/terraform/store-state-in-azure-storage)
 - Azure CLI >= 2.21.0
 
@@ -26,7 +26,7 @@ In order to run this Terraform configuration you need to set the environment var
 
 Make a copy of the `.terraform.tfvars.tmpl` file, rename it using the format `<environment>.tfvars`. We will use `dev.tfvars`.
 
-Edit the terraform.tfvars as required. As `resource_name_prefix` and `environment` are used in Azure resource names they must be alpha numberic `(a-z,0-9)`. The defaults are as follows:
+Edit the terraform.tfvars as required. As `resource_name_prefix` and `environment` are used in Azure resource names they must be alpha numeric `(a-z,0-9)`. The defaults are as follows:
 
 ```hcl
 resource_name_prefix     = "tre"
@@ -49,7 +49,7 @@ See [https://docs.microsoft.com/en-us/azure/developer/terraform/get-started-clou
 
 ### Initialise Terraform and deploy
 
-To initalise terraform, from the root of the repository run:
+To initialise terraform, from the root of the repository run:
 
 ```cmd
 cd templates/core/terraform

docs/user-roles.md

@@ -26,7 +26,7 @@ Provisions the Azure TRE solution in an Azure subscription and performs tasks th
 Example tasks:
 
 - Provision Azure TRE solution instances.
-- 2nd line support for TRE administrators, TRE workspace owners and Researchers when Azure TRE troubleshooting is required.
+- Second line support for TRE administrators, TRE workspace owners and Researchers when Azure TRE troubleshooting is required.
 - Work with the data engineer to connect the Azure TRE with the data platform.
 - Troubleshoot provisioning issues and failed deployments.
 - Manage TRE administrator users.