Help linting YAML files please?

[daobrien]

vale version 3.12.0

Most of our content is written in adoc but we also use one YAML file for a range of headings, audience identification statements, and similar. I have Vale configured so that it is processing the YAML file, but I also have a couple of styles where I need to ignore titles. For adoc files, I use scope: ~heading but I can't work out the equivalent for YAML files.

I've been following the info at https://github.com/errata-ai/vale/releases/tag/v3.11.0 but can't make it work. This is a pure YAML file. The title headings appear at different levels for different sections, so that might be part of the problem.

I'd really like to get this working because it's a big part of our linting process. Would love any pointers, suggestions, etc.

Thanks a lot.
David

[jdkato]

Do you have an example file? It's hard for me to help without a little more information.

[daobrien]

I can't give you an entire file but I can give you a representative section:

  chapters:
    - keyword: roles
      title: 'Reusing Code with Ansible Roles and Content Collections'
      goal: |-
          Use Ansible Roles and Ansible Content Collections to develop playbooks more quickly and to reuse Ansible code.
      topics:
        - keyword: structure
          title: Defining Role Structure
          sections:
            - type: lecture
              time: 15
              objectives:
                - Define the purpose of an Ansible Role, its structure, and how roles are used in playbooks.
            - type: multichoice
              time: 15

We have Vale styles that we need to apply to the title, goal, and objectives sections, but not others, such as type, time, and so on.
I hope this helps explain what I'm trying to do. tbh over the last few weeks I've had very little time to look at this :-\

Thanks for any help.
David

[jdkato]

You can create a custom file view that extracts those sections:

engine: dasel
scopes:
  - name: chapter.title
    expr: chapters.all().title

  - name: chapter.goal
    expr: chapters.all().goal
    # Long form content (`|-`) might contain markup?
    type: md

  - name: section.objective
    # objectives can be empty
    expr: chapters.all().topics.all().sections.all().objectives?.all()

You can then write rules that target them individually:

extends: existence
message: "'%s' should be capitalized"
scope: chapter.title
raw:
  - "^[a-z].+"

Or just let your default (text-scoped) rules run on these setions.

[daobrien]

Thanks. I figured it was something to do with views but hadn't got my head around it. I'll dig into this as soon as I can. Thanks a lot.
David

[jyaguem]

Hello, I've been doing some tests with a view and it worked perfectly to check all of our rules on certain keys in the YAML file. However, I was missing a way to skip certain rules on certain keys of the YAML file (e.g. skip Vale.Spelling rule on metadata fields).

Is there a way to achieve such behavior with views? I was able to achieve it by adding an optional ignore field to View scopes that allows specifying a list of rules to skip when linting specific YAML keys, but I'm unsure if there was already a way to do it.

If not, I'd be happy to refine what I did and submit it so it can be considered for a future update.

[jyaguem]

@jdkato I just went ahead and created a PR with my changes. I guessed it would be easier to directly see what I did. Hope that is ok :)