Skip to content

picimako/terra-support

Repository files navigation

Terra Support Plugin for JetBrains IDEs

Terra Support

This plugin provides integration to Cerner's various Terra libraries, especially with their test automation elements.

The automation specific part of the plugin provides tools for easier handling of screenshots, and for reporting coding issues, including but not limited to:

  • Inspections for viewports and screenshots.
  • Custom tool window for a better overview of Terra wdio screenshots, extended with bulk operations on them.
  • Custom editors for previewing diff images, and comparing reference and latest screenshots.
  • Additional navigation options and visual clues for screenshot validation.
  • Added and extended Quick Documentation popup contents.

The part that focuses on the Terra UI components adds external documentation URLs to UI component React tags for easier navigation to related documentation.

Features and settings

The followings are a summary of the features incorporated into this plugin:

  • Code inspections: to validate different aspects of Terra wdio tests. They are enabled by default, unless stated otherwise.
  • Quick Documentations: Quick Documentations can be triggered via Ctrl+Q (on Windows) or F1 (on Mac). It shows a popup with some rendered information about the element in question.
  • References: The feature called References provides a way to navigate from a reference of an element to the definition of it, just like when you jump to the definition of a function from the usage of that.
  • Tool Window: There is a Tool Window called Terra Wdio available to work with Terra screenshots.
  • Inlay Hints: These are small labels injected into the code, that provide extra (often otherwise invisible) information about the code. The current Inlay Hints include displaying screenshot names and global Terra CSS selectors.

The documents below provide more details about the various features:

There are also various customization options for the plugin which you can find on its dedicated Plugin Settings page.

Developer documentation

To get started with the development of this project you can find some details in the dev docs.

Cerner Terra resources

Images and logos

The Terra Support plugin logo is a custom-drawn logo inspired by the original Terra logo, and it portrays a moon which orbits a planet, which orbits a "cold star". (Shout out to Doctor Who.)

Licencing

This project and the Terra Support plugin logo is licensed under the terms of Apache Licence Version 2.0.