.spellcheck.yml

matrix:
- name: asciidoc source py spell check configuration
  aspell:
    lang: en
    d: en_US
  sources:
  - documentation/*.asciidoc
  dictionary:
    wordlists:
    - en-devonfw.dict
    output:  en-devonfw.dic
  pipeline:
  #Ignore for words starting and ending with colon
  - pyspelling.filters.python:
  - pyspelling.filters.context:
      context_visible_first: true
      escapes: ':\S+?:'
  - pyspelling.filters.url:
  #Ignore for directory path
  - pyspelling.filters.context: 
      context_visible_first: true
      escapes: '^.*[\/\\][^\/\\]+$'
  #Ignore for url starting with http or https
  - pyspelling.filters.context: 
      context_visible_first: true
      delimiters:
      - open: 'https?:\S+?'
        close: '\s'
  #Ignore content between backticks
  - pyspelling.filters.context: 
      context_visible_first: true
      delimiters:
      - open: '```'
        close: '(\w|\W)+?(?=```)'
  #Ignore content between backticks
  - pyspelling.filters.context: 
      context_visible_first: true
      delimiters:
      - open: '(?<!``)`[^`]+'
        close: '`'
  #Ignore links
  - pyspelling.filters.context: 
      context_visible_first: true
      delimiters:
      - open: 'link:[^[]+'
        close: '\['
  #Ignore Image tags
  - pyspelling.filters.context: 
      context_visible_first: true
      delimiters:
      - open: 'image:[^[]+'
        close: '\['
  #Ignore Image tags link part
  - pyspelling.filters.context:
      context_visible_first: true
      delimiters:
      - open: ',.+?link=[^\]]+'
        close: '\]'
  #Ignore include tag
  - pyspelling.filters.context: 
      context_visible_first: true
      delimiters:
      - open: 'include:[^[]+'
        close: '\['
  - pyspelling.filters.context:
      context_visible_first: true
      escapes: \\[\\-~]
      delimiters:
      # Ignore multiline content between fences (fences can have 4 or more hyphens)
      # ----
      # content
      # ----
      - open: '(?s)^(?P<open> *-{4,})$'
        close: '^(?P=open)$'  
  - pyspelling.filters.context:
      context_visible_first: true
      delimiters:
      # Ignore multiline content between [source, *] and blank line
      - open: '\[source,.*\]\r?\n\s*----'
        close: '\s*----'