History

Ben Lesh cf86ed7b29 refactor(ivy): migrate ɵɵ prefix back to Δ (#30362 ) Now that issues are resolved with Closure compiler, we can move back to our desired prefix of `Δ`. PR Close #30362		2019-05-14 16:52:15 -07:00
..
bin	…
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: update rules_nodejs and clean up bazel warnings (#30370 )	2019-05-14 10:08:45 -07:00
README.md	release: ts_api_guardian (#30120 )	2019-05-13 10:53:34 -07:00
index.bzl	refactor(ivy): migrate ɵɵ prefix back to Δ (#30362 )	2019-05-14 16:52:15 -07:00
package.json	release: ts_api_guardian (#30120 )	2019-05-13 10:53:34 -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