build: refactor build script #4861
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,136 +1,62 @@ | ||
| const { writeFileSync } = require('fs'); | ||
| const { cp, exec, ls, mkdir, rm } = require('shelljs'); | ||
| const { buildOptimizer } = require('@angular-devkit/build-optimizer'); | ||
| const pkg = require('./package.json'); | ||
|
|
||
| // TODO: | ||
| // - what about sourcemaps? | ||
| // Angular itself has inline sourcemaps. I don't see the point, since you don't have sources | ||
| // on the package. | ||
| // - what about shipping TS for bazel support? | ||
| // I think this isn't needed anymore? | ||
|
There was a problem hiding this comment. Does RxJS still need to ship TS for Bazel support? I thought this wasn't needed anymore. |
||
| // - maybe add a debug flag? | ||
| // Would turn silent off for execs, and print stuff on non-exec things | ||
| // - whats src/Rx.global.js for? | ||
|
|
||
| // Ensure commands are run from __dirname. | ||
| process.chdir(__dirname); | ||
|
|
||
| // Clean directories before building. | ||
| console.log('# Deleting dist dir.') | ||
| rm('-rf', './dist'); | ||
|
|
||
| // Run TS to produce cjs, esm5, esm2015, and typings. | ||
| console.log('# Compiling TypeScript sources.'); | ||
| exec('npm run tsc -- --build ./build-configuration/tsconfig.project.json', { silent: true }); | ||
|
|
||
| // Run BO over esm5 and esm2015 to remove side effects. | ||
| console.log('# Removing side effects from esm5 and esm2015.'); | ||
| const buildOptimizerOptions = { emitSourceMap: false, isSideEffectFree: true }; | ||
| ls('./dist/formats/{esm5,esm2015}/**/*.js').forEach(inputFilePath => { | ||
|
There was a problem hiding this comment. Running Build Optimizer over both ESM5 and ESM2015 should enable tree shaking for both (and prevent rollup/rollup#2415). |
||
| const { content } = buildOptimizer({ inputFilePath, ...buildOptimizerOptions }); | ||
| writeFileSync(inputFilePath, content); | ||
| }); | ||
|
|
||
| // Create UMD bundles, then remove the UMD entry point. | ||
| console.log('# Creating UMD bundles.') | ||
| exec('npm run rollup -- --config ./build-configuration/rollup.config.js', { silent: true }); | ||
| rm('-rf', './dist/**/internal/umd.js'); | ||
|
|
||
| // Add package.json, licenses, and readme. | ||
| console.log('# Adding package metadata.'); | ||
| ['', 'ajax/', 'fetch/', 'operators/', 'testing/', 'webSocket/'].forEach(entryPoint => { | ||
| let entryPointPkg = { | ||
| 'name': `rxjs/${entryPoint.replace('/', '')}`, | ||
| 'main': `../formats/cjs/${entryPoint}index.js`, | ||
| 'module': `../formats/esm5/${entryPoint}index.js`, | ||
| 'es2015': `../formats/esm2015/${entryPoint}index.js`, | ||
| 'typings': `../formats/typings/${entryPoint}index.d.ts`, | ||
| 'sideEffects': false | ||
| }; | ||
|
|
||
| if (entryPoint === '') { | ||
| entryPointPkg = { ...pkg, ...entryPointPkg, name: 'rxjs' }; | ||
| cp('./README.md', `./dist/README.md`); | ||
| } else { | ||
| mkdir(`./dist/${entryPoint}`); | ||
| } | ||
| writeFileSync(`./dist/${entryPoint}package.json`, JSON.stringify(entryPointPkg, undefined, 2)); | ||
| cp('./LICENSE.txt', `./dist/${entryPoint}LICENSE.txt`); | ||
| }); | ||
|
|
||
| console.log('# Done!'); | ||
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,31 @@ | ||
| import { join } from 'path'; | ||
| import { readFileSync } from 'fs'; | ||
| import resolve from 'rollup-plugin-node-resolve'; | ||
| import license from 'rollup-plugin-license'; | ||
| import { terser } from "rollup-plugin-terser"; | ||
|
|
||
| const licenseText = readFileSync(join(__dirname, '../LICENSE.txt')); | ||
| const banner = `/** | ||
| @license | ||
| ${licenseText} | ||
| **/`; | ||
|
|
||
| const generateConfig = (minify = false) => ({ | ||
| input: join(__dirname, '../dist/formats/esm5/internal/umd.js'), | ||
| output: { | ||
| file: join(__dirname, `../dist/bundles/rxjs.umd${minify ? '.min' : ''}.js`), | ||
| format: 'umd', | ||
| name: 'rxjs', | ||
| amd: { id: 'rxjs' }, | ||
| }, | ||
| plugins: [ | ||
| resolve(), | ||
| ...(minify ? [terser()] : []), | ||
| license({ banner }), | ||
| ] | ||
| }); | ||
|
|
||
| export default [ | ||
| generateConfig(), | ||
| generateConfig(true), | ||
| ]; |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,9 @@ | ||
| { | ||
| "extends": "./tsconfig.base.json", | ||
| "composite": true, | ||
| "compilerOptions": { | ||
| "module": "commonjs", | ||
| "target": "es5", | ||
| "outDir": "../dist/formats/cjs" | ||
| } | ||
| } |
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,10 +1,11 @@ | ||
| { | ||
| "extends": "./tsconfig.base.json", | ||
| "composite": true, | ||
| "compilerOptions": { | ||
| "module": "es2015", | ||
| "importHelpers": true, | ||
| "moduleResolution": "node", | ||
| "target": "es2015", | ||
| "outDir": "../dist/formats/esm2015" | ||
| } | ||
| } |
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,10 +1,11 @@ | ||
| { | ||
| "extends": "./tsconfig.base.json", | ||
| "composite": true, | ||
| "compilerOptions": { | ||
| "module": "es2015", | ||
| "importHelpers": true, | ||
| "moduleResolution": "node", | ||
| "target": "es5", | ||
| "outDir": "../dist/formats/esm5" | ||
| } | ||
| } |
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,16 @@ | ||
| { | ||
| "references": [ | ||
| { | ||
| "path": "./tsconfig.cjs.json" | ||
| }, | ||
| { | ||
| "path": "./tsconfig.esm5.json" | ||
| }, | ||
| { | ||
| "path": "./tsconfig.esm2015.json" | ||
| }, | ||
| { | ||
| "path": "./tsconfig.types.json" | ||
| } | ||
| ] | ||
| } |
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,11 +1,12 @@ | ||
| { | ||
| "extends": "./tsconfig.base.json", | ||
| "composite": true, | ||
| "compilerOptions": { | ||
| "module": "es2015", | ||
| "target": "esnext", | ||
| "removeComments": false, | ||
| "declaration": true, | ||
| "declarationDir": "../dist/formats/typings", | ||
| "emitDeclarationOnly": true | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure what to do about sourcemaps. I think the current ones are a bit weird and work only because the TS sourcefiles are bundled. We could inline sourcemaps but I'm not sure if that impacts parsing performance.