History

Alan Agius 17e98e1678 build: disable link to PUBLIC_API docs when running ts-api-guardian in angular repo (#34786 ) Currently we are showing the following link https://github.com/angular/angular/blob/master/docs/PUBLIC_API.md#golden-files whenever there are updates to the golden files. However this is not correct as this document only applies to the Angular repo as other consumers of ts-api-guardian have different commands, and they store they golden files in different locations. PR Close #34786		2020-01-21 13:08:47 -05:00
..
bin	…
lib	build: disable link to PUBLIC_API docs when running ts-api-guardian in angular repo (#34786 )	2020-01-21 13:08:47 -05:00
test	build: cleanup //tools/ts-api-guardian:tests target (#34736 )	2020-01-15 14:58:07 -05:00
BUILD.bazel	build: cleanup //tools/ts-api-guardian:tests target (#34736 )	2020-01-15 14:58:07 -05: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	build: typescript 3.7 support (#33717 )	2020-01-14 16:42:21 -08: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