Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Angular: Add built-in Ivy support instead of relying on addon #15229

Merged
merged 4 commits into from
Jun 16, 2021
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions app/angular/src/server/framework-preset-angular-ivy.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
import { Configuration } from 'webpack';
import { process as ngccProcess } from '@angular/compiler-cli/ngcc';
import * as path from 'path';
import { Options } from './framework-preset-angular-cli';

/**
* Run ngcc for converting modules to ivy format before starting storybook
* This step is needed in order to support Ivy in storybook
*
* Information about Ivy can be found here https://angular.io/guide/ivy
*/
export const runNgcc = () => {
ngccProcess({
// should be async: true but does not work due to
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we change this or should we wait ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does work without being async. The downside is if someone starts the user app + storybook at the same time and both start ngcc then storybook will most likely crash

So it's an edge case but it also does not work yet to set it to async

// https://github.com/storybookjs/storybook/pull/11157/files#r615413803
async: false,
basePath: path.join(process.cwd(), 'node_modules'), // absolute path to node_modules
createNewEntryPointFormats: true, // --create-ivy-entry-points
compileAllFormats: false, // --first-only
});
};

export const webpack = async (webpackConfig: Configuration, options: Options) => {
const angularOptions = await options.presets.apply(
'angularOptions',
{} as {
enableIvy?: boolean;
},
options
);

// Default to true, if undefined
if (angularOptions.enableIvy === false) {
kroeder marked this conversation as resolved.
Show resolved Hide resolved
return webpackConfig;
}

runNgcc();

return {
...webpackConfig,
resolve: {
...webpackConfig.resolve,
mainFields: [
'es2015_ivy_ngcc',
'module_ivy_ngcc',
'main_ivy_ngcc',
'es2015',
'browser',
'module',
'main',
],
},
};
};
1 change: 1 addition & 0 deletions app/angular/src/server/options.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@ export default {
frameworkPresets: [
require.resolve('./framework-preset-angular'),
require.resolve('./framework-preset-angular-cli'),
require.resolve('./framework-preset-angular-ivy'),
],
} as LoadOptions;
7 changes: 7 additions & 0 deletions app/angular/src/types/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { StorybookConfig as BaseConfig } from '@storybook/core-common';

export interface StorybookConfig extends BaseConfig {
angularOptions?: {
enableIvy: boolean;
};
}
3 changes: 3 additions & 0 deletions examples/angular-cli/.storybook/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,7 @@ module.exports = {
core: {
builder: 'webpack4',
},
angularOptions: {
enableIvy: true,
},
};