krisgeus / azdo-inline-script-shellcheck

Shellcheck for inline shell snippets

Pre-commit hook for performing Shellcheck on shell snippets in AZDO pipeline yamls

This pre-commit hook performs shellcheck on script tasks in Azure Devops pipeline yaml files.

validate-shell-snippets

The validate shell snippets hook extracts (bash) shell script snippets from AZDO pipeline yaml files. Shellcheck is executed for each snippet encountered.

AZDO parameter or variable references (with the ${{ par }} syntax) are converted into shell variabel references to prevent errors. The Shellcheck is configured to ignore SC2154 since these variables are provided from outside the script snippets.

Usage

In your .pre-commit-config.yaml use the following config:

- repo: https://github.com/krisgeus/azdo-inline-script-shellcheck
  rev: v2.0.2
  hooks:
  - id: validate-shell-snippets
    name: Check shell snippets in yaml files
    language: docker
    entry: /bin/validate-shell-snippets

validate-shell-snippets-docker-latest

Same as Validate Shell Snippets but using the pre-built docker image (tag latest)

validate-shell-snippets-docker-latest Usage

In your .pre-commit-config.yaml use the following config:

- repo: https://github.com/krisgeus/azdo-inline-script-shellcheck
  rev: v2.0.2
  hooks:
  - id: validate-shell-snippets-docker-latest
    name: Check shell snippets in yaml files

validate-shell-snippets-docker-release

Same as Validate Shell Snippets but using the pre-built docker image from the release (tag v2.0.2)

validate-shell-snippets-docker-release Usage

In your .pre-commit-config.yaml use the following config:

- repo: https://github.com/krisgeus/azdo-inline-script-shellcheck
  rev: v2.0.2
  hooks:
  - id: validate-shell-snippets-docker-release
    name: Check shell snippets in yaml files

validate-powershell-snippets

The validate powershell snippets hook extracts (pwsh) shell script snippets from AZDO pipeline yaml files. PSScriptAnalyzer is executed for each snippet encountered.

AZDO parameter or variable references (with the ${{ par }} syntax) are converted into powershell variabel references to prevent errors.

Powershell validation Usage

In your .pre-commit-config.yaml use the following config:

- repo: https://github.com/krisgeus/azdo-inline-script-shellcheck
  rev: v2.0.2
  hooks:
  - id: validate-powershell-snippets
    name: Check powershell snippets in yaml files
    language: docker
    entry: /bin/validate-pwsh-snippets

validate-powershell-snippets-docker-latest

The validate Powershell snippets hook extracts powershell script snippets from AZDO pipeline yaml files. PSScriptAnalyzer is executed for each snippet encountered.

AZDO parameter or variable references (with the ${{ par }} syntax) are converted into powershell variabel references to prevent errors.

The hook is using the pre-built docker image (tag latest)

validate-powershell-snippets-docker-latest Usage

In your .pre-commit-config.yaml use the following config:

- repo: https://github.com/krisgeus/azdo-inline-script-shellcheck
  rev: v2.0.2
  hooks:
  - id: validate-powershell-snippets-docker-latest
    name: Check shell snippets in yaml files

validate-powershell-snippets-docker-release

Same as Validate Powershell Snippets but using the pre-built docker image from the release (tag v2.0.2)

validate-powershell-snippets-docker-release Usage

In your .pre-commit-config.yaml use the following config:

- repo: https://github.com/krisgeus/azdo-inline-script-shellcheck
  rev: v2.0.2
  hooks:
  - id: validate-powershell-snippets-docker-release
    name: Check shell snippets in yaml files

azdo-inline-script-shellcheck's Issues

Invoke-analyzer module not available when running in pre-commit docker

Invoke-ScriptAnalyzer: /bin/analyze-pwsh-snippet.ps1:12
Line |
  12 |  Invoke-ScriptAnalyzer -ScriptDefinition $pwsh_snippet -EnableExit -Re …
     |  ~~~~~~~~~~~~~~~~~~~~~
     | The term 'Invoke-ScriptAnalyzer' is not recognized as a name of a
     | cmdlet, function, script file, or executable program. Check the spelling
     | of the name, or if a path was included, verify that the path is correct
     | and try again.

Command running: docker run -v ${PWD}:/src:rw,Z --user $(id -u):$(id -g) --workdir /src [ghcr.io/krisgeus/inline-pwsh-check:latest](http://ghcr.io/krisgeus/inline-pwsh-check:latest) deploy.yml

When running without the --user it works correctly.
I assume it is because the installed module is not available for all users somehow.

Add powershell verification

Add docker linting

https://github.com/hadolint/hadolint/blob/master/docs/INTEGRATION.md#pre-commit

Improve inline script selection by using scriptType

Select only inlineScript tags where scriptType == 'bash'