History

Alan Agius 1aed2f3234 fix(dev-infra): replace `chalk` require with namespace import (#41847 ) Since we now use version 4 we can use namespace imports and leverage in build types. PR Close #41847		2021-04-28 09:22:31 -07:00
..
bin	test(bazel): Build and test ts-api-guardian locally (#22544 )	2018-03-02 15:00:00 -08:00
lib	fix(dev-infra): replace `chalk` require with namespace import (#41847 )	2021-04-28 09:22:31 -07:00
test	build: update to latest version of `rules_nodejs` v3.3.0 (#41599 )	2021-04-13 17:37:28 -07:00
BUILD.bazel	build: update to latest version of `rules_nodejs` v3.3.0 (#41599 )	2021-04-13 17:37:28 -07:00
README.md	release: ts_api_guardian (#30120 )	2019-05-13 10:53:34 -07:00
index.bzl	build: update tools directory for latest changes in rules_nodejs (#40710 )	2021-02-09 10:48:43 -08:00
package.json	build: update dependency chalk to v4 (#41847 )	2021-04-28 09:22: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:

$ 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