angular-docs-cn/tools/ts-api-guardian/README.md

# Typescript API Guardian

Keeps track of public API surface of a typescript library.

Examples:

```sh
# Generate one declaration file
ts-api-guardian --out api_guard.d.ts index.d.ts
# Generate multiple declaration files
# (output location like typescript)
ts-api-guardian --outDir api_guard [--rootDir .] core/index.d.ts core/testing.d.ts
# Print usage
ts-api-guardian --help
# Check against one declaration file
ts-api-guardian --verify api_guard.d.ts index.d.ts
# Check against multiple declaration files
ts-api-guardian --verifyDir api_guard [--rootDir .] core/index.d.ts core/testing.d.ts
```

# For developers

Build and test this library:

```sh
$ yarn bazel run //:install
$ yarn bazel test //tools/ts-api-guardian:all
```

Publish to NPM:

```sh
$ npm whoami # should be logged in as angular
$ grep version tools/ts-api-guardian/package.json # advance as needed
$ yarn bazel run //tools/ts-api-guardian:ts-api-guardian.publish
```
build: copy ts-api-guardian sources (#22544) This is an exact mirror of https://github.com/angular/ts-api-guardian/tree/750f651eca4d57a4a7ebcc12c19d0beea1a62202 PR Close #22544 2018-03-02 14:19:01 -08:00			`# Typescript API Guardian`

			`Keeps track of public API surface of a typescript library.`
test(bazel): Build and test ts-api-guardian locally (#22544) Also use it to test the public API for core and common Once we have an ng_package for every package, we can remove the npm dependency on ts-api-guardian and the gulp-based public api check. PR Close #22544 2018-03-01 10:41:35 -08:00
build: expose flatModuleOutFile option on ng_module (#22814) This lets projects like Material change ng_package "bundle index" files to non-conflicting paths Currently packages like @angular/core ship with the generated metadata in a path like 'core.js' which overwrites one of the inputs. Angular material puts the generated file in a path like 'index.js' Either way these files generated by ng_module rules have the potential to collide with inputs given by the user, which results in an error. Instead, give users the freedom to choose a different non-conflicting name. Also this refactors the ng_package rule, removing the redundant secondary_entry_points attribute. Instead, we assume that any ng_module in the deps with a module_name attribute is a secondary entry point. PR Close #22814 2018-03-15 18:04:34 -07:00			`Examples:`

			```sh
			`# Generate one declaration file`
			`ts-api-guardian --out api_guard.d.ts index.d.ts`
			`# Generate multiple declaration files`
			`# (output location like typescript)`
			`ts-api-guardian --outDir api_guard [--rootDir .] core/index.d.ts core/testing.d.ts`
			`# Print usage`
			`ts-api-guardian --help`
			`# Check against one declaration file`
			`ts-api-guardian --verify api_guard.d.ts index.d.ts`
			`# Check against multiple declaration files`
			`ts-api-guardian --verifyDir api_guard [--rootDir .] core/index.d.ts core/testing.d.ts`
			```

test(bazel): Build and test ts-api-guardian locally (#22544) Also use it to test the public API for core and common Once we have an ng_package for every package, we can remove the npm dependency on ts-api-guardian and the gulp-based public api check. PR Close #22544 2018-03-01 10:41:35 -08:00			`# For developers`

			`Build and test this library:`

			```sh
build: use bazel version from node modules (#26691) * No longer depends on a custom CircleCI docker image that comes with Bazel pre-installed. Since Bazel is now available through NPM, we should be able to use the version from `@bazel/bazel` in order to enforce a consistent environment on CI and locally. * This also reduces the amount of packages that need to be published (ngcontainer is removed) PR Close #26691 2018-10-27 09:25:45 +02:00			`$ yarn bazel run //:install`
			`$ yarn bazel test //tools/ts-api-guardian:all`
test(bazel): Build and test ts-api-guardian locally (#22544) Also use it to test the public API for core and common Once we have an ng_package for every package, we can remove the npm dependency on ts-api-guardian and the gulp-based public api check. PR Close #22544 2018-03-01 10:41:35 -08:00			```

			`Publish to NPM:`

			```sh
			`$ npm whoami # should be logged in as angular`
			`$ grep version tools/ts-api-guardian/package.json # advance as needed`
build: use bazel version from node modules (#26691) * No longer depends on a custom CircleCI docker image that comes with Bazel pre-installed. Since Bazel is now available through NPM, we should be able to use the version from `@bazel/bazel` in order to enforce a consistent environment on CI and locally. * This also reduces the amount of packages that need to be published (ngcontainer is removed) PR Close #26691 2018-10-27 09:25:45 +02:00			`$ yarn bazel run //tools/ts-api-guardian:ts-api-guardian.publish`
test(bazel): Build and test ts-api-guardian locally (#22544) Also use it to test the public API for core and common Once we have an ng_package for every package, we can remove the npm dependency on ts-api-guardian and the gulp-based public api check. PR Close #22544 2018-03-01 10:41:35 -08:00			```