aws-cloudformation / aws-cloudformation/cfn-lint-visual-studio-code
Feature Request: Allow docker to be used in the config
- Dominant language
- JavaScript
- Stars
- 289
- Forks
- 170
- PR merge metrics
- No merged PRs in 30d
Description
I am wanting to use docker and integrate it into this vscode extension rather than having to install packages locally.
This eases onboarding and prevents issues with other projects/packages that may be installed on a users computer.
I have this working for manually processing the scripts but it would be ideal if I could modify the config to point to docker instead of a local installation.
```json
{
"cfnLint.path": "docker run -v $(pwd)/:/data -t mysteriouscode/cfn-lint"
}
```
Currently, if I do try to pass docker, I get an error due to the space after `docker`. Given that is a path, I would expect this to be the case.
I currently use scripts to do the linting:
```json
{
"scripts": {
"Tools:": "echo \"Nothing to see here\" && exit 1",
" - cfn-lint": "docker run -v $(pwd)/:/data -t mysteriouscode/cfn-lint --config-file /data/.config/cfn-lint/.cfnlintrc.yaml",
"Debug:": "echo \"Nothing to see here\" && exit 1",
" - cfn-lint:version": "docker run -v $(pwd)/:/data -t mysteriouscode/cfn-lint --version"
}
}
```
Please consider adding this capability. Thank you
Contributor guide
Research direction
Start by tracing how the cfnLint.path setting is read and how the extension invokes the configured executable. Compare the current path handling with the Docker command shown in the issue, including arguments and spaces. Done means users can configure Docker instead of a local installation and linting works through the extension.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, vscode
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100