fix(typescript): update documentation now that ts_project is recommended #2548
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alexeagle
force-pushed
the
no_ts_library
branch
from
b1a8220
to
3de859d
Compare
mattem
approved these changes
Mar 24, 2021
packages/typescript/_README.md
Outdated
| Then call it, using the [`npm_package_bin`](Built-ins#npm_package_bin) documentation. | ||
|
|
||
| Here is an example: | ||
| https://github.com/bazelbuild/rules_nodejs/blob/stable/internal/node/test/BUILD.bazel#L491-L507 |
There was a problem hiding this comment.
nit: don't link to the lines as they will likely change and we'll forget to update the docs
"An example of using tsc directly can be seen in the nodejs tests BUILD.bazel file"
There was a problem hiding this comment.
I'd like to point to the right spot in the file too, it's very long. I pinned to 3.2.2 rather than stable so we don't break the link
packages/typescript/_README.md
Outdated
|
|
||
| ### ts_project | ||
|
|
||
| `ts_project` simply runs `tsc --project`, with Bazel knowing which outputs to expect based on the TypeScript compiler options, and with interoperability with other TypeScript rules via a Bazel Provider (DeclarationInfo) that transmits the type information. |
There was a problem hiding this comment.
yeah - it's so hard to get the links right tho, so they work in both markdown and on the rendered docsite, let's try...
packages/typescript/_README.md
Outdated
| Here, `//path/to/other:library` is another target in your repo that produces TypeScript typings (for example, another `ts_project` rule). To use third-party libraries from npm, first install them (likely using `npm_install` or `yarn_install` rules) then add those to the `deps` as well: | ||
|
|
||
| ```starlark | ||
| ts_library( |
We don't deprecated ts_library yet
alexeagle
force-pushed
the
no_ts_library
branch
from
3de859d
to
48fc45b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We don't deprecate ts_library yet