Skip to content

docs: update hmr documentation #11029

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 12, 2018
Merged

docs: update hmr documentation #11029

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
35 changes: 29 additions & 6 deletions docs/documentation/stories/configure-hmr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,25 +41,48 @@ export const environment = {
```


Update `angular.json` to include an hmr environment as explained [here](./application-environments) and add a configuration within serve to enable hmr.
Update `angular.json` to include an hmr environment as explained [here](./application-environments)
and add configurations within build and serve to enable hmr. Note that `<project-name>` here
represents the name of the project you are adding this configuration to in `angular.json`.

```json
"serve": {
"configuration": {
"build": {
"configurations": {
...
"hmr": {
"hmr": true,
"fileReplacements": [
{
"replace": "src/environments/environment.ts",
"with": "src/environments/environment.hmr.ts"
}
],
]
}
}
},
...
"serve": {
"configurations": {
...
"hmr": {
"hmr": true,
"browserTarget": "<project-name>:build:hmr"
}
}
}
```

Add the necessary types to `src/tsconfig.app.json`

```json
{
...
"compilerOptions": {
...
"types": ["node"]
},
}
```

Run `ng serve` with the flag `--configuration hmr` to enable hmr and select the new environment:

```bash
Expand Down Expand Up @@ -134,7 +157,7 @@ if (environment.hmr) {
console.log('Are you using the --hmr flag for ng serve?');
}
} else {
bootstrap();
bootstrap().catch(err => console.log(err));
}
```

Expand Down