enricher

Documentation

Index

• func GetEnvPort(envPlaceholder string) int
• func GetEnvPortFromDockerfile(envPlaceholder string, path string) int
• type AngularDetector
  • func (a AngularDetector) DoFrameworkDetection(language *model.Language, config string)
  • func (a AngularDetector) DoPortsDetection(component *model.Component, ctx *context.Context)
  • func (a AngularDetector) GetApplicationFileInfos(componentPath string, ctx *context.Context) []model.ApplicationFileInfo
  • func (a AngularDetector) GetSupportedFrameworks() []string
• type ExpressDetector
  • func (e ExpressDetector) DoFrameworkDetection(language *model.Language, config string)
  • func (e ExpressDetector) DoPortsDetection(component *model.Component, ctx *context.Context)
  • func (e ExpressDetector) GetApplicationFileInfos(componentPath string, ctx *context.Context) []model.ApplicationFileInfo
  • func (e ExpressDetector) GetSupportedFrameworks() []string
• type NextDetector
  • func (n NextDetector) DoFrameworkDetection(language *model.Language, config string)
  • func (n NextDetector) DoPortsDetection(component *model.Component, ctx *context.Context)
  • func (a NextDetector) GetApplicationFileInfos(componentPath string, ctx *context.Context) []model.ApplicationFileInfo
  • func (n NextDetector) GetSupportedFrameworks() []string
• type NuxtDetector
  • func (n NuxtDetector) DoFrameworkDetection(language *model.Language, config string)
  • func (n NuxtDetector) DoPortsDetection(component *model.Component, ctx *context.Context)
  • func (n NuxtDetector) GetApplicationFileInfos(componentPath string, ctx *context.Context) []model.ApplicationFileInfo
  • func (n NuxtDetector) GetSupportedFrameworks() []string
• type ReactJsDetector
  • func (r ReactJsDetector) DoFrameworkDetection(language *model.Language, config string)
  • func (r ReactJsDetector) DoPortsDetection(component *model.Component, ctx *context.Context)
  • func (r ReactJsDetector) GetApplicationFileInfos(componentPath string, ctx *context.Context) []model.ApplicationFileInfo
  • func (r ReactJsDetector) GetSupportedFrameworks() []string
• type SvelteDetector
  • func (s SvelteDetector) DoFrameworkDetection(language *model.Language, config string)
  • func (s SvelteDetector) DoPortsDetection(component *model.Component, ctx *context.Context)
  • func (s SvelteDetector) GetApplicationFileInfos(componentPath string, ctx *context.Context) []model.ApplicationFileInfo
  • func (s SvelteDetector) GetSupportedFrameworks() []string
• type VueDetector
  • func (v VueDetector) DoFrameworkDetection(language *model.Language, config string)
  • func (v VueDetector) DoPortsDetection(component *model.Component, ctx *context.Context)
  • func (v VueDetector) GetApplicationFileInfos(componentPath string, ctx *context.Context) []model.ApplicationFileInfo
  • func (v VueDetector) GetSupportedFrameworks() []string

Functions

func GetEnvPort

func GetEnvPort(envPlaceholder string) int

func GetEnvPortFromDockerfile

func GetEnvPortFromDockerfile(envPlaceholder string, path string) int

GetEnvPortFromDockerfile returns a port value from the Dockerfile (locations provided by the 'utils.GetLocations' function) matching the specified 'envPlaceHolder'. It first extracts the environment variable name to lookup from 'envPlaceholder' by removing any 'process.env.' prefix. It then searches through all environment variables detected from the Dockerfile (as determined by 'utils.GetEnvVarsFromDockerFile'). And if the environment variable specified via 'envPlaceholder' is found in the Dockerfile environment variables and its corresponding value is a valid port (as determined by 'utils.GetValidPort'), it returns this valid port value.

If there is an error reading the Dockerfile or if the environment variable specified via 'envPlaceholder' is not found among the Dockerfile environment variables, the function returns -1.

Types

type AngularDetector

type AngularDetector struct{}

func (AngularDetector) DoFrameworkDetection

func (a AngularDetector) DoFrameworkDetection(language *model.Language, config string)

DoFrameworkDetection uses a tag to check for the framework name

func (AngularDetector) DoPortsDetection

func (a AngularDetector) DoPortsDetection(component *model.Component, ctx *context.Context)

DoPortsDetection searches for the port in angular.json, package.json, and angular-cli.json

func (AngularDetector) GetApplicationFileInfos

func (a AngularDetector) GetApplicationFileInfos(componentPath string, ctx *context.Context) []model.ApplicationFileInfo

func (AngularDetector) GetSupportedFrameworks

func (a AngularDetector) GetSupportedFrameworks() []string

type ExpressDetector

type ExpressDetector struct{}

func (ExpressDetector) DoFrameworkDetection

func (e ExpressDetector) DoFrameworkDetection(language *model.Language, config string)

DoFrameworkDetection uses a tag to check for the framework name

func (ExpressDetector) DoPortsDetection

func (e ExpressDetector) DoPortsDetection(component *model.Component, ctx *context.Context)

func (ExpressDetector) GetApplicationFileInfos

func (e ExpressDetector) GetApplicationFileInfos(componentPath string, ctx *context.Context) []model.ApplicationFileInfo

func (ExpressDetector) GetSupportedFrameworks

func (e ExpressDetector) GetSupportedFrameworks() []string

type NextDetector

type NextDetector struct{}

func (NextDetector) DoFrameworkDetection

func (n NextDetector) DoFrameworkDetection(language *model.Language, config string)

DoFrameworkDetection uses a tag to check for the framework name

func (NextDetector) DoPortsDetection

func (n NextDetector) DoPortsDetection(component *model.Component, ctx *context.Context)

DoPortsDetection searches for the port in package.json

func (NextDetector) GetApplicationFileInfos

func (a NextDetector) GetApplicationFileInfos(componentPath string, ctx *context.Context) []model.ApplicationFileInfo

func (NextDetector) GetSupportedFrameworks

func (n NextDetector) GetSupportedFrameworks() []string

type NuxtDetector

type NuxtDetector struct{}

func (NuxtDetector) DoFrameworkDetection

func (n NuxtDetector) DoFrameworkDetection(language *model.Language, config string)

DoFrameworkDetection uses a tag to check for the framework name

func (NuxtDetector) DoPortsDetection

func (n NuxtDetector) DoPortsDetection(component *model.Component, ctx *context.Context)

DoPortsDetection searches for the port in package.json, and nuxt.config.js

func (NuxtDetector) GetApplicationFileInfos

func (n NuxtDetector) GetApplicationFileInfos(componentPath string, ctx *context.Context) []model.ApplicationFileInfo

func (NuxtDetector) GetSupportedFrameworks

func (n NuxtDetector) GetSupportedFrameworks() []string

type ReactJsDetector

type ReactJsDetector struct{}

func (ReactJsDetector) DoFrameworkDetection

func (r ReactJsDetector) DoFrameworkDetection(language *model.Language, config string)

DoFrameworkDetection uses a tag to check for the framework name

func (ReactJsDetector) DoPortsDetection

func (r ReactJsDetector) DoPortsDetection(component *model.Component, ctx *context.Context)

DoPortsDetection searches for the port in the env var, .env file, and package.json

func (ReactJsDetector) GetApplicationFileInfos

func (r ReactJsDetector) GetApplicationFileInfos(componentPath string, ctx *context.Context) []model.ApplicationFileInfo

func (ReactJsDetector) GetSupportedFrameworks

func (r ReactJsDetector) GetSupportedFrameworks() []string

type SvelteDetector

type SvelteDetector struct{}

func (SvelteDetector) DoFrameworkDetection

func (s SvelteDetector) DoFrameworkDetection(language *model.Language, config string)

DoFrameworkDetection uses a tag to check for the framework name

func (SvelteDetector) DoPortsDetection

func (s SvelteDetector) DoPortsDetection(component *model.Component, ctx *context.Context)

DoPortsDetection searches for the port in package.json

func (SvelteDetector) GetApplicationFileInfos

func (s SvelteDetector) GetApplicationFileInfos(componentPath string, ctx *context.Context) []model.ApplicationFileInfo

func (SvelteDetector) GetSupportedFrameworks

func (s SvelteDetector) GetSupportedFrameworks() []string

type VueDetector

type VueDetector struct{}

func (VueDetector) DoFrameworkDetection

func (v VueDetector) DoFrameworkDetection(language *model.Language, config string)

DoFrameworkDetection uses a tag to check for the framework name

func (VueDetector) DoPortsDetection

func (v VueDetector) DoPortsDetection(component *model.Component, ctx *context.Context)

DoPortsDetection searches for the port in package.json, .env file, and vue.config.js

func (VueDetector) GetApplicationFileInfos

func (v VueDetector) GetApplicationFileInfos(componentPath string, ctx *context.Context) []model.ApplicationFileInfo

func (VueDetector) GetSupportedFrameworks

func (v VueDetector) GetSupportedFrameworks() []string