https://github.com/warpnet/vscode-salt-lint

VSCode extension for running salt-lint in your editor.
https://github.com/warpnet/vscode-salt-lint

linter salt-lint saltstack vscode

Last synced: 1 day ago
JSON representation

VSCode extension for running salt-lint in your editor.

• Host: GitHub
• URL: https://github.com/warpnet/vscode-salt-lint
• Owner: warpnet
• License: other
• Created: 2019-11-03T14:56:20.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2023-11-10T13:34:07.000Z (about 1 year ago)
• Last Synced: 2023-11-10T15:06:42.983Z (about 1 year ago)
• Topics: linter, salt-lint, saltstack, vscode
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=warpnet.salt-lint
• Size: 52.7 KB
• Stars: 6
• Watchers: 7
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# salt-lint extension for Visual Studio Code

[![Version](https://vsmarketplacebadge.apphb.com/version-short/warpnet.salt-lint.svg?style=flat-square&color=11beac&label=marketplace)](https://marketplace.visualstudio.com/items?itemName=warpnet.salt-lint)

[![Install Count](https://vsmarketplacebadge.apphb.com/installs-short/warpnet.salt-lint.svg?style=flat-square&color=11beac)](https://marketplace.visualstudio.com/items?itemName=warpnet.salt-lint)

[![Rating](https://vsmarketplacebadge.apphb.com/rating-short/warpnet.salt-lint.svg?style=flat-square&color=11beac)](https://marketplace.visualstudio.com/items?itemName=warpnet.salt-lint)

This extension integrates [salt-lint](https://github.com/warpnet/salt-lint/) into VScode

## Requirements

1. Ensure [salt-lint](https://github.com/warpnet/salt-lint/) is installed (`v0.1.0` or newer).

2. Run [`Install Extension`](https://code.visualstudio.com/docs/editor/extension-gallery#_install-an-extension) command from [Command Palette](https://code.visualstudio.com/Docs/editor/codebasics#_command-palette).

3. Search and choose `salt-lint`.

## Options

There are various options that can be configured by making changes to your user or workspace preferences.

Default options are:

```json

{

    "salt-lint.enable": true,

    "salt-lint.run": "onType",

    "salt-lint.executablePath": "salt-lint"

}

```

### Lint onType or onSave

By default the linter will lint as you type. Alternatively, set `salt-lint.run` to `onSave` if you want to lint only when the file is saved (works best if auto-save is on).

```javascript

{

    "salt-lint.run": "onType" // also: "onSave"

}

```

## Acknowledgements

This extension is based on [timonwong's ShellCheck Linter](https://github.com/timonwong/vscode-shellcheck).