History

Alan Agius 5f95796b61 test: fix ts api guardian and public guard tests on windows (#30105 ) This change addresses several issues with ts-api-guardian and public api guards related tests in Windows The fixes contain 3 main changes: 1) In `stripExportPattern` - replace `^` with `^^^^` in RegExp due to a double escaping requirment under Windows. Note that under Linux this the extra character has no effect because it's still a valid RegExp in Js. 2. Force `*.patch` files to always be with a LF line sequence instead of CRLF in windows 3. When adding JSDoc comments consider the presence of a carriage return in a line new feed Partially addresses #29785 PR Close #30105		2019-04-26 16:32:22 -07:00
..
bin	test(bazel): Build and test ts-api-guardian locally (#22544 )	2018-03-02 15:00:00 -08:00
lib	test: fix ts api guardian and public guard tests on windows (#30105 )	2019-04-26 16:32:22 -07:00
test	test: add additional test for codeGenApi (#29844 )	2019-04-15 10:51:24 -07:00
BUILD.bazel	build: fix api guardian error form npm (#30063 )	2019-04-23 14:49:20 -07:00
README.md	build: use bazel version from node modules (#26691 )	2018-10-30 16:19:13 -04:00
index.bzl	test: fix ts api guardian and public guard tests on windows (#30105 )	2019-04-26 16:32:22 -07:00
package.json	build: publish ts-api-guardian rule in the npm package (#29977 )	2019-04-19 10:59:23 -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