History

Joey Perrott 3a90a7cb43 ci: run ts-api-guardian test remotely on CI (#32677 ) PR Close #32677		2019-09-13 15:13:44 -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	ci: run ts-api-guardian test remotely on CI (#32677 )	2019-09-13 15:13:44 -07:00
README.md	release: ts_api_guardian (#30120 )	2019-05-13 10:53:34 -07:00
index.bzl	build: ts-api-guardian npm package contains invalid references (#31096 )	2019-06-18 09:50:41 -07:00
package.json	build: TypeScript 3.5 upgrade (#31615 )	2019-07-25 17:05: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:

$ 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