ts-performance-analyzer

KO | EN

gitlite — search

#python #typescript #llm #golang #android #linux #awesome #kubernetes #vue #awesome-list #security #pytorch #mcp #open-source

ts-performance-analyzer

(★ 9)

🛠️ package designed to help developers understand and optimize the performance of their TypeScript projects.

ts-performance-analyzer 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# TypeScript Performance Analyzer

![TypeScript](https://img.shields.io/badge/TypeScript-4.0+-blue.svg)
![License](https://img.shields.io/badge/license-MIT-green.svg)

## Overview

The **TypeScript Performance Analyzer** is a package designed to help developers understand and optimize the performance of their TypeScript projects. It provides insights into the number of files, lines, and types in a project, and measures the time taken for type-checking. The tool also offers suggestions for improving performance, making it an invaluable resource for large-scale TypeScript applications.

## Features

- Analyze the performance of TypeScript type-checking
- Generate reports with details on the total number of files, lines, and types
- Provide suggestions for optimizing type-checking performance
- Easy integration with existing TypeScript projects

## Installation

Install via NPM:

```bash

npm i ts-performance-analyzer

```

## Features

This will generate a performance report with details about your TypeScript project, including:

- Total number of files
- Total lines of code
- Total types found
- Time taken for type-checking
- Performance improvement suggestions
- Performance of a specific function in a file (Total Execution Time and Its Memory Occupation)

## Usage

1. Import the library in your code

```bash
import TypeScriptPerformanceAnalyzer from "ts-performance-analyzer";
```

2. Instantiate the class and pass the parameter of the root directory of your project

```bash
const analyzer = new TypeScriptPerformanceAnalyzer("path_to_your_project");
```

3. In your package.json, make sure to add

```bash

"type": "module",
	"scripts": {
		"start": "node --loader ts-node/esm <path_to_your_index_file>"
	},

```

4. Choose either testing the performance of the overall project or a specific function in a file

## Testing overall performance of the project

```bash

const report = analyzer.analyze();

console.log("Performance Report:");
console.log(`Total Files: ${report.totalFiles}`);
console.log(`Total Lines: ${report.totalLines}`);
console.log(`Total Types: ${report.totalTypes}`);
console.log(`Type Checking Time: ${report.typeCheckingTime}ms`);

```

Sample Output:

```bash

Performance Report:
Total Files: 155
Total Lines: 113949
Total Types: 3688
Type Checking Time: 350.0381ms

```

## Testing execution time and memory usage of a specific function

Base conditions for function performance analyzer</br></br>
Accepted:
- Default functions
- Functions that are arrow functions
- Functions that are asynchronous functions

Not Accepted:
- Functions that are exported
- Functions that are constructors
- Functions that are static methods
- Functions that are class methods

```bibtext
line.includes(`async function ${functionName}`) ||
line.includes(`const ${functionName} = async`) ||
line.includes(`const ${functionName} = `) ||
line.includes(`function ${functionName}`) ||
```

``` bash
 const foo = async () => {
  	const result = await analyzer.functionPerformance(
		__dirname, -> root_dir
		"/tests/test.ts", -> path
		"bubble" -> function_name
	 );

return {
   time: result.totalTime,
   space: result.totalSpace
  }
 }

foo().then((res) => {
		console.log("Function Performance Report:");
		console.log(`Function Total Time Execution: ${res.totalTime}ms`);
		console.log(`Function Memory Space: ${res.totalSpace}`);
	})

```

Sample Output:

```bash
Function Performance Report:
Function Total Time Execution: 0.037699999999858846ms
Function Memory Space: 1.73 KB

```

## Contributing

If you'd like to contribute to the project, please follow these steps:

1. Fork the repository
2. Create a new branch (git checkout -b feature/my-feature)
3. Commit your changes (git commit -am 'Add new feature')
4. Push to the branch (git push origin feature/my-feature)
5. Create a new Pull Request

## License

This project is licensed under the MIT License.

## Author
Francis Tin-ao.

ts-performance-analyzer

ts-performance-analyzer 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

ts-performance-analyzer

ts-performance-analyzer 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README