DEV Community

Jonas Brømsø
Jonas Brømsø

Posted on • Updated on

Release 0.22.0 and 0.22.1 of Spellcheck (GitHub) Action - feature release enabling Spanish

Hurra tenemos un nuevo lanzamiento

I am very happy to announce a released based on a PR (#81) from @electrocucaracha, which enables support for Spanish.

The Spellcheck GitHub Action now supports:

  • Spanish
  • German
  • And English

Unfortunately some more extensive test demonstrated that the support was not working as expected, so a bug fix release was released shortly after and should be available on the GitHub Marketplace now.

Now on to how to use the new extension introduced with release 0.22.0.

If we have a standard configuration (.spellcheck.yml):

matrix:
- name: Markdown
  aspell:
    lang: en
  dictionary:
    wordlists:
    - .wordlist.txt
    encoding: utf-8
  pipeline:
  - pyspelling.filters.markdown:
  - pyspelling.filters.html:
      comments: false
      ignores:
      - code
      - pre
  sources:
  - 'README.md'
  default_encoding: utf-8
Enter fullscreen mode Exit fullscreen mode

You can specify the language by setting lang like so:

lang: es
Enter fullscreen mode Exit fullscreen mode

For Spanish.

lang: de
Enter fullscreen mode Exit fullscreen mode

For German.

In addition you can specify a variation to the language, German supports, via the [aspell-de Debian package][aspell-de]:

  • German (de_DE),
  • Swiss (de_CH)
  • Austrian (de_AT)

You can specify this using d:

lang: de
d: de_AT
Enter fullscreen mode Exit fullscreen mode

For English:

  • American (en_US),
  • British (en_GB),
  • Canadian (en_CA)
  • and Australian (en_AU)

Spanish does not support any additional variants.

A complete configuration (.spellcheck.yml) for Spanish (es) could look as follows:

matrix:
- name: Markdown
  aspell:
    lang: es
  dictionary:
    wordlists:
    - .wordlist.txt
    encoding: utf-8
  pipeline:
  - pyspelling.filters.markdown:
  - pyspelling.filters.html:
      comments: false
      ignores:
      - code
      - pre
  sources:
  - 'README.md'
  default_encoding: utf-8
Enter fullscreen mode Exit fullscreen mode

I did some investigation some time ago via issue #35 and enabling all languages supported by aspell. This demonstrated a significant increase the size of the Docker image, so support for additional languages is implemented by request.

That is all. If you experience any issues please report them via GitHub.

The fix implemented with release 0.22.1, was a simplification of the Docker build, so previous a known issue with the Docker build was also marked as resolved.

Next up is working out how to implement improved unit-tests of the Docker image, so we do not see such bugs or regressions for that matter in the future.

Change log for 0.22.0 and 0.22.1

0.22.1, 2022-02-23, bug fix release, update recommended

  • Testing the new Spanish support feature more thoroughly, demonstrated that the Docker build process was broken and only English worked

    • I addressed issue #57, which demonstrated an issue with the Docker build, the issue is no longer relevant with the simplification of the Docker build via PR: #82 by me (@jonasbn)

0.22.0, 2022-02-21, feature release, update not required

  • Support for the Spanish language. Support requested and implemented by @electrocucaracha via PR #81

Top comments (0)