Typedef

This will tell projext which build engine you are going to bundle the target code with.

Whether your target code is on a sub folder of the source directory (src/[target-name]/) or the contents of the source directory are your target code (useful when working with a single target).

Whether or not to create a folder for your targets code on the distribution directory when the target is bundled/copied.

If either hasFolder or createFolder is true, this can be used to specify a different folder name than the target's name.

The target entry files for each specific build type.

The target output settings for each specific build type.

The target output settings for each specific build type, without the placeholders replaced.

The target source map settings for each specific environment build.

In the case the target is an app, these are the options for the html file that will include the bundle <script />; and if your target is a library, this can be used to test your library.

These options help you customize the way the bundling process handles your CSS code.

This setting can be used to specify a list of node modules you want to process on your bundle. This means that JS files from modules on this list will be transpiled.

This setting can be used to specify a list of other targets you want to process on your bundle. This means that JS and SCSS files from these targets will be transpiled/processed.

When a bundle is created, this setting will tell the build engine whether to uglify the code for production or not.

This will tell the build engine that when you build the target for a development environment, it should bring up an http server to "run" your target.

The settings for the projext watch mode, which watches the target files for changes and updates the build without executing it.

These options are used by the build engine to configure Babel:

Whether or not your target uses flow. This will update the Babel configuration in order to add support for it.

Whether or not your target uses TypeScript. This will update the Babel configuration in order to add support for it.

This will tell the build engine that it needs to be builded as a library to be required.

In case library is true, these options are going to be used by the build engine to configure your library.

Whether or not to remove all code from previous builds from the distribution directory when making a new build.

A list of files to copy during the bundling process. It can be a list of file paths relative to the target source directory, in which case they'll be copied to the target distribution directory root; or a list of ProjectConfigurationTargetTemplateCopyItem.

These options are used by both projext and the build engine in order to load "environment files".

These are the options for the http server projext will use when running the target on a development environment.

These are the settings for the feature that allows a browser target to have a dynamic configuration file.

To check whether the target type is node or browser

The target absolute paths to both the source directory folder and the distribution directory folder.

The target relative paths to both the source directory folder and the distribution directory folder.

The method used by projext in order to get the shell comands to build and/or run a target.

The target information.

The intended build type: development or production.

• optional
• default: false

Force the target to run even if the runOnDevelopment setting is false.

• optional
• default: false

Force the build engine to watch the target files even if the watch setting for the required build type is set to false.

• optional
• default: false

Force the build engine to use the Node inspector even if the target setting is disabled. This only applies for Node targets.

Whether or not the intended build type is development.

Whether or not the target needs to be executed.

Whether or not the target files will be watched.

Whether or not to enable the Node inspector.

The intended build type: development or production.

Whether or not the target needs to be executed.

Whether or not the target files will be watched.

Whether or not to enable the Node inspector.

The target information.

The intended build type: development or production.

Whether or not the target needs to be executed.

Whether or not a build will be created. This is always true for browser targets but it may be false for Node targets if bundling and transpiling is disabled.

Whether or not the target files will be watched.

Whether or not to enable the Node inspector.

Whether or not to enable the Node inspector.

The host where the Node inspector will run.

The port where the Node inspector will run.

The Node inspector flag command (inspect or inspect-brk).

Whether or not to use Google's ndb instead of the native inspector. The way it will be used will be by calling the executable without path, so it's up to the project to install it (global or local).

Whether or not the target needs to be bundled. If the value is false, when running on a development environment, and if the target doesn't need transpilation, the code won't be moved to the distribution directory.

This option is kind of tied to the previous one: You may not want to bundle your Node target, but you can transpile it with Babel if you want to use a feature not yet supported by the runtime.

In case bundle is true, this will tell projext which build engine you are going to bundle the target code with.

Whether your target code is on a sub folder of the source directory (src/[target-name]/) or the contents of the source directory are your target code (useful when working with a single target).

Whether or not to create a folder for your targets code on the distribution directory when the target is bundled/copied.

If either hasFolder or createFolder is true, this can be used to specify a different folder name than the target's name.

The target entry files for each specific build type.

The target output settings for each specific build type.

The target output settings for each specific build type, without the placeholders replaced.

The target source map settings for each specific environment build.

The target settings for the Node inspector.

These options help you customize the way the bundling process handles your CSS code.

This setting can be used to specify a list of node modules you want to process on your bundle. This means that JS files from modules on this list will be transpiled.

This setting can be used to specify a list of modules that should never be bundled. By default, projext will exclude all the dependencies from the package.json, but if you import modules using a sub path (like colors/safe instead of colors), you need to specify it on this list so the build engine won't try to put it inside the bundle it.

This setting can be used to specify a list of other targets you want to process on your bundle. This means that JS and SCSS files from these targets will be transpiled/processed.

This tells projext that when the target is builded (bundled/copied) on a development environment, it should execute it.

The settings for the projext watch mode, which watches the target files for changes and updates the build without executing it.

The target transpilation options.

Whether or not your target uses flow. This will update the Babel configuration in order to add support and, in case it was disabled, enable transpilation.

Whether or not your target uses TypeScript. This will update the Babel configuration in order to add support and, in case it was disabled, enable transpilation.

If the project is bundled, this will tell the build engine that it needs to be builded as a library to be required.

In case library is true, these options are going to be used by the build engine to configure your library

Whether or not to remove all code from previous builds from the distribution directory when making a new build.

A list of files to copy during the bundling process. It can be a list of file paths relative to the target source directory, in which case they'll be copied to the target distribution directory root; or a list of ProjectConfigurationTargetTemplateCopyItem.

To check whether the target type is node or browser

The target absolute paths to both the source directory folder and the distribution directory folder.

The target relative paths to both the source directory folder and the distribution directory folder.

These options are used by both projext and the build engine in order to load "environment files".

• optional
• default: 'webpack'

This will tell projext which build engine you are going to bundle the target code with.

• optional
• default: true

Whether your target code is on a sub folder of the source directory (src/[target-name]/) or the contents of the source directory are your target code (useful when working with a single target).

• optional
• default: true

Whether or not to create a folder for your targets code on the distribution directory when the target is bundled/copied.

• optional
• default: ''

If either hasFolder or createFolder is true, this can be used to specify a different folder name than the target's name.

• optional

The target entry files for each specific build type.

• optional

The target output settings for each specific build type.

• optional

The target source map settings for each specific environment build.

• optional

In the case the target is an app, these are the options for the html file that will include the bundle <script />; and if your target is a library, this can be used to test your library.

• optional

These options help you customize the way the bundling process handles your CSS code.

• optional
• default: []

This setting can be used to specify a list of node modules you want to process on your bundle. This means that JS files from modules on this list will be transpiled.

• optional
• default: []

This setting can be used to specify a list of other targets you want to process on your bundle. This means that JS and SCSS files from these targets will be transpiled/processed.

• optional
• default: true

When a bundle is created, this setting will tell the build engine whether to uglify the code for production or not.

• optional
• default: false

This will tell the build engine that when you build the target for a development environment, it should bring up an http server to "run" your target.

• optional

The settings for the projext watch mode, which watches the target files for changes and updates the build without executing it.

• optional

These options are used by the build engine to configure Babel:

• optional
• default: false

Whether or not your target uses flow. This will update the Babel configuration in order to add support for it.

• optional
• default: false

Whether or not your target uses TypeScript. This will update the Babel configuration in order to add support for it.

• optional
• default: false

This will tell the build engine that it needs to be builded as a library to be required.

• optional

In case library is true, these options are going to be used by the build engine to configure your library.

• optional
• default: true

Whether or not to remove all code from previous builds from the distribution directory when making a new build.

• optional
• default: []

A list of files to copy during the bundling process. It can be a list of file paths relative to the target source directory, in which case they'll be copied to the target distribution directory root; or a list of ProjectConfigurationTargetTemplateCopyItem.

• optional

These options are used by both projext and the build engine in order to load "environment files".

• optional

These are the options for the http server projext will use when running the target on a development environment.

• optional

These are the settings for the feature that allows a browser target to have a dynamic configuration file.

• optional

This object can be used to enable/disable the Babel plugins projext includes. If you need other plugins, they can be included on the overwrites option.

• optional
• default: 2

When building the Babel configuration, projext uses the @babel/preset-env to just include the necessary stuff. This setting tells how many old versions of the major browsers the target needs transpilation for. Major browsers: Firefox, Chrome, Safari and Edge.

• optional
• default: true

If true, the configuration will add to the list of major browsers iOS and Android.

• optional
• default: true

Whether or not the configuration for the @babel/preset-env should include the settings for for useBuiltIns and corejs.

• optional
• default: {}

If you know how to use Babel and need stuff that is not covered by projext, you can use this setting to overwrite/add any value you may need.

• optional
• default: {}

Custom settings that projext will use as base when generating the ones for the @babel/preset-env.

• optional
• default: false

Whether or not your application uses CSS Modules. If this is enabled, all your styles will be prefixed with a unique identifier.

• optional
• default: false

If this setting is set to true, instead of generating a CSS file with your styles, they'll be dynamically injected on HTML when the bundle gets executed.

• optional
• default: false

Whether or not the feature is enabled.

• optional
• default: null

The default configuration. If none is specified, when the target is builded, it will try to use [target-name].config.js, located on the configuration folder.

• optional
• default: 'config/'

The path where the configuration files are located.

• optional
• default: true

Whether or not there's a folder with the target name on the configuration path.

• optional
• default: 'process.env.CONFIG'

The name of the variable where the configuration is going to be replaced on your code when bundled.

• optional
• default: 'CONFIG'

The name of the environment variable projext will check when building the target in order to load a dynamic configuration.

• optional
• default: true

Whether or not projext should check for the environment variable value.

• optional
• default: '[target-name].[configuration-name].config.js'

The name format of the configuration files.

• optional
• default: false

Whether or not the dev server is being proxied.

• optional
• default: null
• nullable: true

The host used to proxy the dev server. If null, it will use the host defined on the dev server main settings.

• optional
• default: null
• nullable: true

Whether or not the proxied host uses https. If null and you have provided SSL certificates for the server, it will become true, otherwise it will be false.

• optional
• default: null

The path to the SSL key (.key).

• optional
• default: null

The path to the SSL certificate (.crt).

• optional
• default: null

The path to the SSL public file (.pem).

• optional
• default: 2509

The server port.

• optional
• default: true

Whether or not to reload the browser when the code changes.

• optional
• default: true

Whether or not to open the browser when server is ready.

• optional
• default: 'localhost'

The dev server hostname.

• optional

The paths to the files to enable SSL on the dev server.

• optional

When the dev server is being proxied (using nginx for example), there are certain functionalities, like hot module replacement and live reload that need to be aware of this.

• optional
• default: 'index.html'

This setting can be used to set the same value of default template and filename at once. But it will only overwrite settings with a null value, if one is specified, the value of this setting will be ignored.

• optional
• default: null

The file inside your target source that will be used to generate the html. If null, it will fallback to the value of the default setting.

• optional
• default: null

The file that will be generated when your target is bundled. It will automatically include the <script /> tag to the generated bundle. If null, it will fallback to the value of the default setting.

• optional
• default: 'umd'

How the library will be exposed: commonjs2, umd or window.

• optional
• default: false

Whether or not to use gzip compression on the generated library file.

• optional
• default: false

Whether or not the feature is enabled.

• optional
• default: []

A list of files and/or directories that will be copied. All with paths relative to the project directory.

• optional

Since the feature is also available through the projext CLI, you can configure how the feature behaves when building.

• optional
• default: true

Whether or not the feature should be triggered when a target is being build.

• optional
• default: true

This tells projext if the feature should be triggered only when building for production, or if it should do it for development too.

• optional
• default: []

This can be used to specify the targets that will trigger the feature when builded. If no target is specified, the feature will be triggered by all the targets.

• optional
• default: false

Whether or not to enable the Node inspector when running the app for development.

• optional
• default: '0.0.0.0'

The host where the Node inspector will run.

• optional
• default: 9229

The port the Node inspector will use.

• optional
• default: 'inspect'

The Node inspector flag command (inspect or inspect-brk).

• optional
• default: false

Whether or not to use Google's ndb instead of the native inspector. The way it will be used will be by calling the executable without path, so it's up to the project to install it (global or local).

• optional
• default: false

Whether or not the target needs to be bundled. If the value is false, when running on a development environment, and if the target doesn't need transpilation, the code won't be moved to the distribution directory.

• optional
• default: false

This option is kind of tied to the previous one: You may not want to bundle your Node target, but you can transpile it with Babel if you want to use a feature not yet supported by the runtime.

• optional
• default: 'webpack'

In case bundle is true, this will tell projext which build engine you are going to bundle the target code with.

• optional
• default: true

Whether your target code is on a sub folder of the source directory (src/[target-name]/) or the contents of the source directory are your target code (useful when working with a single target).

• optional
• default: true

Whether or not to create a folder for your targets code on the distribution directory when the target is bundled/copied.

• optional
• default: ''

If either hasFolder or createFolder is true, this can be used to specify a different folder name than the target's name.

• optional

The target entry files for each specific build type.

• optional

The target output settings for each specific build type.

• optional

The target source map settings for each specific environment build.

• optional

The target settings for the Node inspector.

• optional

These options help you customize the way the bundling process handles your CSS code.

• optional
• default: []

This setting can be used to specify a list of node modules you want to process on your bundle.

• optional
• default: []

This setting can be used to specify a list of modules that should never be bundled. By default, projext will exclude all the dependencies from the package.json, but if you import modules using a sub path (like colors/safe instead of colors), you need to specify it on this list so the build engine won't try to put it inside the bundle it.

• optional
• default: []

This setting can be used to specify a list of other targets you want to process on your bundle. This means that JS and SCSS files from these targets will be transpiled/processed.

• optional
• default: false

This tells projext that when the target is builded (bundled/copied) on a development environment, it should execute it.

• optional

The settings for the projext watch mode, which watches the target files for changes and updates the build without executing it.

• optional

The target transpilation options.

• optional
• default: false

Whether or not your target uses flow. This will update the Babel

• optional
• default: false

Whether or not your target uses TypeScript. This will update the Babel configuration in order to add support and, in case it was disabled, enable transpilation.

• optional
• default: false

If the project is bundled, this will tell the build engine that it needs to be builded as a library to be required.

• optional

In case library is true, these options are going to be used by the build engine to configure your library

• optional
• default: true

Whether or not to remove all code from previous builds from the distribution directory when making a new build.

• optional
• default: []

A list of files to copy during the bundling process. It can be a list of file paths relative to the target source directory, in which case they'll be copied to the target distribution directory root; or a list of ProjectConfigurationTargetTemplateCopyItem.

• optional

These options are used by both projext and the build engine in order to load "environment files".

• optional

This object can be used to enable/disable the Babel plugins projext includes. If you need other plugins, they can be included on the overwrites option.

• optional
• default: 'current'

When building the Babel configuration, projext uses the @babel/preset-env to just include the necessary stuff. This setting tells the preset the version of Node it should "complete".

• optional
• default: {}

Custom settings that projext will use as base when generating the ones for the @babel/preset-env.

• optional
• default: {}

If you know how to use Babel and need stuff that is not covered by projext, you can use this setting to overwrite/add any value you may need.

• optional
• default: false

Whether or not your application uses CSS Modules. If this is enabled, all your styles will be prefixed with a unique identifier.

• optional
• default: 'commonjs2'

How the library will be exposed: commonjs2 or umd.

• optional
• default: true

Whether or not to enable nodemon legacy watch mode.

are the settings for projext "targets finder", the feature that reads the project in order to identify targets and their settings.

is used by projext to configure watchpack, which is used to watch Node files that need to be transpiled.

is used by projext to configure nodemon, which is used to execute and watch Node targets.

• optional
• default: 'src'

The directory, relative to your project path, where your targets code is located. On the documentation is often referred as the "source directory".

• optional
• default: 'dist'

The directory, relative to your project path, where your targets bundled code will be located. On the documentation is often referred as the "distribution directory".

• optional
• default: 'private'

This is for the feature that copies when bundling. In case you are using the feature to copy an npm module that, let's say, is not published, projext will save that module (without its dependencies) on that folder.

• optional

This setting is all about where your code is located and where it will be bundled

• optional

There was no way to have "smart defaults" for targets and at the same time allow projext an unlimited amount of targets, and that's why the this setting exists. The targets will extend the template which name is the same as their type property.

This will be a dictionary with the Target definitions.

• optional

These settings are for the feature that enables projext to copy files when building targets.

• optional

These settings are for the feature that manages your project version.

• optional

Miscellaneous options.

• optional
• default: true

Whether or not to automatically search for targets on the project folders.

• optional
• default: false

This enables @babel/plugin-proposal-class-properties so the targets can use classes with properties.

• optional
• default: false

This enables @babel/plugin-proposal-decorators so the targets can use decorators (based on the current TC39 proposal).

• optional
• default: true

This enables @babel/plugin-syntax-dynamic-import so the targets can do dynamic imports and code splitting.

• optional
• default: true

This enables @babel/plugin-proposal-object-rest-spread so the targets can use rest and spread with objects.

The path to the file, relative to the target source directory.

• nullable: true

The path where the file will be copied, relative to the target distribution directory. If not specified, the file will be copied to the root of the target distribution directory.

• optional
• default: 'index.js'

The target entry file for all types of build that don't have a specified entry.

• optional
• default: null

The target entry file on a development build. If null, it will fallback to the one specified on default.

• optional
• default: null

The target entry file on a production build. If null, it will fallback to the one specified on default.

• optional

The target output settings for all types of build that don't have specified settings.

• optional

The target output settings on a development build. If null, it will fallback to the ones specified on default.

• optional

The target output settings on a production build. If null, it will fallback to the ones specified on default.

• optional

The path to generated Javascript files on the distribution directory.

The available placeholders are:

• [target-name]: The name of the target.
• [hash]: A random hash generated for cache busting.

The default value is:

• For node targets, on all build types: [target-name].js.
• For browser targets:
  • development: 'statics/js/[target-name].js'.
  • production: 'statics/js/[target-name].[hash].js'.

• optional

The path to generated stylesheets on the distribution directory.

The available placeholders are:

• [target-name]: The name of the target.
• [hash]: A random hash generated for cache busting.

The default value is, for both node and browser targets:

• development: 'statics/styles/[target-name].css'.
• production: 'statics/styles/[target-name].[hash].css'.

• optional

The path to font files once they are copied to the distribution directory.

The available placeholders are:

• [target-name]: The name of the target.
• [name]: The file original name.
• [ext]: The file original extension.
• [hash]: A random hash generated for cache busting.

The default value is, for both node and browser targets:

• development: 'statics/fonts/[name]/[name][ext]'.
• production: 'statics/fonts/[name]/[name].[hash].[ext]'.

• optional

The path to image files once they are copied to the distribution directory.

The available placeholders are:

• [target-name]: The name of the target.
• [name]: The file original name.
• [ext]: The file original extension.
• [hash]: A random hash generated for cache busting.

The default value is, for both node and browser targets:

• development: 'statics/images/[name][ext]'.
• production: 'statics/images/[name].[hash].[ext]'.

• optional
• default: false

Whether or not to generate a source map on a development build.

• optional
• default: true

Whether or not to generate a source map on a production build.

• optional

The template settings for all targets with the type node.

• optional

The template settings for all targets with the type browser.

• optional
• default: false

Whether or not to watch the target files when it gets build for development. If the target type is Node and it doesn't require bundling nor transpiling, it won't do anything.

• optional
• default: false

Whether or not to watch the target files when it gets build for production.

• optional
• default: false

Whether or not the revision file feature is enabled.

• optional
• default: true

Whether or not to copy the revision file when the project files are being copied to the distribution directory.

• optional
• default: 'revision'

The name of the revision file.

• optional

Since the feature is also available through the projext CLI, you can configure how the feature behaves when building.

• optional
• default: 'process.env.VERSION'

The name of the variable where the version is going to be replaced on your code when bundled.

• optional
• default: 'VERSION'

The name of the environment variable projext should check to get the project version.

• optional

This is like a sub-feature. A revision file is a file that contains the version of your project. This is useful when deploying the project to an environment where you have no access to the environment variable.

The way the revision file works is by first checking if the environment variable is available and, if not, it will check if the project is on a GIT repository and try to get the hash of the last commit.

• optional
• default: true

Whether or not to use polling to get the changes on the file system, and if so, it can also be used to specify the ms interval.

The method that gets called by projext when registering the provider.

A reference to the projext dependency injection container.

The path to the file that can create the configuration.

The configuration service that will be extended.

The value of the <title /> tag.

Extra attributes for the <body /> tag.

The content of the <body /> tag.

The file origin path.

The file destination path.

• nullable: true

A custom function to modify the contents of the file to copy.

The original contents of the file.

The list of expressions that match the allowed files for a rule.

The list of expressions that match the files that should be excluded from a rule.

The settings for files but on glob pattern version. For plugins and libraries that don't support, or maybe prefer glob over, expressions.

The list of glob patterns that match the allowed files for a rule.

The list of glob patterns that match the files that should be excluded from a rule.

The target information.

Whether or not the rule already has a target, or if this is the first one being added.

The current settings of the rule.

The list of expressions that match the allowed paths for a rule.

The list of expressions that match the paths that should be excluded from a rule.

A expression that validates the extension(s) the rule is for.

A glob pattern that validates the extension(s) the rule is for.

A set of allowed and excluded expressions to validate the paths where the files can be found.

A set of allowed and excluded expressions and glob patterns for files that would match with the rule.

The rule for JS files.

The rule for SCSS files.

The rule for CSS files.

The rules for font files.

The rule for image files.

The rule for favicon files.

The relative path to the target source directory.

The relative path to the folder, inside the distribution directory, where the target will be bundled/copied.

The rule for all font files that aren't SVG.

The rule for SVG fonts.

The absolute path to the target source directory.

The absolute path to the folder, inside the distribution directory, where the target will be bundled/copied.

Whether the target type is node or not.

Whether the target type is browser or not.

The current options of the env preset.