import {Targets} from 'projext-plugin-runner/src/services/runner/targets.js'

public class | source

Targets

This service is in charge of providing and validating the targets stored on the runner file.

Constructor Summary

Public Constructor
public	constructor(packageInfo: Object, pathUtils: PathUtils, projextPlugin: ProjextPlugin, runnerFile: RunnerFile) Class constructor.

Member Summary

Public Members
public	packageInfo: Object The information of the project's `package.json`.
public	pathUtils: PathUtils A local reference for the `pathUtils` service.
public	projextPlugin: ProjextPlugin A local reference for the `projextPlugin` service.
public	runnerFile: RunnerFile A local reference for the `runnerFile` service.

Method Summary

Public Methods
public	getDefaultTarget(): Target Returns the target with the name of project (specified on the `package.json`) and if there's no target with that name, then the first one, using a list of the targets name on alphabetical order.
public	getTarget(name: string): Target Get a target information by its name.
public	validate(name: string): boolean Validate a target information.

Private Methods
private	_normalizeTarget(target: Target): Target Add the execution path (`exec`) to a Target.

Public Constructors

public constructor(packageInfo: Object, pathUtils: PathUtils, projextPlugin: ProjextPlugin, runnerFile: RunnerFile) source

Class constructor.

Params:

Name	Type	Attribute	Description
packageInfo	Object		The project's `package.json`, necessary to get the project's name and use it as the name of the default target.
pathUtils	PathUtils		To create the targets exeuction paths.
projextPlugin	ProjextPlugin		To check if projext is present or not.
runnerFile	RunnerFile		To get the targets information.

Public Members

public packageInfo: Object source

The information of the project's package.json.

public pathUtils: PathUtils source

A local reference for the pathUtils service.

public projextPlugin: ProjextPlugin source

A local reference for the projextPlugin service.

public runnerFile: RunnerFile source

A local reference for the runnerFile service.

Public Methods

public getDefaultTarget(): Target source

Returns the target with the name of project (specified on the package.json) and if there's no target with that name, then the first one, using a list of the targets name on alphabetical order.

Return:

Target

Throw:

Error

If the project has no targets

public getTarget(name: string): Target source

Get a target information by its name.

Params:

Name	Type	Attribute	Description
name	string		The target name.

Return:

Target

Throw:

Error

If the target information is not on the runner file.

public validate(name: string): boolean source

Validate a target information.

Params:

Name	Type	Attribute	Description
name	string	nullable: true	The target name.

Return:

boolean

Throw:

Error	If the runner file doesn't exist.
Error	If the target executable doesn't exist.

Private Methods

private _normalizeTarget(target: Target): Target source

Add the execution path (exec) to a Target.

Params:

Name	Type	Attribute	Description
target	Target		The target for which the execution path will be generated for.

Return:

Target