History

Joey Perrott 15f8afa4bf ci: move public-api goldens to goldens directory (#35768 ) Moves the public api .d.ts files from tools/public_api_guard to goldens/public-api. Additionally, provides a README in the goldens directory and a script assist in testing the current state of the repo against the goldens as well as a command for accepting all changes to the goldens in a single command. PR Close #35768		2020-03-10 20:58:39 -04:00
..
bin	test(bazel): Build and test ts-api-guardian locally (#22544 )	2018-03-02 15:00:00 -08:00
lib	ci: move public-api goldens to goldens directory (#35768 )	2020-03-10 20:58:39 -04:00
test	build: allow auto-discover all typings files in npm package by ts-api-guardian (#35691 )	2020-02-27 14:02:16 -08:00
BUILD.bazel	build: cleanup //tools/ts-api-guardian:tests target (#34736 )	2020-01-15 14:58:07 -05:00
README.md	release: ts_api_guardian (#30120 )	2019-05-13 10:53:34 -07:00
index.bzl	ci: move public-api goldens to goldens directory (#35768 )	2020-03-10 20:58:39 -04:00
package.json	ci: bump release version of ts-api-guardian (#34933 )	2020-01-23 13:24:53 -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:

$ 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