import {Plugins} from 'projext/src/services/common/plugins.js'

public class | source

Plugins

This service is in charge of looking for, loading and registering plugins for the app.

Constructor Summary

Public Constructor
public	constructor(prefix: string, app: Projext, appLogger: Logger, packageInfo: Object, pathUtils: PathUtils) Class constructor.

Public Members
public	app: Projext The local reference to the main app.
public	appLogger: Logger A local reference for the `appLogger` service.
public	packageInfo: Object The implementation `package.json`
public	pathUtils: PathUtils A local reference for the `pathUtils` service.
public	prefix: string The prefix the dependencies need to have in order to be identified as plugins.

Public Methods
public	getLoadedPlugins(): string Gets the names of the loaded plugins.
public	load(dependencies: boolean, devDependencies: boolean) Search for plugins on the `package.json` and loads them.
public	loadFromFile(filePath: string) Loads a plugin from a file relative to the project root directory.
public	loaded(name: string): boolean Checks whether a plugin was loaded or not.

Class constructor.

Name	Type	Attribute	Description
prefix	string		The prefix the dependencies need to have in order to be identified as plugins.
app	Projext		To send to the plugis so they can register their services.
appLogger	Logger		To indicate if a plugin couldn't be loaded.
packageInfo	Object		To read the dependencies list.
pathUtils	PathUtils		To build the dependencies paths.

The local reference to the main app.

A local reference for the appLogger service.

The implementation package.json

A local reference for the pathUtils service.

The prefix the dependencies need to have in order to be identified as plugins.

Gets the names of the loaded plugins.

Search for plugins on the package.json and loads them.

Name	Type	Attribute	Description
dependencies	boolean	optional default: true	Whether or not to look for plugins on the `dependencies`.
devDependencies	boolean	optional default: true	Whether or not to look for plugins on the `devDependencies`.

Loads a plugin from a file relative to the project root directory.

Name	Type	Attribute	Description
filePath	string		The path to the file.

Checks whether a plugin was loaded or not.

Name	Type	Attribute	Description
name	string		The plugin's name.