yaml_variable_scanner.yaml

yaml_variable_scanner:

  # File path for YAML variables
  yamlFilePath:
    - path: "test/siteA.yaml" # YAML path (Glob syntax)
      variablePrefix: "a." # Variable prefix. e.g. `a.` -> `a.x.xx`
    - path: "test/siteB.yaml"
      variablePrefix: "b."

  # Ignore YAML file path
  #
  # (Glob Syntax)
  ignoreYamlFilePath:
    - "test/test.yaml"

  # Ignore YAML Key
  #
  # e.g. "^a\.bb$"
  #
  # (RegExp Syntax)
  ignoreYamlKey:
    - ^description$
  
  # File path for check file contents
  #
  # (Glob Syntax)
  checkFilePath:
    - "test/**/*.md"

  # Ignore file paths to check
  #
  # (Glob Syntax)
  ignoreCheckFilePath:
    - "test/content/**.md"

  # Ignore text that doesn't need to match
  #
  # e.g. 
  # - `r"^\s*---([\s\S]*?)---$"`
  # - `r"^\s*{%-?\s*comment\s*-?%}([\s\S]*?){%-?\s*endcomment\s*-?%}$"`
  # - `r"^\s*<!---?\s*([\s\S]*?)\s*-?-->$"`
  #
  # (RegExp Syntax)
  ignoreCheckText:
    # --- xxx ---
    - ^\s*---([\s\S]*?)---$

    # {%- comment %} xxx {% endcomment -%}
    - ^\s*{%-?\s*comment\s*-?%}([\s\S]*?){%-?\s*endcomment\s*-?%}$

    # <!-- xxx -->
    - ^\s*<!---?\s*([\s\S]*?)\s*-?-->$