History

Pete Bacon Darwin ac316be79b build: remove unnecessary stability check (#23176 )

Previously, it was necessary to attach on of the three "stability"
jsdoc tags (`@stable`, `@deprecated` or `@experimental`) to each
public API export.

To ensure that the public API was correctly tagged, the `ts-api-guardian`
would check that one of these tags appeared on every public export.

Now the doc-gen is able to compute that a code item is stable if
it does not contain the `@experimental` nor `@deprecated` tags.

Therefore there is no need to provide the `@stable` tag any more; and
this tag has now been marked as deprecated - i.e. it should not be used.

The ts-api-guardian has been modified in this commit so that it no longer
warns/fails if the `@stable` is missing.

PR Close #23176

2018-04-05 10:03:39 -07:00

bin

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

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

lib

build: remove unnecessary stability check (#23176 )

2018-04-05 10:03:39 -07:00

test

build: remove unnecessary stability check (#23176 )

2018-04-05 10:03:39 -07:00

BUILD.bazel

build: ts-api-guardian reuses root node_modules (#22894 )

2018-03-22 19:23:33 -04:00

index.bzl

build: remove unnecessary stability check (#23176 )

2018-04-05 10:03:39 -07:00

package.json

build: ts-api-guardian reuses root node_modules (#22894 )

2018-03-22 19:23:33 -04:00

README.md

build: expose flatModuleOutFile option on ng_module (#22814 )

2018-03-20 13:28:57 -07:00

yarn.lock

build: ts-api-guardian reuses root node_modules (#22894 )

2018-03-22 19:23:33 -04: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:

$ bazel run //:install
$ 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
$ bazel run //tools/ts-api-guardian:ts-api-guardian.publish