Home Manual Reference Source

References

summary
public
public
public

T BuildEngineGetCommand(target: Target, buildType: string, forceRun: boolean, forceWatch: boolean, forceInspect: boolean): string: function

public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public

T TargetFileRuleHandler(target: Target, hasTarget: boolean, currentRule: TargetFileRuleSettings): function

public
public
public
public
public
public
public
public
public

E Buffer

public
public
public
public
public

E Jimple

public

E Logger

public
public
public
public
public
public

E ndb

abstracts

summary
public abstract

A helper class for creating commands for the CLI.

version 1.0
public abstract

A helper class for creating sub commands for the CLI.

version 1.0
public abstract

A helper class for creating configuration files that can be overwritten on implementation.

version 1.0
public abstract

A helper class for creating services that rely on watching directories and copying and/or transpiling files.

version 1.0

app

summary
public

This is projext dependecy injection container.

services/building

summary
public

Remove the builded files for the project and/or an specific target.

public

Copies the project files and/or the files of a target that doesn't require bundling.

public

This is an special service as it doesn't do anything but returning another services: Build engines are what projext uses to bundle targets, since they depend on a target configuration, we can't have huge if that checks the value of the setting in order to retrieve the required service.

public

This service provides a simple interface for running targets on a development environment using Nodemon.

public

This service implements nodemon and NodeWatcher in order to run Node apps while watching, transpiling and copying files.

public

This service provides a simple interface for watching targets using watchpack.

public

This service watches directories in order to copy and/or transpile files into their build/distribution directories when they change.

public

Manages the transpilation of target files using Babel.

public

This service works as a helper to generate TypeScript binary commands.

public

This service uses the project configuration settings in order manage the project version.

public

This is the main "bridge service" for building: It connects the rest of the building services and perform most of the "building-related tasks".

public

The service provider that once registered on the app container will set an instance of BuildCleaner as the buildCleaner service.

public

The service provider that once registered on the app container will set an instance of BuildCopier as the buildCopier service.

public

The service provider that once registered on the app container will set an instance of BuildEngines as the buildEngines service.

public

The service provider that once registered on the app container will set an instance of BuildNodeRunner as the buildNodeRunner service.

public

The service provider that once registered on the app container will set an instance of BuildNodeRunnerProcess as the buildNodeRunnerProcess service.

public

The service provider that once registered on the app container will set an instance of BuildNodeWatcher as the buildNodeWatcher service.

public

The service provider that once registered on the app container will set an instance of BuildNodeWatcherProcess as the buildNodeWatcherProcess service.

public

The service provider that once registered on the app container will set an instance of BuildTranspiler as the buildTranspiler service.

public

The service provider that once registered on the app container will set an instance of BuildTypeScriptHelper as the buildTypeScriptHelper service.

public

The service provider that once registered on the app container will set an instance of BuildVersion as the buildVersion service.

public

The service provider that once registered on the app container will set an instance of Builder as the builder service.

services/cli

summary
public

C CLI

The main CLI program interface where all the commands are registered and that works as a bridge between the app and commander.

public

This is a fake command the app uses to show the information of the analyze task.

public

This is a fake command the app uses to show the information of the build task.

public

This is the command used on the CLI interface to remove a target file(s) or the entire distribution directory.

public

This is the command used on the CLI interface to copy the project files to the distribution directory.

public

This commands allows the user to generate new projext resources by makeing use of "generators", which are subclasses of CLISubCommand.

public

This is the command used on the CLI to show the contents of the project configuration.

public

This is a fake command the app uses to show the information of the inspect task.

public

This is the command used on the CLI interface to create the revision file.

public

This is a fake command the app uses to show the information of the run task.

public

This is the 'real analyze command'.

public

This is the 'real build command'.

public

This is a private command the shell script executes in order to copy a target files.

public

This is the 'real inspect command'.

public

This is a private command the shell script executes in order to run a Node target with nodemon.

public

This is a private command the shell script executes in order to watch a Node target with watchpack.

public

This is the 'real run command'.

public

This is a private command the shell script executes in order to transpile a target.

public

This is a private command the shell script executes before running the analyze command in order to validate the arguments and throw any necessary error.

public

This is a private command the shell script executes before running the build command in order to validate the arguments and throw any necessary error.

public

This is a private command the shell script executes before running the inspect command in order to validate the arguments and throw any necessary error.

public

This is a private command the shell script executes before running the run command in order to validate the arguments and throw any necessary error.

public

This is a private command the shell script executes before running the watch command in order to validate the arguments and throw any necessary error.

public

This is the 'real watch command'.

public

This is a fake command the app uses to show the information of the watch task.

public

Generates a Provider with an already defined name for the program.

public

The service provider that once registered on the app container will set an instance of CLI as the cli service.

public

The service provider that once registered on the app container will set an instance of CLIAnalyzeCommand as the cliAnalyzeCommand service.

public

The service provider that once registered on the app container will set an instance of CLIBuildCommand as the cliBuildCommand service.

public

The service provider that once registered on the app container will set an instance of CLICleanCommand as the cliCleanCommand service.

public

The service provider that once registered on the app container will set an instance of CLICopyProjectFilesCommand as the cliCopyProjectFilesCommand service.

public

The service provider that once registered on the app container will set an instance of CLIGenerateCommand as the cliGenerateCommand service.

public

The service provider that once registered on the app container will set an instance of CLIInfoCommand as the cliInfoCommand service.

public

The service provider that once registered on the app container will set an instance of CLIInspectCommand as the cliInspectCommand service.

public

The service provider that once registered on the app container will set an instance of CLIRevisionCommand as the cliRevisionCommand service.

public

The service provider that once registered on the app container will set an instance of CLIRunCommand as the cliRunCommand service.

public

The service provider that once registered on the app container will set an instance of CLISHAnalyzeCommand as the cliSHAnalyzeCommand service.

public

The service provider that once registered on the app container will set an instance of CLISHBuildCommand as the cliSHBuildCommand service.

public

The service provider that once registered on the app container will set an instance of CLISHCopyCommand as the cliSHCopyCommand service.

public

The service provider that once registered on the app container will set an instance of CLISHInspectCommand as the cliSHInspectCommand service.

public

The service provider that once registered on the app container will set an instance of CLISHNodeRunCommand as the cliSHNodeRunCommand service.

public

The service provider that once registered on the app container will set an instance of CLISHNodeWatchCommand as the cliSHNodeWatchCommand service.

public

The service provider that once registered on the app container will set an instance of CLISHRunCommand as the cliSHRunCommand service.

public

The service provider that once registered on the app container will set an instance of CLISHTranspileCommand as the cliSHTranspileCommand service.

public

The service provider that once registered on the app container will set an instance of CLISHValidateAnalyzeCommand as the cliSHValidateAnalyzeCommand service.

public

The service provider that once registered on the app container will set an instance of CLISHValidateBuildCommand as the cliSHValidateBuildCommand service.

public

The service provider that once registered on the app container will set an instance of CLISHValidateInspectCommand as the cliSHValidateInspectCommand service.

public

The service provider that once registered on the app container will set an instance of CLISHValidateRunCommand as the cliSHValidateRunCommand service.

public

The service provider that once registered on the app container will set an instance of CLISHValidateWatchCommand as the cliSHValidateWatchCommand service.

public

The service provider that once registered on the app container will set an instance of CLISHWatchCommand as the cliSHWatchCommand service.

public

The service provider that once registered on the app container will set an instance of CLIWatchCommand as the cliWatchCommand service.

services/cli/generators

summary
public

This is a CLI generator that allows the user to create a configuration file with all the default settings and all the information projext assumes about the project.

public

This is a CLI generator that allows the user to create an HTML file for a browser target.

public

The service provider that once registered on the app container will set an instance of ProjectConfigurationFileGenerator as the projectConfigurationFileGenerator service.

public

The service provider that once registered on the app container will set an instance of TargetHTMLGenerator as the targetHTMLGenerator service.

services/common

summary
public

A set of utilities to easily modify a Babel configuration.

public

A simple class with only one static method that removes items from directories.

public

C Copier

A service to copy items.

public

A utility class/service to work with .env files for environment variables.

public

C Events

A simple events hub to manage the app events.

public

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

public

C Prompt

This services works as an abstraction of the prompt package in order to add support for Promises, fix some quirks regarding boolean options, customize the interface just once and, finally, integrate it withe Jimple.

public

A utility service to read, write and delete temporary files.

public

C Utils

A set of generic utilities that can be used in any context.

public

A set of utilities to work with the version of the project.

public

F plugins(prefix: string): Provider

Generate a Provider with an already defined prefix for the plugins.

public

F promptWithOptions(messagesPrefix: string): Provider

Generates a Provider with an already defined message prefix.

public

F tempFilesCustom(directory: string, locationName: string, serviceName: string): Provider

Generates a Provider with a custom directory and/or location name for the temp directory.

public

The service provider that once registered on the app container will set a reference of BabelHelper as the babelHelper service.

public

The service provider that once registered on the app container will set Cleaner.clean as the cleaner service.

public

The service provider that once registered on the app container will set Copier.copy as the copier service.

public

The service provider that once registered on the app container will set an instance of DotEnvUtils as the dotEnvUtils service.

public

The service provider that once registered on the app container will set an instance of Events as the events service.

public

The service provider that once registered on the app container will set an instance of Prompt as the appPrompt service.

public

The service provider that once registered on the app container will set an instance of Prompt as the prompt service.

public

The service provider that once registered on the app container will set an instance of TempFiles as the tempFiles service.

public

The service provider that once registered on the app container will set a reference of Utils as the utils service.

public

The service provider that once registered on the app container will set an instance of VersionUtils as the versionUtils service.

public

services/configurations

summary
public

This service is in charge of creating Babel configurations for targets.

public

Here's the configuration with all the 'magic defaults' the app uses. This service generates the project configuration with all settings and features projext uses. This configuration is ALWAYS overwritten and extended in order to define the targets.

public

This is a 'tricky' service as it only exists to be overwritten.

public

The service provider that once registered on the app container will set an instance of BabelConfiguration as the babelConfiguration service.

public

The service provider that once registered on the app container will set an instance of ProjectConfiguration as the projectConfiguration service.

public

The service provider that once registered on the app container will set an function to get instance of TargetConfiguration as the targetConfiguration service.

services/targets

summary
public

This service is in charge of loading and managing the project targets information.

public

This is used to find targets information on an specific directory.

public

This service allows the validation of a BrowserTarget html.template file and it also takes care of generating a "default template" if the one on the target settings doesn't exist.

public

The service provider that once registered on the app container will set an instance of Targets as the targets service.

public

The service provider that once registered on the app container will create an instance of TargetsFinder and set its find method as the targetsFinder service.

public

The service provider that once registered on the app container will create an instance of TargetsHTML and set it as the targetsHTML service.

services/targets/targetsFileRules

summary
public

Helper service used by TargetsFileRules in order to create dynamic file rules for multiple purposes.

public

This service is intended as a helper for plugins or build engines that need to find targets files by creating a set of "rules" for the basic type of files projext manages: JS, SCSS, CSS, fonts, images and favicons.

public

The service provider that once registered on the app container will set an instance of TargetsFileRules as the targetsFileRules service.