Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProfileValidator

API for going through the full validation test for a Brightside CLI profile and producing validation report

Hierarchy

  • ProfileValidator

Index

Properties

Static Readonly CUSTOMIZE_PLAN_KEY

CUSTOMIZE_PLAN_KEY: "validationPlanModule" = "validationPlanModule"

The key used to access the filename for the type containing the profile validation plan object. On your profile validation command definition, specify the filename in .customize[CUSTOMIZE_PLAN_KEY]

Accessors

Static PRINT_PLAN_OPTION

Methods

Static Private countOutcomes

Static getTextDisplayForPlan

  • Get a printed/tabular version of your validation plan, so that the user can see what steps the Brightside CLI will take to validate their profile

    Parameters

    • plan: IProfileValidationPlan

      the plan for profile validation

    • profile: IProfile

      the profile that would be validated - used only in this case to show a summary of the profile's contents

    • primaryHighlightColor: string

      primary highlight color for use with chalk

    Returns string

    • the formatted report

Static getTextDisplayForReport

  • Get a printed/tabular version of your validation report

    Parameters

    • report: IProfileValidationReport

      your completed validation result

    • plan: IProfileValidationPlan

      the validation plan to use

    • productDisplayName: string

      the display name for your CLI used in the final result text

    • primaryHighlightColor: string

      color used to highlight headings and tables (used with chalk package)

    • profileName: string

      the name of the profile that was validated

    • profileType: string

      the type of the profile that was validated

    Returns string

    • the formatted report

Static outcomeToString

Static validate

Generated using TypeDoc