History

Judy Bogart a00f82797b docs: document golden file requirement (#33900 ) PR Close #33900		2020-01-07 10:58:53 -08:00
..
bin	test(bazel): Build and test ts-api-guardian locally (#22544 )	2018-03-02 15:00:00 -08:00
lib	docs: document golden file requirement (#33900 )	2020-01-07 10:58:53 -08: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: switch to @build_bazel_rules_nodejs//:index.bzl load point (#33433 )	2019-10-28 10:10:48 -07:00
README.md	release: ts_api_guardian (#30120 )	2019-05-13 10:53:34 -07:00
index.bzl	fix(core): make QueryList implement Iterable in the type system (#33536 )	2019-11-19 13:43:53 -08:00
package.json	feat: typescript 3.6 support (#32946 )	2019-10-18 13:15:16 -04: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:

$ yarn bazel run @nodejs//: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