History

Alan Agius 6b1780d77e build: avoid writing `\r` in windows (#26888 ) In windows when using readFile `\n` are replaced with `\r\n` which causes issues when comparing golden files PR Close #26888		2018-11-13 10:50:21 -08:00
..
bin	test(bazel): Build and test ts-api-guardian locally (#22544 )	2018-03-02 15:00:00 -08:00
lib	build: avoid writing `\r` in windows (#26888 )	2018-11-13 10:50:21 -08:00
test	build: fix ts-api-guardian does not work on windows w/ bazel (#26761 )	2018-10-30 13:45:58 -04:00
BUILD.bazel	build: fix ts-api-guardian does not work on windows w/ bazel (#26761 )	2018-10-30 13:45:58 -04:00
README.md	build: use bazel version from node modules (#26691 )	2018-10-30 16:19:13 -04:00
index.bzl	build: add option to disable ts-api-guardian default angular tag rules (#26761 )	2018-10-30 13:45:58 -04:00
package.json	build: review comments addressed (#26488 )	2018-10-19 20:59:29 -07:00
yarn.lock	build: review comments addressed (#26488 )	2018-10-19 20:59:29 -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:

$ 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