How to spellcheck only specific sections of a YAML document?

[nasbench]

Hi,

Just have a quick question regarding the usage of context filters. (and if its the correct way of using them)

I have a yaml document in the following form

title: Title
id: SomeID
description: Some description
references:
    - https://google.com
data:
    element1: process_creation
    element2: windows
detection:
    some_random_1:
        - random1: 1
        - random2: 2
    some_random_2:
        random|contains:
            - 'A'
            - 'B'
    condition: this is a condition
other:
    - some other things
final: something

I wan spell check only some sections of the document mainly the description and title and some other fields.

Is using the pyspelling.filters.context the correct approach? If so can you explain how would go about achieving this. If not is its possible to do such thing with pyspelling.

Appreciate your response in advance :)

Thanks

[facelessuser]

You could certainly try to use the context filter, if it works well enough, then I'd say go for it.

Keep in mind that I do not have a specific filter for every file type out there, nor is my intention to as I am not familiar with every file type out there. That is why the plugin system exists. It might be more appropriate to write a filter specifically for a specific file type if something like context is not sufficient,. I could potentially see a plugin parsing YAML content with PyYAML and targeting specific sections, etc.

I could even maybe see an argument for a YAML filter built into PySpelling as we already have the dependency, but work would have to be done to bring such a filter to light.

[facelessuser]

I can maybe give a context example, but I'll have to get back to you a bit later.

[nasbench]

No worries, if you can provide one that would be great. I'll look into the plugin system and see if I can cook something and if its easy enough :)

I +1 the Yaml filter as its used often. So if you have time to actually build one (I can offer help once I get familiar with the lib) that would be amazing.

Cheers.

[nasbench]

Quick update. After reading some of the filters and the docs. I think i found a workaround that fits my needs.

I'm modifying the text filter specifically the filter function and manipulating the source_file using PyYAML. I extracted the fields I needs merged them into a single string and return them for checking. I think this will do the job.

I think this same logic can be used to create a more generic YAML filter. For example we can add user option to provide a dict of keys he wants extracted or filtered out and we setup everything in the setup function then do the magic in filter.

Let me know what you think about this solution (I know its hacky). I'm probably doing some stuff wrong. So if you have suggestions I'm all ears :)

Thanks

[facelessuser]

Without seeing what you've done, I can't really comment, but basically, this is why I wrote PySpelling, so I (or other people) can write their own filters when it is determined Aspell's filters were insufficient.