Terraform: How to only check comments?

[staranto]

My language is Terraform. So all of these are valid comments...

# This is a comment

// This is a comment

abc = 123  # This is an end of line comment

abc = 123  // This is an end of line comment

/* This is 
a multiline 
comment */

I can't quite come up with a combination of ignore and include regex to check only comments.

Any ideas? Thanks!

[Jason3S]

Try adding the following to your project:

cspell.json

{
    "patterns": [
        {
            "name": "terraform.comment.single-line",
            "description": "Matches Terraform single-line comments",
            "pattern": "/(#|\\/\\/).*/g"
        },
        {
            "name": "terraform.comment",
            "description": "Matches Terraform comments",
            "pattern": ["CStyleComment", "terraform.comment.single-line"]
        }
    ],
    "languageSettings": [
        {
            "languageId": "terraform,tf",
            "includeRegExpList": ["terraform.comment"]
        }
    ],
    "overrides": [
        {
            "filename": ["*.tf", "*.tfvars"],
            "languageId": "terraform"
        }
    ],
    "ignoreWords": ["tfvars"],
    "enableFiletypes": ["tf", "terraform"]
}

If you run:

npx cspell check <path to your terraform file>

Text that is ignored should be dark gray. Like this:

[staranto]

Thanks for the quick and thorough reply, Jason! Your exact example works like a champ.

I'm trying to include it in my settings.json and, though it seems to work completely, the validator vomits on the last "pattern" with an "Incorrect Type. Expected string". Any idea about that?

  "cSpell.patterns": [
    {
      "name": "terraform.comment.single-line",
      "description": "Matches Terraform single-line comments",
      "pattern": "/(#|\\/\\/).*/g"
    },
    {
      "name": "terraform.comment",
      "description": "Matches Terraform comments",
      "pattern": ["CStyleComment", "terraform.comment.single-line"]
    }

[Jason3S]

It is not an issue. I'll check and see why it is not part of the scheme.