|
1 | | -# Project |
| 1 | +# @typescript/analyze-trace |
| 2 | +Tool for analyzing the output of `tsc --generateTrace` automatically, rather than following the steps [here](https://github.com/microsoft/TypeScript/wiki/Performance-Tracing). |
2 | 3 |
|
3 | | -> This repo has been populated by an initial template to help get you started. Please |
4 | | -> make sure to update the content to build a great experience for community-building. |
| 4 | +Note: The goal is to identify clear-cut hot-spots and provide enough context to extract a small repro. |
| 5 | +The repro can then be used as the basis of a bug report or a starting point for manual code inspection or profiling. |
5 | 6 |
|
6 | | -As the maintainer of this project, please make a few updates: |
| 7 | +## Usage |
7 | 8 |
|
8 | | -- Improving this README.MD file to provide a great experience |
9 | | -- Updating SUPPORT.MD with content about this project's support experience |
10 | | -- Understanding the security reporting process in SECURITY.MD |
11 | | -- Remove this section from the README |
| 9 | +First, build your project with `--generateTrace traceDir` |
12 | 10 |
|
13 | | -## Contributing |
| 11 | +For a sorted list of compilation hot-spots, run `npx analyze-trace traceDir` |
14 | 12 |
|
15 | | -This project welcomes contributions and suggestions. Most contributions require you to agree to a |
16 | | -Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us |
17 | | -the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. |
| 13 | +For a simplified view of a types file (useful when investigating an individual trace), run `npx simplify-trace-types traceDir\types.json output_path` |
18 | 14 |
|
19 | | -When you submit a pull request, a CLA bot will automatically determine whether you need to provide |
20 | | -a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions |
21 | | -provided by the bot. You will only need to do this once across all repos using our CLA. |
22 | | - |
23 | | -This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). |
24 | | -For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or |
25 | | -contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. |
| 15 | +To pretty-print individual types from a types file (faster than processing the entire file), run `npx print-types traceDir\types.json id+` |
26 | 16 |
|
27 | 17 | ## Trademarks |
28 | 18 |
|
29 | | -This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft |
30 | | -trademarks or logos is subject to and must follow |
| 19 | +This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft |
| 20 | +trademarks or logos is subject to and must follow |
31 | 21 | [Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). |
32 | 22 | Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. |
33 | 23 | Any use of third-party trademarks or logos are subject to those third-party's policies. |
0 commit comments