History

Alan Agius 2a21ca09d2 feat(bazel): add additional parameters to `ts_api_guardian_test` def (#25694 ) Added `strip_export_pattern` and `allow_module_identifiers` so that these can be passed from downstream PR Close #25694		2018-09-07 14:24:31 -07:00
..
bin	test(bazel): Build and test ts-api-guardian locally (#22544 )	2018-03-02 15:00:00 -08:00
lib	build(bazel): entry point file couldn't be resolved [ts-api-guardian] (#25052 )	2018-08-01 13:29:27 -07:00
test	build: remove unnecessary stability check (#23176 )	2018-04-05 10:03:39 -07:00
BUILD.bazel	fix(bazel): specify the package and lock files using the workspace (#25694 )	2018-09-07 14:24:31 -07:00
README.md	build: expose flatModuleOutFile option on ng_module (#22814 )	2018-03-20 13:28:57 -07:00
index.bzl	feat(bazel): add additional parameters to `ts_api_guardian_test` def (#25694 )	2018-09-07 14:24:31 -07:00
package.json	fix(bazel): specify the package and lock files using the workspace (#25694 )	2018-09-07 14:24:31 -07:00
yarn.lock	fix(bazel): specify the package and lock files using the workspace (#25694 )	2018-09-07 14:24:31 -07:00

README.md

Typescript API Guardian

Keeps track of public API surface of a typescript library.

Examples:

# 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:

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

Publish to NPM:

$ npm whoami # should be logged in as angular
$ grep version tools/ts-api-guardian/package.json # advance as needed
$ bazel run //tools/ts-api-guardian:ts-api-guardian.publish