GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-04 18:41:06 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #17380 from storybookjs/fix-angular-builder-docs

Browse Source 
Angular: Improve builder migration docs & example
This commit is contained in:
Michael Shilman 2022-02-28 16:17:21 +08:00 committed by GitHub
commit 84be995370
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
MIGRATION.md
View File

@ -517,8 +517,8 @@ In 6.4 the behavior of loaders when arg changes occurred was tweaked so loaders
Since SB6.3, Storybook for Angular supports a builder configuration in your project's `angular.json`. This provides an Angular-style configuration for running and building your Storybook. The full builder documentation will be shown in the [main documentation page](https://storybook.js.org/docs/angular) soon, but for now you can check out an example here:
- `start-storybook`: https://github.com/storybookjs/storybook/blob/next/examples/angular-cli/angular.json#L78
- `build-storybook`: https://github.com/storybookjs/storybook/blob/next/examples/angular-cli/angular.json#L86
- `start-storybook`: [example](https://github.com/storybookjs/storybook/blob/next/examples/angular-cli/angular.json#L78) [schema](https://github.com/storybookjs/storybook/blob/next/app/angular/src/builders/start-storybook/schema.json)
- `build-storybook`: [example](https://github.com/storybookjs/storybook/blob/next/examples/angular-cli/angular.json#L86) [schema](https://github.com/storybookjs/storybook/blob/next/app/angular/src/builders/build-storybook/schema.json)
#### Angular13
@ -557,6 +557,13 @@ If you need storybook-specific styles separate from your app, you can configure
}
```
Then, once you've set this up, you should run Storybook through the builder:
```sh
ng run my-default-project:storybook
ng run my-default-project:build-storybook
```
#### Angular component parameter removed
In SB6.3 and earlier, the `default.component` metadata was implemented as a parameter, meaning that stories could set `parameters.component` to override the default export. This was an internal implementation that was never documented, but it was mistakenly used in some Angular examples.

6
examples/angular-cli/package.json
View File

@ -5,14 +5,14 @@
"license": "MIT",
"scripts": {
"build": "ng build",
"build-storybook": "yarn storybook-prebuild && build-storybook",
"build-storybook": "yarn storybook-prebuild && ng run angular-cli:build-storybook",
"docs:json": "compodoc -p ./tsconfig.json -e json -d .",
"e2e": "ng e2e",
"postinstall": "ngcc --source ../../node_modules",
"ng": "ng",
"start": "ng serve",
"storybook": "yarn storybook-prebuild && start-storybook -p 9008 --no-manager-cache",
"storybook-prebuild": "yarn test:generate-output && yarn docs:json",
"storybook": "yarn storybook-prebuild && ng run angular-cli:storybook",
"storybook-prebuild": "yarn test:generate-output",
"test": "jest",
"test:coverage": "jest --coverage",
"test:generate-output": "jest --json --config=jest.addon-config.js --outputFile=addon-jest.testresults.json || true",