ng serve --proxy-config unspecified

[Chealer]

Bug Report

Affected Package

I am not sure what package is responsible. ng serve requires ng-cli.

Is this a regression?

This does not report a behavioral bug.

Description

The ng serve command supports several options, which are listed in the Options section of its documentation page. One of the useful options is --proxy-config, which allows to proxy to backend servers. Unfortunately, its documentation is limited to:

--proxy-config	Proxy configuration file.	string

While this clearly implies that the value is the path to a configuration file, the semantics of that file are entirely unspecified.

Minimal Reproduction

This does not report a behavioral bug.

Exception or Error

Your Environment

Angular Version:

Angular CLI: 8.3.29
Node: 12.19.0
OS: win32 x64
Angular: 8.2.14
... animations, common, compiler, compiler-cli, core, forms
... platform-browser, platform-browser-dynamic, platform-server
... router

Package                           Version
-----------------------------------------------------------
@angular-devkit/architect         0.803.29
@angular-devkit/build-angular     0.803.29
@angular-devkit/build-optimizer   0.803.29
@angular-devkit/build-webpack     0.803.29
@angular-devkit/core              8.3.29
@angular-devkit/schematics        8.3.29
@angular/cdk                      8.2.3
@angular/cli                      8.3.29
@angular/material                 8.2.3
@ngtools/webpack                  8.3.29
@schematics/angular               8.3.29
@schematics/update                0.803.29
rxjs                              6.6.3
typescript                        3.5.3
webpack                           4.39.2

Anything else relevant?

No

No

The documentation about proxying hints about what kind of files --proxy-config expects.

[gkalpak]

Thx for reporting this, @Chealer! Moving over to the CLI repo, since that is where the docs source for CLI commands live.

[alan-agius4]

I think in this case there are 2 parts for this fix.

1. From https://angular.io/cli/serve#options we link to https://angular.io/guide/build#proxying-to-a-backend-server
2. In https://angular.io/guide/build#proxying-to-a-backend-server we provide more details about the format.

[angular-automatic-lock-bot]

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

_{This action has been performed automatically by a bot.}