Eslint

Learn more about:

POST Parameters

List with common parameters for all Buddy actions

NameTypeDescription
name
Required		StringThe name of the action.
type
Required		StringThe type of the action. Should be set to ESLINT.
version
Required		StringThe version of the NodeJS.
style
Required		StringThe name of the code style. Can be one of airbnb, canonical, canonical/ava, canonical/flowtype, canonical/jest, canonical/lodash, canonical/mocha, canonical/react, eslint, es/2015/server, es/2015/client, facebook, google, standard, xo, xo/esnext, xo/browser or custom.
config_pathStringRequired if style is set to custom. Path to the style config file.
fixBooleanDefines whether to automatically fix code issues or just perform the code analyse.
quietBooleanWhen set to true, reports only errors, without warnings.

Example

Request

POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/1/actions

JSON

{
  "name": "ESLint analyse",
  "type": "ESLINT",
  "trigger_time": "ON_EVERY_EXECUTION",
  "version": "9.4.0",
  "style": "airbnb",
  "fix": true,
  "quiet": true
}

Sample Response

HTTP

Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
  "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/1/actions/1",
  "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/1/action/1/edit",
  "id": 1,
  "name": "ESLint analyse",
  "type": "ESLINT",
  "trigger_time": "ON_EVERY_EXECUTION",
  "version": "9.4.0",
  "style": "airbnb",
  "fix": true,
  "quiet": true
  "pipeline": {
    "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/1",
    "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/1",
    "id": 1,
    "name": "test server",
    "trigger_mode": "MANUAL",
    "ref_name": "master",
    "last_execution_status": "SUCCESSFUL",
    "last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
  }
}
Questions?

Not sure how to configure a pipeline for your process? Reach out on the live-chat, contact support, or ask our community on our forum.

Sign up for Buddy Digest

Best practices on CI/CD and fresh changelogs delivered weekly to your inbox.