History

Pete Bacon Darwin c5949f85ef build: update ts-api-guardian jsdoc tag requirements (#26595 ) Now `@experimental` tags are banned; and `@publicApi` tags are required on exports. PR Close #26595		2018-10-19 14:35:52 -07:00
..
bin	test(bazel): Build and test ts-api-guardian locally (#22544 )	2018-03-02 15:00:00 -08:00
lib	build: update ts-api-guardian jsdoc tag requirements (#26595 )	2018-10-19 14:35:52 -07:00
test	build: update ts-api-guardian jsdoc tag requirements (#26595 )	2018-10-19 14:35:52 -07:00
BUILD.bazel	test(bazel): Run Angular test on RBE (#25370 )	2018-09-18 13:29:54 -07:00
README.md	build: expose flatModuleOutFile option on ng_module (#22814 )	2018-03-20 13:28:57 -07:00
index.bzl	build: pass `stripExportPattern` as an array of `RegExp` (#26012 )	2018-09-27 12:07:03 -07:00
package.json	release: ts_api_guardian 0.4.0 (#26206 )	2018-10-02 13:46:41 -07:00
yarn.lock	feat: add support for TypeScript 3.1 (#26151 )	2018-09-28 09:34:51 -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:

$ bazel run //:install
$ 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
$ bazel run //tools/ts-api-guardian:ts-api-guardian.publish