History

Paul Gschwendtner 762e057e85 build: update to rules_nodejs v4.0.0-beta.0 (#42760 ) Updates the Bazel NodeJS rules to v4.0.0-beta.0. This is necessary so that the Angular components repo can update, and it's generally good to stay as up-to-date as possible with the Bazel rules as it's easy to fall behind, and updating early allows us to discover issues affecting our tooling earlier (where they are easier to address due to e.g. potential breaking change policy). PR Close #42760		2021-07-09 14:50:15 -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 rules_nodejs v4.0.0-beta.0 (#42760 )	2021-07-09 14:50:15 -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 to typescript 4.3.4 (#42600 )	2021-06-21 16:42:49 +00: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