src/typedef.js
/**
* @external {Jimple}
* https://yarnpkg.com/en/package/jimple
*/
/**
* @external {Jimpex}
* https://yarnpkg.com/en/package/jimpex
*/
/**
* @external {Express}
* https://expressjs.com
*/
/**
* @external {FileSystem}
* https://nodejs.org/api/fs.html
*/
/**
* @external {PathUtils}
* https://homer0.github.io/wootils/class/wootils/node/pathUtils.js~PathUtils.html
*/
/**
* @external {Logger}
* https://homer0.github.io/wootils/class/wootils/node/logger.js~Logger.html
*/
/**
* @external {EnvironmentUtils}
* https://homer0.github.io/wootils/class/wootils/node/environmentUtils.js~EnvironmentUtils.html
*/
/**
* @external {ErrorHandler}
* https://homer0.github.io/wootils/class/wootils/node/errorHandler.js~ErrorHandler.html
*/
/**
* @external {RootRequire}
* https://homer0.github.io/wootils/function/index.html#static-function-rootRequire
*/
/**
* @external {Projext}
* https://homer0.github.io/projext/class/src/app/index.js~Projext.html
*/
/**
* @external {BuildVersion}
* https://homer0.github.io/projext/class/src/services/building/buildVersion.js~BuildVersion.html
*/
/**
* @external {Events}
* https://homer0.github.io/projext/class/src/services/common/events.js~Events.html
*/
/**
* @external {Targets}
* https://homer0.github.io/projext/class/src/services/targets/targets.js~Targets.html
*/
/**
* @external {TargetsFileRules}
* https://homer0.github.io/projext/class/src/services/targets/targetsFileRules/targetsFileRules.js~TargetsFileRules.html
*/
/**
* @external {TargetFileRules}
* https://homer0.github.io/projext/typedef/index.html#static-typedef-TargetFileRules
*/
/**
* @external {TargetsHTML}
* https://homer0.github.io/projext/class/src/services/targets/targetsHTML.js~TargetsHTML.html
*/
/**
* @external {Target}
* https://homer0.github.io/projext/typedef/index.html#static-typedef-Target
*/
/**
* @external {TargetExtraFile}
* https://homer0.github.io/projext/typedef/index.html#static-typedef-TargetExtraFile
*/
/**
* @external {TargetConfigurationCreator}
* https://homer0.github.io/projext/typedef/index.html#static-typedef-TargetConfigurationCreator
*/
/**
* @external {ProjectConfigurationSettings}
* https://homer0.github.io/projext/typedef/index.html#static-typedef-ProjectConfigurationSettings
*/
/**
* @external {NodeInspectorSettings}
* https://homer0.github.io/projext/typedef/index.html#static-typedef-NodeInspectorSettings
*/
/**
* @external {BabelConfiguration}
* https://homer0.github.io/projext/class/src/services/configurations/babelConfiguration.js~BabelConfiguration.html
*/
/**
* @external {Middleware}
* http://expressjs.com/en/guide/using-middleware.html
*/
/**
* @external {ChildProcess}
* https://nodejs.org/api/child_process.html#child_process_class_childprocess
* @ignore
*/
/**
* @typedef {function} DevMiddlewareGetDirectory
* @return {string}
* The build directory of the target implementing the dev middleware.
*/
/**
* @typedef {function} DevMiddlewareGetFileSystem
* @return {Promise<FileSystem,Error>}
* The reason this is resolved on a promise is to avoid trying to accessing files before they are
* generated.
*/
/**
* @typedef {Object} MiddlewaresInformation
* @property {Array} middlewares
* A list of functions that when executed return a Node middleware.
* @property {DevMiddlewareGetDirectory} getDirectory
* To access the target implementing the middleware build directory.
* @property {DevMiddlewareGetFileSystem} getFileSystem
* To access the webpack dev middleware _"virtual filesystem"_.
*/
/**
* @typedef {Object} WebpackConfigurationsByEnvironment
* @property {ConfigurationFile} production
* The configuration service for a the target type production build.
* @property {ConfigurationFile} development
* The configuration service for a the target type development build.
*/
/**
* @typedef {Object} WebpackConfigurations
* @property {WebpackConfigurationsByEnvironment} node
* The build types configurations for a Node target.
* @property {WebpackConfigurationsByEnvironment} browser
* The build types configurations for a browser target.
*/
/**
* @typedef {Object} WebpackConfigurationTargetOutput
* @property {string} js
* The filename format and path for the bundle, on the distribution directory.
* @property {string} css
* The filename format and path for the generated stylesheet, on the distribution directory.
* @property {string} images
* The filename format and path for the images that are going to be copied to the distribution
* directory.
* @property {string} fonts
* The filename format and path for the font files that are going to be copied to the distribution
* directory.
*/
/**
* @typedef {Object} WebpackPluginInfo
* @property {string} name The name of the plugin.
* @property {string} configuration The path to the `webpack.config.js` file.
* @property {Array} external The list of subpaths the plugin exposes and that should be
* handled as external dependencies, in order to avoid bundling
* them.
*/
/**
* @typedef {Object} WebpackConfigurationParams
* @property {Target} target
* The target information.
* @property {TargetFileRules} targetRules
* The rules to find the different file types a target may use.
* @property {Object} entry
* A dictionary with the `entry` setting for a webpack configuration, generated with the target
* information.
* @property {WebpackConfigurationTargetOutput} output
* A dictionary with the filenames formats and paths of the different files the bundle can
* generate.
* @property {Function():Object} definitions
* A function that generates a dictionary of variables that will be replaced on the bundled code.
* @property {string} buildType
* The intended built type: `development` or `production`.
* @property {Array} copy
* A list of {@link TargetExtraFile} with the information of files that need to be copied during
* the bundling process.
* @property {Array} additionalWatch
* A list of additional paths webpack should watch for in order to restart the bundle.
* @property {boolean} analyze
* Whether or not the target bundle should be analyzed.
*/
/**
* @typedef {Object} TargetDevServerSSLSettings
* @property {string} key
* The path to the SSL key (`.key`).
* @property {string} cert
* The path to the SSL certificate (`.crt`).
* @property {string} ca
* The path to the SSL public file (`.pem`).
*/
/**
* @typedef {Object} TargetDevServerProxiedSettings
* @property {boolean} enabled
* Whether or not the dev server is being proxied.
* @property {string} host
* The host used to proxy the dev server.
* @property {boolean} https
* Whether or not the proxied host uses `https`.
* @property {string} url
* The complete URL being used to proxy the dev server.
*/
/**
* @typedef {Object} TargetDevServerSettings
* @property {number} port
* The server port.
* @property {string} host
* The dev server hostname.
* @property {string} url
* The complete URL for the dev server.
* @property {boolean} reload
* Whether or not to reload the server when the code changes.
* @property {?TargetDevServerSSLSettings} ssl
* The paths to the files to enable SSL on the dev server.
* @property {?TargetDevServerProxiedSettings} [proxied]
* 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.
*/
/**
* @typedef {function} ProviderRegisterMethod
* @param {Jimple} app
* A reference to the dependency injection container.
*/
/**
* @typedef {Object} Provider
* @property {ProviderRegisterMethod} register
* The method that gets called when registering the provider.
*/
/**
* @typedef {Object} ProjextWebpackBundleRunnerOptions
* @property {?string} entry The name of the webpack entry to execute. If not
* specified will fallback to the first one on the list
* provided by webpack.
* @property {?string} name The _"instance name"_, used to register the listeners
* on the webpack event hooks. Its default value is
* `projext-webpack-plugin-bundle-runner`.
* @property {?Logger} logger A custom logger to output the plugin's information
* messages.
* @property {?NodeInspectorSettings} inspect The custom settings for the Node Inspector.
*/
/**
* @typedef {Object} ProjextWebpackOpenDevServerOptions
* @property {boolean} openBrowser Whether or not to open the browser when the bundle is ready.
* Its default value is `true`.
* @property {?string} name The _"instance name"_, used to register the listeners on the
* webpack event hooks.
* Its default value is `projext-webpack-plugin-open-dev-server`.
* @property {?Logger} logger A custom logger to output the plugin's information messages.
*/
/**
* @typedef {Object} ProjextWebpackRuntimeDefinitionsOptions
* @property {?string} name The _"instance name"_, used to register the listeners on the
* webpack event hooks. Its default value is
* `projext-webpack-plugin-runtime-definitions`.
*/
