jest-runner-shellcheck

Shellcheck Linter runner for Jest

Usage

This library is a jest-runner for the shellcheck library.

$3

Install jest_(it needs Jest 21+)_ and jest-runner-shellcheck

``bash
yarn add --dev jest jest-runner-shellcheck

or with NPM

npm install --save-dev jest jest-runner-shellcheck
`

$3

#### Standalone

In your package.json

`json
{
"jest": {
"runner": "jest-runner-shellcheck",
"displayName": "lint:shell",
"moduleFileExtensions": ["sh", "bash"],
"testMatch": ["/src/*/.sh"]
}
}
`

Or in jest.config.js

`js
module.exports = {
runner: "jest-runner-shellcheck",
displayName: "shell lint",
moduleFileExtensions: ["sh", "bash"],
testMatch: ["/src/*/.sh"]
};
`

Please update testMatch to match your project folder structure

#### Alongside other runners

It is recommended to use the projects configuration option to run multiple Jest runners simultaneously.

If you are using Jest <22.0.5, you can use multiple Jest configuration files and supply the paths to those files in the projects option. For example:

`js
// jest-test.config.js
module.exports = {
// your Jest test options
displayName: "test"
};

// jest-grapqhl-schema-linter.config.js
module.exports = {
// your jest-runner-shellcheck options
runner: "jest-runner-shellcheck",
displayName: "shell lint",
moduleFileExtensions: ["sh", "bash"],
testMatch: ["/src/*/.sh"]
};
`

In your package.json:

`json
{
"jest": {
"projects": [
"/jest-test.config.js",
"/jest-shellcheck.config.js"
]
}
}
`

Or in jest.config.js:

`js
module.exports = {
projects: [
"/jest-test.config.js",
"/jest-shellcheck.config.js"
]
};
`

If you are using Jest >=22.0.5, you can supply an array of project configuration objects instead. In your package.json:

`json
{
"jest": {
"projects": [
{
"displayName": "test"
},
{
"runner": "jest-runner-shellcheck",
"displayName": "lint:shell",
"moduleFileExtensions": ["sh", "bash"],
"testMatch": ["/src/*/.sh"]
}
]
}
}
`

Or in jest.config.js:

`js
module.exports = {
projects: [
{
displayName: "test"
},
{
runner: "jest-runner-shellcheck",
displayName: "shell lint",
moduleFileExtensions: ["sh", "bash"],
testMatch: ["/src/*/.sh"]
}
]
};
`

$3

`bash
yarn test
`

Options

This project uses cosmiconfig, so you can provide config via:

* a jest-runner-shellcheck property in your package.json
* a jest-runner-shellcheck.config.js JS file
* a .jest-runner-shellcheckrc JSON file

In package.json

`json
{
"jest-runner-shellcheck": {
"cliOptions": {
// Options here
}
}
}
`

or in jest-runner-shellcheck.config.js

`js
module.exports = {
cliOptions: {
// Options here
}
};
`

$3

The listed options are the ones provided by the shellcheck CLI.

| option | default | values | example |
| ------------------- | ------- | ------------ | ------------------------------------------------------------------ |
| checkSourced | false | false|true | "checkSourced": true |
| color | null | auto|always|never | "color": "auto" |
| exclude | null | | "exclude": "CODE1,CODE2.." |
| format | checkstyle | checkstyle|gcc|json|tty | "format": "json" |
| shell | sh | sh|bash|dash|ksh | "shell": "bash" |
| externalSources | false | false|true | "externalSources": "true"` |