feat: add descriptions for performance

README.md

@@ -13,6 +13,20 @@ This library automatically generates TypeScript types (`*.d.ts`) by parsing Goog
 - [Parser presets](./src/parser) and Generate types(`*.d.ts`) for **public and private Google Sheets**
 - Customize the type and type file name
 
+### Performance
+
+```
+MacBook Air (M1, 2020, 16GB)
+Node.js v20.10.0
+
+$ pnpm bench
+
+name                                 hz      min      max     mean      p75      p99     p995     p999      rme  samples
+generateDtsFile :: 100000 Rows  18.4037  45.8886  75.3858  54.3369  57.0195  75.3858  75.3858  75.3858  ±12.36%       10   fastest
+```
+
+[performance.bench.ts](./src/__tests__/performance.bench.ts)
+
 ## 📦 Install
 
 ```bash

package.json

@@ -45,6 +45,7 @@
     "build": "tsc && vite build",
     "lint": "eslint --ext .ts ./**/src/**.ts",
     "test": "vitest run --coverage",
+    "bench": "vitest bench --run",
     "release": "standard-version",
     "prepare": "husky"
   },

src/__tests__/performance.bench.ts

@@ -0,0 +1,24 @@
+import { describe, bench } from 'vitest';
+import { generateDtsFile } from '..';
+import { resolve } from 'node:path';
+
+const src = resolve(__dirname, '../');
+
+describe('Benchmarking', () => {
+  bench('generateDtsFile :: 100000 Rows', async () => {
+    const largeObject = [...Array(100000).keys()].reduce<object>((acc, cur) => {
+      // @ts-expect-error - This is a test
+      acc[`key${cur}`] = cur;
+      return acc;
+    }, {});
+
+    await generateDtsFile({
+      name: 'GenerateDtsFile',
+      directory: resolve(src, './__tests__'),
+      parser: () => largeObject,
+      options: {
+        output: () => {},
+      },
+    });
+  });
+});