History

Joey Perrott d1ea1f4c7f build: update license headers to reference Google LLC (#37205 )

Update the license headers throughout the repository to reference Google LLC
rather than Google Inc, for the required license headers.

PR Close #37205

2020-05-26 14:26:58 -04:00

bin

test(bazel): Build and test ts-api-guardian locally (#22544 )

2018-03-02 15:00:00 -08:00

lib

build: update license headers to reference Google LLC (#37205 )

2020-05-26 14:26:58 -04:00

test

build: update license headers to reference Google LLC (#37205 )

2020-05-26 14:26:58 -04:00

BUILD.bazel

build: cleanup //tools/ts-api-guardian:tests target (#34736 )

2020-01-15 14:58:07 -05: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

build: prepare for TypeScript 3.9 (#36989 )

2020-05-14 10:50:28 -07:00

README.md

release: ts_api_guardian (#30120 )

2019-05-13 10:53:34 -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