Skip to content

Commit 9e2c745

Browse files
amcaseyamcasey
committed
Populate repo
1 parent a468871 commit 9e2c745

19 files changed

+2447
-39
lines changed

‎.gitignore

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
*.js
2+
*.map
3+
*.d.ts
4+
node_modules
5+
*.tsbuildinfo
6+
*.tgz

‎.npmignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
src
2+
package-lock.json
3+
CODE_OF_CONDUCT.md
4+
CONTRIBUTING.md
5+
*.map

‎CONTRIBUTING.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Contributing
2+
3+
This project welcomes contributions and suggestions. Most contributions require you to agree to a
4+
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
5+
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
6+
7+
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
8+
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
9+
provided by the bot. You will only need to do this once across all repos using our CLA.
10+
11+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
12+
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
13+
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
14+
15+
## Building
16+
17+
To build, run `npm ci` to download the required packages and `npm run build` to compile.

‎README.md

+11-21
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,23 @@
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).
23

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.
56

6-
As the maintainer of this project, please make a few updates:
7+
## Usage
78

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`
1210

13-
## Contributing
11+
For a sorted list of compilation hot-spots, run `npx analyze-trace traceDir`
1412

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`
1814

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 [[email protected]](mailto:[email protected]) 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+`
2616

2717
## Trademarks
2818

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
3121
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
3222
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
3323
Any use of third-party trademarks or logos are subject to those third-party's policies.

‎SUPPORT.md

+4-18
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,11 @@
1-
# TODO: The maintainer of this repo has not yet edited this file
2-
3-
**REPO OWNER**: Do you want Customer Service & Support (CSS) support for this product/project?
4-
5-
- **No CSS support:** Fill out this template with information about how to file issues and get help.
6-
- **Yes CSS support:** Fill out an intake form at [aka.ms/spot](https://aka.ms/spot). CSS will work with/help you to determine next steps. More details also available at [aka.ms/onboardsupport](https://aka.ms/onboardsupport).
7-
- **Not sure?** Fill out a SPOT intake as though the answer were "Yes". CSS will help you decide.
8-
9-
*Then remove this first heading from this SUPPORT.MD file before publishing your repo.*
10-
111
# Support
122

13-
## How to file issues and get help
3+
## How to file issues and get help
144

15-
This project uses GitHub Issues to track bugs and feature requests. Please search the existing
16-
issues before filing new issues to avoid duplicates. For new issues, file your bug or
5+
This project uses GitHub Issues to track bugs and feature requests. Please search the existing
6+
issues before filing new issues to avoid duplicates. For new issues, file your bug or
177
feature request as a new Issue.
188

19-
For help and questions about using this project, please **REPO MAINTAINER: INSERT INSTRUCTIONS HERE
20-
FOR HOW TO ENGAGE REPO OWNERS OR COMMUNITY FOR HELP. COULD BE A STACK OVERFLOW TAG OR OTHER
21-
CHANNEL. WHERE WILL YOU HELP PEOPLE?**.
22-
23-
## Microsoft Support Policy
9+
## Microsoft Support Policy
2410

2511
Support for this **PROJECT or PRODUCT** is limited to the resources listed above.

‎azure-pipelines.yml

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
pr:
2+
- main
3+
4+
pool:
5+
name: VSEngSS-MicroBuild2019-1ES
6+
7+
variables:
8+
TeamName: TypeScript
9+
10+
steps:
11+
- task: NuGetToolInstaller@1
12+
inputs:
13+
versionSpec: '5.x'
14+
- task: CredScan@3
15+
- task: PoliCheck@2
16+
- task: AntiMalware@4
17+
- task: PublishSecurityAnalysisLogs@3
18+
- task: PostAnalysis@2
19+
20+
- task: NodeTool@0
21+
inputs:
22+
versionSpec: '14.x'
23+
displayName: 'Install Node.js'
24+
- script: |
25+
npm ci
26+
npm run build
27+
displayName: 'npm install and build'
28+
29+
- task: MicroBuildCleanup@1

‎bin/analyze-trace

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
#!/usr/bin/env node
2+
require('../dist/analyze-trace-dir.js')

‎bin/print-trace-types

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
#!/usr/bin/env node
2+
require('../dist/print-types.js')

‎bin/simplify-trace-types

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
#!/usr/bin/env node
2+
require('../dist/simplify-types-file.js')

0 commit comments

Comments
 (0)