No description or website provided.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Cloud Foundry Manifest YAML Editor for Atom

macOS Build Status Windows Build Status Dependency Status

This extension provides basic validation, content assist and hover infos for editing Cloud Foundry Manifest 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 CF manifest editor automatically activates when the name of the file you are editing is manifest.yml or editor grammar is set to Manifest-YAML

If you find an issue please raise it here: https://github.com/spring-projects/sts4/issues

Functionality

Validation

(Requires atom-ide-ui package) As you type the manifest 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? Content assist to the rescue:

Content Assist Screenshot

Dynamic Cloud Foundry Content Assist

Would you like to see actual Cloud Foundry values for attributes like services, buildpack, domain, and stack? If you have cf CLI installed and connected to a Cloud target, the extension will automatically display values for certain manifest attributes.

For example, if you are connected to a Cloud target that has services, and you invoke content assist in an entry under services, you will see the available service instances. In addition, service instances that do not exist in the Cloud target, like redisserv in the example below, are highlighted with a warning.

Dynamic content assist also shows which Cloud target you are connected to.

Dynamic Cloud Foundry 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

Releases:

Released versions of this package can be installed directly from the Atom package installer.

There are also development snapshots available with the latest fixes and improvements from release git repository: https://github.com/spring-projects/atom-cf-manifest-yaml

  1. Clone the release repository for Atom package if not already cloned and navigate to atom-cf-manifest-yaml folder
  2. Run git clean -fxd - necessary to delete out of date LS JAR file and dependency packages
  3. Run git pull - get the latest changes
  4. Run npm install - Install latest dependecnies and download proper LS JAR
  5. Run apm link . - Link the package to Atom
  6. Either start Atom or Reload Window in Atom