Run ShellCheck on shell scripts inside YAML

[Realiserad]

Hello,

I write a lot of Tekton YAML and that means small shell scripts inside YAML.

For example, I dummy like me would write something like:

- name: some-tekton-step
  image: gg.io/masterblaster
  script: |
    #!/bin/sh
    source foo.sh # Oops, SC3046
    if [[ -f ".jx/setup.sh" ]]; then # whoha, SC3010
       echo "Doing shell magic"
    fi

What I typically do now, is to copy paste the shell part into a new document to ensure there are no warnings, is there a better way?

[felipecrs]

That's what I do too. But I believe the solution should come first from the YAML extension: redhat-developer/vscode-yaml#943

Feel free to up vote it.

[Realiserad]

Thank you.

I would prefer not having to clutter my Tekton pipeline with a bunch of # yaml-language-server: $language=shell though. But I don't know enough about vscode's extension architecture to really have an opinion on this.

Was hoping that this extension could activate for yaml files and only do the linting for YAML multiline strings. I guess it would require a little preprocessing in this extension, do you think it would be difficult to implement? Maybe I could look at it if you can give me some pointers.

[felipecrs]

Well, it should be technically possible. Ideally it should be implemented in ShellCheck itself first, but that's likely never gonna happen. However, I think it'd be probably weird to have linter suggestions without syntax highlight first.

I don't have any pointers though. Sorry.

[Realiserad]

I think it'd be probably weird to have linter suggestions without syntax highlight first.

Ah, didn't think of that. Yes, then I do agree it makes more sense to implement this in Red Hat's YAML extension.