angular-cn/aio/content/examples/observables-in-angular/example-config.json

{
  "tests": [
    {
      "cmd": "yarn",
      "args": [ "tsc", "--project", "./tsconfig.app.json" ]
    }
  ]
}
test(docs-infra): ensure RxJS-related docs examples can compile without errors (#34063) Previously, some RxJS-related examples (which are not proper Angular apps) were not tested on CI as part of the `example-e2e` npm script. This meant that the examples could get out-of-date or contain compile errors without as noticing. This commit ensures that the `example-e2e` script picks up these examples and checks that they compile successfully. Partly addresses #28017. PR Close #34063 2019-11-26 14:11:45 -05:00			`{`
build(docs-infra): renamed `e2e` property of `example-config.json` to `tests` (#36143) Each docs example has an `example-config.json` configuration file. Among other things, this file can be used to specify what commands to run in order to test the example. (If not specified, the `run-example-e2e.js` script will run a default `yarn e2e` command.) Previously, the property specifying the test commands was called `e2e`. This is because in the past only e2e tests were run for docs examples. Since recently, some examples may specify commands for other types of tests (such as unit tests). Therefore, calling the property that holds the list of test commands `e2e` no longer makes sense and can be misleading to people looking at the configuration files. This commit renamed the property to the more generic `tests`. In the future, the `run-example-e2e.js` script (and corresponding npm script) should be renamed and refactored to also avoid giving the impression that only e2e tests are run. Discussed in: https://github.com/angular/angular/pull/36143#discussion_r395148379 PR Close #36143 2020-03-23 11:31:56 -04:00			`"tests": [`
test(docs-infra): ensure RxJS-related docs examples can compile without errors (#34063) Previously, some RxJS-related examples (which are not proper Angular apps) were not tested on CI as part of the `example-e2e` npm script. This meant that the examples could get out-of-date or contain compile errors without as noticing. This commit ensures that the `example-e2e` script picks up these examples and checks that they compile successfully. Partly addresses #28017. PR Close #34063 2019-11-26 14:11:45 -05:00			`{`
			`"cmd": "yarn",`
test(docs-infra): compile only app for examples with no e2e (#33717) With TS 3.7, these examples were running into the error below (e.g. on https://circleci.com/gh/angular/angular/574906#tests/containers/0): ``` ============== AIO example output for: /home/circleci/ng/aio/content/examples/observables/ running: yarn tsc --project ./ $ /home/circleci/ng/aio/content/examples/observables/node_modules/.bin/tsc --project ./ ../../../tools/examples/shared/node_modules/protractor/built/index.d.ts(5,10): error TS2440: Import declaration conflicts with local declaration of 'PluginConfig'. ../../../tools/examples/shared/node_modules/protractor/built/index.d.ts(5,24): error TS2440: Import declaration conflicts with local declaration of 'ProtractorPlugin'. error Command failed with exit code 2. info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command. completed: yarn tsc --project ./ ``` This happened because of https://github.com/angular/protractor/issues/5348. It's unclear why this typings problem does not affect `ng e2e` runs, and only affects `tsc` runs. For now it seems sensible to alter the tests to compile only the app and not the e2e, since the intent of https://github.com/angular/angular/commit/2cc954d5a54b2d9a0bee3679f6d4f9473389f32e was never to verify the correctness of the e2e in the first place. We still need a release of protractor that supports TS 3.7 though, but at least it doesn't seem to block our update proper. PR Close #33717 2020-01-08 07:48:25 -05:00			`"args": [ "tsc", "--project", "./tsconfig.app.json" ]`
test(docs-infra): ensure RxJS-related docs examples can compile without errors (#34063) Previously, some RxJS-related examples (which are not proper Angular apps) were not tested on CI as part of the `example-e2e` npm script. This meant that the examples could get out-of-date or contain compile errors without as noticing. This commit ensures that the `example-e2e` script picks up these examples and checks that they compile successfully. Partly addresses #28017. PR Close #34063 2019-11-26 14:11:45 -05:00			`}`
			`]`
			`}`