aio: `yarn docs` prints warnings and errors but exists with exit code 0

[IgorMinar]

I'm at 923d0c5 and run the following:

$ yarn docs

The result is a combination of errors, warnings and happy messages. This is confusing, especially since the tasks exists with status code 0 :-)

Can we please:

• fix the errors
• turn the warnings (broken links) into errors and fix them
• break the build CI if any new errors are introduced

The following is the current output:

$ yarn docs
yarn docs v0.21.3
$ dgeni ./transforms/angular.io-package 
info:    running processor: readFilesProcessor
info:    running processor: extractJSDocCommentsProcessor
info:    running processor: readTypeScriptModules
info:    running processor: collectExamples
info:    running processor: parseTagsProcessor
info:    running processor: extractTagsProcessor
warn:    Invalid tags found - doc (content)  - from file "guide/aot-compiler.md" - starting at line 1
Line: 520: @Types and node modules
</h...


warn:    Invalid tags found - doc (content)  - from file "guide/style-guide.md" - starting at line 1
Line: 415: @Component({ ... })        
     ...
Line: 436: @Component({ ... })        
     ...
Line: 457: @Component({ ... })        
     ...
Line: 478: @Component({ ... })        
     ...
Line: 499: @Directive({ ... })        
     ...
Line: 520: @NgModule({ ... })        
     ...
Line: 541: @Pipe({ name: 'initCaps' }) ...
Line: 562: @Injectable()                 expo...
Line: 660: @Injectable()                 expo...
Line: 681: @Injectable()                 expo...
Line: 702: @Injectable()                 expo...
Line: 947: @Pipe({ name: 'ellipsis' }) ...
Line: 968: @Pipe({ name: 'initCaps' }) ...
Line: 1268: @NgModule({ ... })        
     ...
Line: 1289: @NgModule({ ... })        
     ...
Line: 1310: @NgModule({ ... })        
     ...
Line: 1331: @NgModule({ ... })        
     ...
Line: 1352: @NgModule({ ... })        
     ...


info:    running processor: codeNameProcessor
info:    running processor: createCheatsheetDoc
info:    running processor: convertPrivateClassesToInterfacesProcessor
info:    running processor: createOverviewDump
info:    running processor: mergeDecoratorDocs
info:    running processor: extractDecoratedClassesProcessor
info:    running processor: markBarredODocsAsPrivate
info:    running processor: computeIdsProcessor
info:    running processor: filterMemberDocs
info:    running processor: computePathsProcessor
info:    running processor: generateApiListDoc
info:    running processor: generateKeywordsProcessor
info:    running processor: addNotYetDocumentedProperty
info:    running processor: matchUpDirectiveDecoratorsProcessor
info:    running processor: renderDocsProcessor
info:    running processor: unescapeCommentsProcessor
info:    running processor: inlineTagProcessor
error:   Missing example region... relativePath: "reactive-forms/ts/src/app/hero-detail-7.component.ts", region: "import-address". - doc "guide/reactive-forms" (content)  - from file "guide/reactive-forms.md" - starting at line 1
error:   Regions available are:
error:   Missing example file... relativePath: "upgrade-module/ts/src/app/upgrade-io/hero-detail.component.ts
          ". - doc "guide/upgrade" (content)  - from file "guide/upgrade.md" - starting at line 1
error:   Example files can be found in: examples, examples
error:   Missing example file... relativePath: "upgrade-module/ts/src/app/upgrade-io/hero-detail.component.ts
          ". - doc "guide/upgrade" (content)  - from file "guide/upgrade.md" - starting at line 1
error:   Example files can be found in: examples, examples
error:   Missing example file... relativePath: "upgrade-module/ts/src/app/upgrade-io/container.component.ts ". - doc "guide/upgrade" (content)  - from file "guide/upgrade.md" - starting at line 1
error:   Example files can be found in: examples, examples
error:   Missing example file... relativePath: "upgrade-phonecat-2-hybrid/ts/karma-test-shim.1.js". - doc "guide/upgrade" (content)  - from file "guide/upgrade.md" - starting at line 1
error:   Example files can be found in: examples, examples
error:   Missing example file... relativePath: "webpack/ts/src/tsconfig.1.json". - doc "guide/webpack" (content)  - from file "guide/webpack.md" - starting at line 1
error:   Example files can be found in: examples, examples
error:   Missing example file... relativePath: "webpack/ts/src/assets/css/styles.css". - doc "guide/webpack" (content)  - from file "guide/webpack.md" - starting at line 1
error:   Example files can be found in: examples, examples
error:   Missing example file... relativePath: "toh-pt5/ts/src/app/app.component.1.ts". - doc "tutorial/toh-pt5" (content)  - from file "tutorial/toh-pt5.md" - starting at line 1
error:   Example files can be found in: examples, examples
error:   Missing example file... relativePath: "toh-pt5/ts/src/app/dashboard.component.1.html". - doc "tutorial/toh-pt5" (content)  - from file "tutorial/toh-pt5.md" - starting at line 1
error:   Example files can be found in: examples, examples
error:   Missing example file... relativePath: "toh-pt5/ts/src/app/hero-detail.component.html". - doc "tutorial/toh-pt5" (content)  - from file "tutorial/toh-pt5.md" - starting at line 1
error:   Example files can be found in: examples, examples
error:   Missing example file... relativePath: "toh-pt5/ts/src/app/dashboard.component.html". - doc "tutorial/toh-pt5" (content)  - from file "tutorial/toh-pt5.md" - starting at line 1
error:   Example files can be found in: examples, examples
error:   Missing example file... relativePath: "toh-pt6/ts/src/app/in-memory-data.service.ts". - doc "tutorial/toh-pt6" (content)  - from file "tutorial/toh-pt6.md" - starting at line 1
error:   Example files can be found in: examples, examples
error:   Missing example file... relativePath: "toh-pt6/ts/src/app/hero-search.service.ts". - doc "tutorial/toh-pt6" (content)  - from file "tutorial/toh-pt6.md" - starting at line 1
error:   Example files can be found in: examples, examples
error:   Missing example file... relativePath: "toh-pt6/ts/src/app/hero-search.component.html". - doc "tutorial/toh-pt6" (content)  - from file "tutorial/toh-pt6.md" - starting at line 1
error:   Example files can be found in: examples, examples
error:   Missing example file... relativePath: "toh-pt6/ts/src/app/hero-search.component.css". - doc "tutorial/toh-pt6" (content)  - from file "tutorial/toh-pt6.md" - starting at line 1
error:   Example files can be found in: examples, examples
error:   Missing example file... relativePath: "toh-pt6/ts/src/app/hero-search.component.ts". - doc "tutorial/toh-pt6" (content)  - from file "tutorial/toh-pt6.md" - starting at line 1
error:   Example files can be found in: examples, examples
error:   Missing example file... relativePath: "toh-pt6/ts/src/app/dashboard.component.html". - doc "tutorial/toh-pt6" (content)  - from file "tutorial/toh-pt6.md" - starting at line 1
error:   Example files can be found in: examples, examples
warn:    Invalid link (does not match any doc): "BrowserPlatformLocation" - doc "common/index/PlatformLocation" (class)  - from file "/Users/iminar/Dev/angular/packages/common/src/location/platform_location.ts"
warn:    Invalid link (does not match any doc): "WebWorkerPlatformLocation" - doc "common/index/PlatformLocation" (class)  - from file "/Users/iminar/Dev/angular/packages/common/src/location/platform_location.ts"
warn:    Invalid link (does not match any doc): "bootstrap" - doc "core/index/PlatformRef" (class)  - from file "/Users/iminar/Dev/angular/packages/core/src/application_ref.ts"
warn:    Invalid link (does not match any doc): "bootstrap" - doc "core/index/ApplicationRef" (class)  - from file "/Users/iminar/Dev/angular/packages/core/src/application_ref.ts"
warn:    Invalid link (does not match any doc): "ViewMetadata" - doc "core/index/ViewEncapsulation" (enum)  - from file "/Users/iminar/Dev/angular/packages/core/src/metadata/view.ts"
warn:    Invalid link (does not match any doc): "ViewMetadata" - doc "core/index/ViewEncapsulation" (enum)  - from file "/Users/iminar/Dev/angular/packages/core/src/metadata/view.ts"
warn:    Invalid link (does not match any doc): "NoProviderError" - doc "core/index/Injector" (class)  - from file "/Users/iminar/Dev/angular/packages/core/src/di/injector.ts"
warn:    Invalid link (does not match any doc): "runOutsideAngular" - doc "core/index/NgZone" (class)  - from file "/Users/iminar/Dev/angular/packages/core/src/zone/ng_zone.ts"
warn:    Invalid link (does not match any doc): "run" - doc "core/index/NgZone" (class)  - from file "/Users/iminar/Dev/angular/packages/core/src/zone/ng_zone.ts"
warn:    Invalid link (does not match any doc): "runOutsideAngular" - doc "core/index/NgZone" (class)  - from file "/Users/iminar/Dev/angular/packages/core/src/zone/ng_zone.ts"
warn:    Invalid link (does not match any doc): "run" - doc "core/index/NgZone" (class)  - from file "/Users/iminar/Dev/angular/packages/core/src/zone/ng_zone.ts"
warn:    Invalid link (does not match any doc): "compileModuleSync" - doc "core/index/Compiler" (class)  - from file "/Users/iminar/Dev/angular/packages/core/src/linker/compiler.ts"
warn:    Invalid link (does not match any doc): "compileModuleAsync" - doc "core/index/Compiler" (class)  - from file "/Users/iminar/Dev/angular/packages/core/src/linker/compiler.ts"
warn:    Invalid link (does not match any doc): "ViewQueryMetadata" - doc "core/index/QueryList" (class)  - from file "/Users/iminar/Dev/angular/packages/core/src/linker/query_list.ts"
warn:    Invalid link (does not match any doc): "Component.stylesUrl" - doc "core/index/ɵViewMetadata" (class)  - from file "/Users/iminar/Dev/angular/packages/core/src/metadata/view.ts"
warn:    Invalid link (does not match any doc): "Component.animation" - doc "core/index/ɵViewMetadata" (class)  - from file "/Users/iminar/Dev/angular/packages/core/src/metadata/view.ts"
warn:    Invalid link (does not match any doc): "Reflector" - doc "core/index/ɵreflector" (let)  - from file "/Users/iminar/Dev/angular/packages/core/src/reflection/reflection.ts"
warn:    Invalid link (does not match any doc): "@Input" - doc "forms/index/NgModel" (directive)  - from file "/Users/iminar/Dev/angular/packages/forms/src/directives/ng_model.ts"
error:   Missing example file... relativePath: "core/forms/ts/ng_validators/ng_validators.ts". - doc "forms/index/NG_VALIDATORS" (let)  - from file "/Users/iminar/Dev/angular/packages/forms/src/validators.ts"
error:   Example files can be found in: examples, examples
warn:    Invalid link (does not match any doc): "ROUTER_PROVIDERS" - doc "platform-webworker/index/WORKER_APP_LOCATION_PROVIDERS" (let)  - from file "/Users/iminar/Dev/angular/packages/platform-webworker/src/web_workers/worker/location_providers.ts"
info:    running processor: checkUnbalancedBackTicks
info:    running processor: convertToJsonProcessor
info:    running processor: writeFilesProcessor
Finished generating docs

[petebacondarwin]

@IgorMinar I have a fix for the "invalid tags" problem by upgrading to a new version of dgeni: #15243. The other errors are all problems in the content.

[petebacondarwin]

The missing examples should be fixed when @Foxandxss and I finish our docs and examples migration stuff.
The rest of the errors are problems with the API source code. We should create issues for each area owner to fix them.

[petebacondarwin]

We now have no errors or warnings and I have a PR for failing the build if {@link ...} tags fail: #16680