From 67963254d55d5c9ad9b3167a235320f94e1da0b1 Mon Sep 17 00:00:00 2001 From: Sharavanaprasad Date: Fri, 30 Jun 2017 16:12:33 +0530 Subject: [PATCH] RFC for ember-cli to scan optionalDependencies --- text/0000-addons-optionalDependencies.md | 33 +++++------------------- 1 file changed, 7 insertions(+), 26 deletions(-) diff --git a/text/0000-addons-optionalDependencies.md b/text/0000-addons-optionalDependencies.md index 16a0363e846..a237c03ba46 100644 --- a/text/0000-addons-optionalDependencies.md +++ b/text/0000-addons-optionalDependencies.md @@ -2,42 +2,23 @@ # Summary -It should be possible to specify addons in `optionalDependencies` in package.json of an ember-cli project, and the ember-cli should scan optionalDependencies for addons while processing the build so that this addon tree will also be merged with the consuming application's app tree. +It should be possible to specify packages/addons in `optionalDependencies` of the `package.json` of an `ember-cli project`, and ember-cli should scan for packages/addons mentioned in optionalDependencies while processing the build so that such packages/addons could also be included into the consuming application. -The build need not fail asserting "missing dependency" if the dependency specified in optionalDependencies is missing/absent. +The build need not fail asserting "missing dependency" if any of the dependencies specified in optionalDependencies is missing/absent. # Motivation -For users who consume the node packages via `private npm registry`, it is a pain point to install the addons when some of it's nested dependencies is specified with a (https://..) repository URL rather than regular "name" : "version" format. Since the consuming npm registry is private, it might not be possible to make a hit to global npm registry overriding the proxy everytime, for the packages which will never actually be used in production. +In general, the current ember-cli build process will scan for the packages specified in the `dependencies` hash and `devDependencies hash` from the downloaded packages in the node_modules folder, discovers and then includes them into the consuming application. The build is designed to fail if any of the packages specified in these two dependencies hash is missing in the `node_modules` folder. But this procedure may not be sufficient for a variety of cases. -Somehow the developer can preinstall the package(so while running npm install, there will not be a network hit for this package since the package of the same version would already have been installed and available) under local node_modules of the project and use it for development to run tests etc., but at a cost of making an entry in dependencies/devDependencies of package.json of the project for the `ember-cli` to consider it to be included in the consuming application. - -But while taking it to production there is a manual intervention of removing this entry from package.json (otherwise the build is ought to fail, bcoz the package cannot be fetched by private registry resulting ember-cli to throw the assertion - `missing dependecy`) for every commit each one on the project makes which is the real pain point. - -So there could be an option for the developer to include the addons as optionalDependencies and convey ember-cli whether or not to lookup optionalDependencies while processing the build. - -The Build need not fail if there is any package specified in optionalDependencies is missing, since it is only optional and moreover only required for development purpose. This way the developer could have more control over the choice of packages he wishes to use for development and skip for production by giving appropriate commands like `npm install --no-optional`, thereby preventing the installation of packages itself rather than blacklisting in `ember-cli-build.js` which suggests preventing the installed addons sepcifed in the `blacklist` array from merging into the consuming application's app tree. +So there could be an option for the developer to specify packages in optionalDependencies and ember-cli can lookup optionalDependencies while processing the build. The Build need not fail if there is any package specified in optionalDependencies is missing, since it is only optional and moreover may only be required for developmental purposes. This way the developer can have more control over the choice of packages he wishes to use for development and skip for production by giving appropriate commands like `npm install --no-optional`, thereby preventing the installation of packages itself rather than blacklisting in `ember-cli-build.js` which suggests preventing the installed addons sepcifed in the `blacklist` array from being included into the consuming application. # Detailed design +We can tweak ember-cli addon/package discovery process to lookup for optionalDependencies as well and if the package is missing, we can make ember-cli proceed the build without terminating. -There could be an option in ember-cli-build.js so that the user can configure whether or not the ember-cli should lookup the optionalDependencies. - -```js -// ember-cli-build.js -module.exports = { - // ... - addons: { - optionalDependencies: { - development: true, - production: false - } - } -}; -``` # How We Teach This -The guides can mention this as a way to include addons in optionalDependencies, which the user can have a control over whether or not to include the addons specified here in the build processes on various environments(development/production). +This functionality can simply be documented in ember-cli guides to teach. # Alternatives -Add a unified way for the developer to have a control over which dependencies he wants to include/exclude in the build process, to prevent `ember-cli` asserting `missing dependency` also making it available in the consuming application tree depending on the environmental requirements.(development/production). +None.