History

Ben Lesh b2962db4cb test: add additional test for codeGenApi (#29844 ) Addresses comments made by @gkalpak in #29820 PR Close #29844		2019-04-15 10:51:24 -07:00
..
bin	test(bazel): Build and test ts-api-guardian locally (#22544 )	2018-03-02 15:00:00 -08:00
lib	refactor(ivy): Update @publicApi to @codeGenApi on ivy instructions (#29820 )	2019-04-11 08:19:23 -07:00
test	test: add additional test for codeGenApi (#29844 )	2019-04-15 10:51:24 -07:00
BUILD.bazel	build: rules_nodejs 0.26.0 & use @npm instead of @ngdeps now that downstream angular build uses angular bundles (#28871 )	2019-02-28 12:06:36 -08:00
README.md	build: use bazel version from node modules (#26691 )	2018-10-30 16:19:13 -04:00
index.bzl	refactor(ivy): use ɵɵ instead of Δ for now (#29850 )	2019-04-11 16:27:56 -07:00
package.json	build: update to TypeScript 3.4 (#29372 )	2019-04-10 12:12:16 -07:00
yarn.lock	feat: add support for typescript 3.2 (#27536 )	2018-12-18 13:20:01 -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:

$ 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