From c79d1d37faf059b67f89a057975d6894afffe7a6 Mon Sep 17 00:00:00 2001
From: Domenic Barbuzzi <domenic@neuralmagic.com>
Date: Wed, 24 Jul 2024 18:22:38 +0000
Subject: [PATCH] Add spellcheck workflow and config

---
 .github/config/custom-wordlist.txt | 11 +++++++++++
 .github/config/spellcheck.yml      | 17 +++++++++++++++++
 .github/workflows/spellcheck.yaml  | 22 ++++++++++++++++++++++
 .gitignore                         |  1 +
 4 files changed, 51 insertions(+)
 create mode 100644 .github/config/custom-wordlist.txt
 create mode 100644 .github/config/spellcheck.yml
 create mode 100644 .github/workflows/spellcheck.yaml
 create mode 100644 .gitignore

diff --git a/.github/config/custom-wordlist.txt b/.github/config/custom-wordlist.txt
new file mode 100644
index 0000000..438ff33
--- /dev/null
+++ b/.github/config/custom-wordlist.txt
@@ -0,0 +1,11 @@
+CUDA
+neuralmagic
+Neuralmagic
+Neuralmagic's
+nm
+OpenAI
+pre
+premade
+PyPI
+vllm
+vLLM
diff --git a/.github/config/spellcheck.yml b/.github/config/spellcheck.yml
new file mode 100644
index 0000000..d773143
--- /dev/null
+++ b/.github/config/spellcheck.yml
@@ -0,0 +1,17 @@
+matrix:
+- name: Markdown
+  pipeline:
+  - pyspelling.filters.html:
+      comments: false
+      ignores:
+      - code
+      - pre
+  aspell:
+    lang: en
+    d: en_US
+    mode: markdown
+  dictionary:
+    wordlists:
+    - .github/config/custom-wordlist.txt
+  sources:
+  - '**/*.md'
diff --git a/.github/workflows/spellcheck.yaml b/.github/workflows/spellcheck.yaml
new file mode 100644
index 0000000..22d249d
--- /dev/null
+++ b/.github/workflows/spellcheck.yaml
@@ -0,0 +1,22 @@
+name: Spellcheck
+
+on: push
+
+jobs:
+
+  SPELLCHECK:
+    runs-on: ubuntu-latest
+    steps:
+
+      - uses: actions/checkout@v4
+
+      - name: Common misspellings check
+        uses: codespell-project/actions-codespell@v2
+
+      - name: Check spelling
+        uses: rojopolis/spellcheck-github-actions@v0
+        if: '!cancelled()'
+        with:
+          config_path: .github/config/spellcheck.yml
+          source_files: README.md
+          task_name: Markdown
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..5ceb386
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+venv