History

Paul Gschwendtner a1e00f82f4 build: fix ts-api-guardian golden approval not working on windows (#36115 ) Currently on Windows, it's not possible to approve goldens in `ts-api-guardian`. This is because paths are resolved relatively to the working directory. In Windows, golden files are resolved to the actual workspace directory. The current logic tries to compute a relative path to the runfile from the working directory. This causes the file paths to have a lot of parent directory path segments. Eventually, when joined with the build workspace directory, the paths end up being incorrect. e.g. ``` fileName = ../../../../../../projects/angular/golden/<..>/common.d.ts` outFile = BUILD_WORKSPACE_DIR + fileName; ``` To fix this, we no longer deal with confusing relative paths, but instead always use absolute file system paths. Additionally, this fixes that new goldens are generated at the wrong location on all platforms. PR Close #36115		2020-03-17 12:38:25 -07:00
..
bin	…
lib	build: fix ts-api-guardian golden approval not working on windows (#36115 )	2020-03-17 12:38:25 -07: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	build: provide full paths to `ts_api_guardian_test_npm_package` and `ts_api_guardian_test` (#36034 )	2020-03-12 09:49:00 -07: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