Skip to content

Commit 2d1ebe8

Browse files
committed
Tune up README
1 parent 379397a commit 2d1ebe8

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
## What?
44

5-
`rules_tsickle` provides the `closure_ts_compile` rule that transforms `.ts`
6-
files into closure-annotated `.js` files. It contains a vendored copy of
7-
<https://github.com/angular/tsickle> that has been archived.
5+
`rules_tsickle` provides a `closure_ts_compile` rule that transforms `.ts` files
6+
into closure-annotated `.js` files. It contains a vendored copy of
7+
<https://github.com/angular/tsickle> (which was archived in May 2025).
88

99
## Why?
1010

@@ -39,11 +39,16 @@ closure_ts_compile(
3939
)
4040
```
4141

42-
A `bazel build :index` will:
42+
`bazel build :index` will:
4343

44-
- build the `js_binary` tsickle runner (`//tools/tsicklecompiler`).
44+
- download npm deps and prepare the `js_binary` tsickle runner
45+
(`//tools/tsicklecompiler`).
4546
- run the tool, which roughly works as follows:
4647
- prepare in internal/minimal `tsconfig.json` configuration.
4748
- runs `tsc` over the inputs to generate a `ts.Program`
48-
- runs tsickle over the `ts.Program` to AST-rewrite it
49-
- emits the final generated `.js` files.
49+
- runs tsickle over the `ts.Program` to AST-rewrite/transform it.
50+
- emits the transformed `.js` files.
51+
- output files:
52+
- each `{basename}.ts` will produce an equivalent `{basename}.js` file
53+
- if any `.d.ts` files are present, a single `{name}-externs.js` file will be
54+
produced.

0 commit comments

Comments
 (0)