-
Notifications
You must be signed in to change notification settings - Fork 12k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(@angular-devkit/build-angular): add Sass file support to experim…
…ental esbuild-based builder
This change adds support for using Sass stylesheets within an application built with the experimental
esbuild-based browser application builder. Global stylesheets (`styles` build option) and component
stylesheets (`@Component({ styleUrls: [...], ...})`) with Sass can now be used.
The `stylePreprocessorOptions.includePaths` option is also available for Sass stylesheets.
Both the default format (`.scss`) and the indented format (`.sass`) are supported.
Inline component stylesheet support is not yet available with the esbuild-based builder.- Loading branch information
Showing
6 changed files
with
150 additions
and
69 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
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
59 changes: 59 additions & 0 deletions
59
packages/angular_devkit/build_angular/src/builders/browser-esbuild/sass-plugin.ts
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,59 @@ | ||
| /** | ||
| * @license | ||
| * Copyright Google LLC All Rights Reserved. | ||
| * | ||
| * Use of this source code is governed by an MIT-style license that can be | ||
| * found in the LICENSE file at https://angular.io/license | ||
| */ | ||
|
|
||
| import type { Plugin, PluginBuild } from 'esbuild'; | ||
| import type { LegacyResult } from 'sass'; | ||
| import { SassWorkerImplementation } from '../../sass/sass-service'; | ||
|
|
||
| export function createSassPlugin(options: { sourcemap: boolean; includePaths?: string[] }): Plugin { | ||
| return { | ||
| name: 'angular-sass', | ||
| setup(build: PluginBuild): void { | ||
| let sass: SassWorkerImplementation; | ||
|
|
||
| build.onStart(() => { | ||
| sass = new SassWorkerImplementation(); | ||
| }); | ||
|
|
||
| build.onEnd(() => { | ||
| sass?.close(); | ||
| }); | ||
|
|
||
| build.onLoad({ filter: /\.s[ac]ss$/ }, async (args) => { | ||
| const result = await new Promise<LegacyResult>((resolve, reject) => { | ||
| sass.render( | ||
| { | ||
| file: args.path, | ||
| includePaths: options.includePaths, | ||
| indentedSyntax: args.path.endsWith('.sass'), | ||
| outputStyle: 'expanded', | ||
| sourceMap: options.sourcemap, | ||
| sourceMapContents: options.sourcemap, | ||
| sourceMapEmbed: options.sourcemap, | ||
| quietDeps: true, | ||
| }, | ||
| (error, result) => { | ||
| if (error) { | ||
| reject(error); | ||
| } | ||
| if (result) { | ||
| resolve(result); | ||
| } | ||
| }, | ||
| ); | ||
| }); | ||
|
|
||
| return { | ||
| contents: result.css, | ||
| loader: 'css', | ||
| watchFiles: result.stats.includedFiles, | ||
| }; | ||
| }); | ||
| }, | ||
| }; | ||
| } |
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
124 changes: 66 additions & 58 deletions
124
tests/legacy-cli/e2e/tests/build/styles/include-paths.ts
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,78 +1,86 @@ | ||
| import { getGlobalVariable } from '../../../utils/env'; | ||
| import { writeMultipleFiles, expectFileToMatch, replaceInFile, createDir } from '../../../utils/fs'; | ||
| import { ng } from '../../../utils/process'; | ||
| import { updateJsonFile } from '../../../utils/project'; | ||
|
|
||
| export default function () { | ||
| return ( | ||
| Promise.resolve() | ||
| .then(() => createDir('src/style-paths')) | ||
| .then(() => | ||
| writeMultipleFiles({ | ||
| 'src/style-paths/_variables.scss': '$primary-color: red;', | ||
| 'src/styles.scss': ` | ||
| export default async function () { | ||
| // esbuild currently only supports Sass | ||
| const esbuild = getGlobalVariable('argv')['esbuild']; | ||
|
|
||
| await createDir('src/style-paths'); | ||
| await writeMultipleFiles({ | ||
| 'src/style-paths/_variables.scss': '$primary-color: red;', | ||
| 'src/styles.scss': ` | ||
| @import 'variables'; | ||
| h1 { color: $primary-color; } | ||
| `, | ||
| 'src/app/app.component.scss': ` | ||
| `, | ||
| 'src/app/app.component.scss': ` | ||
| @import 'variables'; | ||
| h2 { background-color: $primary-color; } | ||
| `, | ||
| 'src/style-paths/variables.styl': '$primary-color = green', | ||
| 'src/styles.styl': ` | ||
| `, | ||
| 'src/style-paths/variables.styl': '$primary-color = green', | ||
| 'src/styles.styl': ` | ||
| @import 'variables' | ||
| h3 | ||
| color: $primary-color | ||
| `, | ||
| 'src/app/app.component.styl': ` | ||
| `, | ||
| 'src/app/app.component.styl': ` | ||
| @import 'variables' | ||
| h4 | ||
| background-color: $primary-color | ||
| `, | ||
| 'src/style-paths/variables.less': '@primary-color: #ADDADD;', | ||
| 'src/styles.less': ` | ||
| `, | ||
| 'src/style-paths/variables.less': '@primary-color: #ADDADD;', | ||
| 'src/styles.less': ` | ||
| @import 'variables'; | ||
| h5 { color: @primary-color; } | ||
| `, | ||
| 'src/app/app.component.less': ` | ||
| `, | ||
| 'src/app/app.component.less': ` | ||
| @import 'variables'; | ||
| h6 { color: @primary-color; } | ||
| `, | ||
| }), | ||
| ) | ||
| .then(() => | ||
| replaceInFile( | ||
| 'src/app/app.component.ts', | ||
| `'./app.component.css\'`, | ||
| `'./app.component.scss', './app.component.styl', './app.component.less'`, | ||
| ), | ||
| ) | ||
| .then(() => | ||
| updateJsonFile('angular.json', (workspaceJson) => { | ||
| const appArchitect = workspaceJson.projects['test-project'].architect; | ||
| appArchitect.build.options.styles = [ | ||
| { input: 'src/styles.scss' }, | ||
| { input: 'src/styles.styl' }, | ||
| { input: 'src/styles.less' }, | ||
| ]; | ||
| appArchitect.build.options.stylePreprocessorOptions = { | ||
| includePaths: ['src/style-paths'], | ||
| }; | ||
| }), | ||
| ) | ||
| // files were created successfully | ||
| .then(() => ng('build', '--configuration=development')) | ||
| .then(() => expectFileToMatch('dist/test-project/styles.css', /h1\s*{\s*color: red;\s*}/)) | ||
| .then(() => expectFileToMatch('dist/test-project/main.js', /h2.*{.*color: red;.*}/)) | ||
| .then(() => expectFileToMatch('dist/test-project/styles.css', /h3\s*{\s*color: #008000;\s*}/)) | ||
| .then(() => expectFileToMatch('dist/test-project/main.js', /h4.*{.*color: #008000;.*}/)) | ||
| .then(() => expectFileToMatch('dist/test-project/styles.css', /h5\s*{\s*color: #ADDADD;\s*}/)) | ||
| .then(() => expectFileToMatch('dist/test-project/main.js', /h6.*{.*color: #ADDADD;.*}/)) | ||
| .then(() => ng('build', '--aot', '--configuration=development')) | ||
| .then(() => expectFileToMatch('dist/test-project/styles.css', /h1\s*{\s*color: red;\s*}/)) | ||
| .then(() => expectFileToMatch('dist/test-project/main.js', /h2.*{.*color: red;.*}/)) | ||
| .then(() => expectFileToMatch('dist/test-project/styles.css', /h3\s*{\s*color: #008000;\s*}/)) | ||
| .then(() => expectFileToMatch('dist/test-project/main.js', /h4.*{.*color: #008000;.*}/)) | ||
| .then(() => expectFileToMatch('dist/test-project/styles.css', /h5\s*{\s*color: #ADDADD;\s*}/)) | ||
| .then(() => expectFileToMatch('dist/test-project/main.js', /h6.*{.*color: #ADDADD;.*}/)) | ||
| `, | ||
| }); | ||
|
|
||
| await replaceInFile( | ||
| 'src/app/app.component.ts', | ||
| `'./app.component.css\'`, | ||
| `'./app.component.scss'` + (esbuild ? '' : `, './app.component.styl', './app.component.less'`), | ||
| ); | ||
|
|
||
| await updateJsonFile('angular.json', (workspaceJson) => { | ||
| const appArchitect = workspaceJson.projects['test-project'].architect; | ||
| appArchitect.build.options.styles = [{ input: 'src/styles.scss' }]; | ||
| if (!esbuild) { | ||
| appArchitect.build.options.styles.push( | ||
| { input: 'src/styles.styl' }, | ||
| { input: 'src/styles.less' }, | ||
| ); | ||
| } | ||
| appArchitect.build.options.stylePreprocessorOptions = { | ||
| includePaths: ['src/style-paths'], | ||
| }; | ||
| }); | ||
|
|
||
| await ng('build', '--configuration=development'); | ||
|
|
||
| expectFileToMatch('dist/test-project/styles.css', /h1\s*{\s*color: red;\s*}/); | ||
| expectFileToMatch('dist/test-project/main.js', /h2.*{.*color: red;.*}/); | ||
| if (!esbuild) { | ||
| // These checks are for the less and stylus files | ||
| expectFileToMatch('dist/test-project/styles.css', /h3\s*{\s*color: #008000;\s*}/); | ||
| expectFileToMatch('dist/test-project/main.js', /h4.*{.*color: #008000;.*}/); | ||
| expectFileToMatch('dist/test-project/styles.css', /h5\s*{\s*color: #ADDADD;\s*}/); | ||
| expectFileToMatch('dist/test-project/main.js', /h6.*{.*color: #ADDADD;.*}/); | ||
| } | ||
|
|
||
| // esbuild currently only supports AOT and not JIT mode | ||
| if (!esbuild) { | ||
| ng('build', '--no-aot', '--configuration=development'); | ||
|
|
||
| expectFileToMatch('dist/test-project/styles.css', /h1\s*{\s*color: red;\s*}/); | ||
| expectFileToMatch('dist/test-project/main.js', /h2.*{.*color: red;.*}/); | ||
| expectFileToMatch('dist/test-project/styles.css', /h3\s*{\s*color: #008000;\s*}/); | ||
| expectFileToMatch('dist/test-project/main.js', /h4.*{.*color: #008000;.*}/); | ||
| expectFileToMatch('dist/test-project/styles.css', /h5\s*{\s*color: #ADDADD;\s*}/); | ||
| expectFileToMatch('dist/test-project/main.js', /h6.*{.*color: #ADDADD;.*}/); | ||
| } | ||
| } |