-
Notifications
You must be signed in to change notification settings - Fork 903
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(scripts): Add custom auto-external configurer for rollup
The existing rollup plugin `rollup-plugin-auto-external` does not handle imports with path in them such as `bootstrap/dist/js/bootstrap`. So creating a simple external configurer that handles such scenarios along with handling scoped packages. This configurer uses the passed in dependencies map and accurately marks npm imports as externals.
- Loading branch information
Showing
4 changed files
with
43 additions
and
119 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,15 @@ | ||
| const fs = require('fs'); | ||
| const path = require('path'); | ||
| const baseRollupConfig = require('./rollup.config.base'); | ||
| const angularJsTemplateLoader = require('../helpers/rollup-plugin-angularjs-template-loader'); | ||
| const autoExternal = require('rollup-plugin-auto-external'); | ||
| const externalConfigurer = require('../helpers/rollup-node-auto-external-configurer'); | ||
|
|
||
| const packageJSON = JSON.parse(fs.readFileSync(path.resolve('package.json'), 'utf8')); | ||
|
|
||
| module.exports = { | ||
| ...baseRollupConfig, | ||
| input: 'src/index.ts', | ||
| output: [{ dir: 'dist', format: 'es', sourcemap: true }], | ||
| plugins: [...baseRollupConfig.plugins, angularJsTemplateLoader({ sourceMap: true }), autoExternal()], | ||
| // `autoExternal` cannot handle paths in import statements, so we need to explicitly add it in `external`. | ||
| external: ['rxjs/operators'], | ||
| plugins: [...baseRollupConfig.plugins, angularJsTemplateLoader({ sourceMap: true })], | ||
| external: externalConfigurer(packageJSON.dependencies), | ||
| }; |
29 changes: 29 additions & 0 deletions
29
packages/scripts/helpers/rollup-node-auto-external-configurer.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| /** | ||
| * `rollup-plugin-auto-external` plugin doesn't handle import statements with paths in them. For example | ||
| * `bootstrap/dist/js/bootstrap` will not be treated as an external. This function is a very simple externals configurer | ||
| * that accepts a map of externals (packages and others) and correctly marks them as externals. | ||
| * | ||
| * The caller can typically pass `packageJSON.dependencies` as `externals`. | ||
| */ | ||
| module.exports = (externals) => { | ||
| return (id) => { | ||
| if (id.startsWith('.') || id.startsWith('/')) { | ||
| return false; | ||
| } | ||
| if (id in externals) { | ||
| return true; | ||
| } | ||
|
|
||
| // Handling imports with paths in them. We split the id by `/` and use either the first part or the first + second | ||
| // part (in case of scoped packages) to verify if it is available in `externals`. | ||
| const packageParts = id.split('/'); | ||
| if (packageParts.length > 1) { | ||
| // If it is a scoped package, then include the second part of the package name. | ||
| const packageIdentifier = id.startsWith('@') ? packageParts[0] + packageParts[1] : packageParts[0]; | ||
|
|
||
| return packageIdentifier in externals; | ||
| } | ||
|
|
||
| return false; | ||
| }; | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters