Eslint

POST
/workspaces
/:domain
/projects
/:project_name
/pipelines
/:pipeline_id
/actions

Hint

List with common parameters for all Buddy actions

Request

URL PARAMETERS

domainrequired string

The workspace domain.

pipeline_idrequired integer

The numerical ID of the desired pipeline.

project_namerequired string

The name ID of the project.

POST PARAMETERS

namerequired string

The name of the action.

typerequired string

The type of the action. Should be set to ESLINT.

versionrequired string

The version of the NodeJS.

stylerequired string

The 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_pathstring

Required if style is set to custom. Path to the style config file.

fixboolean

Defines whether to automatically fix code issues or just perform the code analysis.

quietboolean

When set to true, reports only errors, without warnings.

Last modified on Oct 7, 2024

EOS Firebase

Example:

curl -X POST "https://api.buddy.works/workspaces/:domain/projects/:project_name/pipelines/:pipeline_id/actions" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "ESLint analyse",
  "type": "ESLINT",
  "trigger_time": "ON_EVERY_EXECUTION",
  "version": "9.4.0",
  "style": "airbnb",
  "fix": true,
  "quiet": true
}'

EXAMPLE RESPONSE
{
  "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",
    "on": "CLICK",
    "refs": [
      "refs/heads/master"
    ],
    "last_execution_status": "SUCCESSFUL",
    "last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
  }
}

STATUS
201 Created

LIMITS
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999