Files
spring-tools/atom-extensions/atom-concourse

Concourse CI YAML Editor for Atom

macOS Build Status Windows Build Status Dependency Status

This extension provides basic validation, content assist and hover infos for editing Concourse Pipeline and Task Configuration Files.

It is recommended to use this extension package when atom-ide-ui atom extension package is installed. Thus, reconciling (error/warning markers) and hover support is fully functional.

Usage

The Concourse editor automatically activates when the name of the file you are editing is pipeline.yml or task.yml. Alternately, you can select the grammar for your file by doing these steps:

  • Open the file, and it will most likely open with the default Atom YAML editor.
  • In the bottom-right of the editor, click on YAML.
  • This opens the Grammar Selection dialogue. Search and select Concourse-Pipeline-YAML for pipeline files, or Concourse-Task-YAML for task files.

Functionality

Validation

(Requires atom-ide-ui package) As you type the file is parsed and checked for basic syntactic and structural correctness. Hover over an error marker to see an explanation.

Linting Screenshot

Content Assist

Having trouble remembering all the names of the attributes, and their spelling? Or can't remember which resource properties to set in the get task params versus its source attributes? Or don't remember what 'special' values are acceptable for a certain property? Content assist to the rescue:

Content Assist Screenshot

Content Assist Screenshot

Documentation Hovers

(Requires atom-ide-ui package) Having trouble remembering exactly what the meaning of each attribute is? Hover over any attribute and read its detailed documentation.

Hover Docs Screenshot

Navigate to Symbol in File

Is your Pipeline yaml file getting larger and it is becoming harder to find a particular Job, Resource or Resource Type declaration? The Atom Outline View (View -> Toggle Outline View) helps you quickly jump to a specific definition.

Outline View

Dev environment setup:

Prerequisite: Node 6.x.x or higher is installed, Atom 1.17 or higher is installed

  1. Clone the repository
  2. Run npm install
  3. Execute apm link . from the folder above
  4. Perform Reload Window in Atom (Cmd-Shift-P opens commands palette, search for reload, select, press Return)
  5. Open any pipeline.yml or task.yml file in Atom observe reconciling, content assist and other IDE features