https://github.com/AtomLinter/linter-shellcheck

Linter plugin for Bash, using shellcheck.
https://github.com/AtomLinter/linter-shellcheck

Last synced: 27 days ago
JSON representation

Linter plugin for Bash, using shellcheck.

• Host: GitHub
• URL: https://github.com/AtomLinter/linter-shellcheck
• Owner: AtomLinter
• Archived: true
• Created: 2014-05-12T18:32:05.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2023-07-28T19:35:33.000Z (over 1 year ago)
• Last Synced: 2024-08-07T23:45:36.862Z (5 months ago)
• Language: JavaScript
• Homepage:
• Size: 179 KB
• Stars: 109
• Watchers: 7
• Forks: 19
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        
# linter-shellcheck

This linter plugin for [Linter][linter] provides an interface to

[shellcheck][shellcheck]. It will be used with files that have the "Shell"

syntax.

## Installation

Linter package must be installed in order to use this plugin. If Linter is not

installed, please follow the instructions [here][linter].

### `shellcheck` installation

Before using this plugin, you must ensure that `shellcheck` is installed on

your system. To install `shellcheck`, follow the guide on

[shellcheck github][shellcheck]

### Plugin installation

```ShellSession

apm install linter-shellcheck

```

## Settings

You can configure linter-shellcheck through Atom's Settings menu. If you

instead prefer editing the configuration by hand you can get to that by editing

`~/.atom/config.cson` (choose Open Your Config in Atom menu). The settings

available are:

-   `shellcheckExecutablePath`: The full path to the `shellcheck` executable.

    Run `which shellcheck` to find where it is installed on your system.

-   `userParameters`: Any additional executable parameters to pass to

    `shellcheck` when linting your files.

-   `enableNotice`: Include lesser-importance ShellCheck messages

    (default: false).

-   `useProjectCwd`: Controls whether the paths used by ShellCheck's

    [`source=`](https://github.com/koalaman/shellcheck/wiki/Directive#source)

    directive are relative to the project root or the file (default: false, for

    file-relative)

    

    -   If true, ShellCheck's working directory

        will be the project's root directory.  Any `source=` directives will be

        interpreted relative to the project root.

    -   Otherwise, ShellCheck will run relative to the file's directory,

        making `source=` directives file-relative.

[linter]: https://github.com/atom-community/linter "Linter"

[shellcheck]: https://github.com/koalaman/shellcheck "ShellCheck"