History

Alan Agius 10705684c8 test: fix api guardian tests on windows when node_modules are not installed (#30105 ) When the workspace node_modules are not installed outside of bazel context the api guardian tests fails because the tree artifacts files are not symlinked in windows. We need to pass the node module location in the node_path PR Close #30105		2019-04-26 16:32:23 -07:00
..
bin	test(bazel): Build and test ts-api-guardian locally (#22544 )	2018-03-02 15:00:00 -08:00
lib	test: fix ts api guardian and public guard tests on windows (#30105 )	2019-04-26 16:32:22 -07:00
test	test: fix api guardian tests on windows when node_modules are not installed (#30105 )	2019-04-26 16:32:23 -07:00
BUILD.bazel	build: fix api guardian error form npm (#30063 )	2019-04-23 14:49:20 -07:00
README.md	build: use bazel version from node modules (#26691 )	2018-10-30 16:19:13 -04:00
index.bzl	test: fix ts api guardian and public guard tests on windows (#30105 )	2019-04-26 16:32:22 -07:00
package.json	build: publish ts-api-guardian rule in the npm package (#29977 )	2019-04-19 10:59:23 -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:

$ yarn bazel run //:install
$ yarn 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
$ yarn bazel run //tools/ts-api-guardian:ts-api-guardian.publish