diff --git a/.github/spellcheck-settings.yml b/.github/spellcheck-settings.yml new file mode 100644 index 00000000..b8ca6cca --- /dev/null +++ b/.github/spellcheck-settings.yml @@ -0,0 +1,29 @@ +matrix: +- name: Markdown + expect_match: false + apsell: + lang: en + d: en_US + ignore-case: true + dictionary: + wordlists: + - .github/wordlist.txt + output: wordlist.dic + pipeline: + - pyspelling.filters.markdown: + markdown_extensions: + - markdown.extensions.extra: + - pyspelling.filters.html: + comments: false + attributes: + - alt + ignores: + - ':matches(code, pre)' + - code + - pre + - blockquote + - img + sources: + - 'README.md' + - 'FAQ.md' + - 'docs/**' diff --git a/.github/wordlist.txt b/.github/wordlist.txt new file mode 100644 index 00000000..3045ae93 --- /dev/null +++ b/.github/wordlist.txt @@ -0,0 +1,54 @@ +ACLs +autoload +autoloader +autoloading +Autoloading +backend +backends +behaviour +CAS +ClickHouse +config +customizable +Customizable +dataset +de +ElastiCache +extensibility +FPM +Golang +IANA +keyspace +keyspaces +Kvrocks +localhost +Lua +MSSQL +namespace +NoSQL +ORM +Packagist +PhpRedis +pipelining +pluggable +Predis +PSR +Quickstart +README +rebalanced +rebalancing +redis +Redis +RocksDB +runtime +SHA +sharding +SSL +struct +stunnel +TCP +TLS +uri +URI +url +variadic diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml new file mode 100644 index 00000000..e1528415 --- /dev/null +++ b/.github/workflows/spellcheck.yml @@ -0,0 +1,14 @@ +name: spellcheck +on: + pull_request: +jobs: + check-spelling: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Check Spelling + uses: rojopolis/spellcheck-github-actions@0.33.1 + with: + config_path: .github/spellcheck-settings.yml + task_name: Markdown