📝 chore(.eslintignore): ignore README.md file in eslint checks

📝 docs(README.md): add documentation for radix-rapid package and its usage
📊 chore(benchmark): add benchmarking scripts and results for radix-rapid package
The first commit adds an ignore rule for README.md file in eslint checks. The second commit adds documentation for the radix-rapid package and its usage. The third commit adds benchmarking scripts and results for the radix-rapid package.

🎉 feat(http.mjs, utils.mjs): add benchmarking functionality to test server performance
This commit adds benchmarking functionality to the server to test its performance. The benchmarking script uses autocannon to send requests to the server and measure its performance. The benchmarking script is located in `http.mjs`, and the utility functions used by the script are located in `utils.mjs`. The `createServer` function creates a server instance and returns a listener and stats object. The `printEnv` function prints the environment details, and the `printStats` function prints the statistics of the benchmark. The `router` object is used to create routes for the server, and `benchSets` is an array of objects that contain the title of the benchmark and the requests to be sent to the server.

.eslintignore

@@ -1,2 +1,3 @@
 dist
 node_modules
+README.md

README.md

@@ -0,0 +1,156 @@
+[![cover][cover-src]][cover-href]
+[![npm version][npm-version-src]][npm-version-href] 
+[![npm downloads][npm-downloads-src]][npm-downloads-href] 
+[![bundle][bundle-src]][bundle-href] [![JSDocs][jsdocs-src]][jsdocs-href]
+[![License][license-src]][license-href]
+
+# 🌳 radix-rapid
+
+> ✨ Lightweight and fast router for JavaScript based on [Radix Tree](https://en.wikipedia.org/wiki/Radix_tree)🌱.
+
+## 📝 Usage
+
+**Install:**
+
+```sh
+# nyxi
+nyxi radix-rapid
+
+# pnpm
+pnpm i radix-rapid
+
+# npm
+npm i radix-rapid
+
+# yarn
+yarn add radix-rapid
+```
+
+**Import:**
+
+```js
+// ESM
+import { createRouter } from 'radix-rapid'
+
+// CJS
+const { createRouter } = require('radix-rapid')
+```
+
+**Create a router instance and insert routes:**
+
+```js
+const router = createRouter(/* options */)
+
+router.insert('/path', { payload: 'this path' })
+router.insert('/path/:name', { payload: 'named route' })
+router.insert('/path/foo/**', { payload: 'wildcard route' })
+router.insert('/path/foo/**:name', { payload: 'named wildcard route' })
+```
+
+**Match route to access matched data:**
+
+```js
+router.lookup('/path')
+// { payload: 'this path' }
+
+router.lookup('/path/fooval')
+// { payload: 'named route', params: { name: 'fooval' } }
+
+router.lookup('/path/foo/bar/baz')
+// { payload: 'wildcard route' }
+
+router.lookup('/')
+// null (no route matched for/)
+```
+
+## ⚡️ Methods
+
+### ➕ `router.insert(path, data)`
+
+`path` can be static or using `:placeholder` or `**` for wildcard paths.
+
+The `data` object will be returned on matching params. It should be an object like `{ handler }` and not containing reserved keyword `params`.
+
+### 🔍 `router.lookup(path)`
+
+Returns matched data for `path` with optional `params` key if mached route using placeholders.
+
+### ❌ `router.remove(path)`
+
+Remove route matching `path`.
+
+## ⚙️ Options
+
+You can initialize router instance with options:
+
+```ts
+const router = createRouter({
+   strictTrailingSlash: true,
+   routes: {
+      '/foo': {}
+   }
+})
+```
+
+- 🛣️ `routes`: An object specifying initial routes to add
+- 🚦 `strictTrailingSlash`: By default, the router ignores trailing slashes for matching and adding routes. When set to `true`, matching with trailing slashes is handled differently.
+
+### 🔎 Route Matcher
+
+Creates a multi matcher from router tree that can match **all routes** matching path:
+
+```ts
+import { createRouter, toRouteMatcher } from 'radix-rapid'
+
+const router = createRouter({
+   routes: {
+      '/foo': { m: 'foo' }, // Matches /foo only
+      '/foo/**': { m: 'foo/**' }, // Matches /foo/<any>
+      '/foo/bar': { m: 'foo/bar' }, // Matches /foo/bar only
+      '/foo/bar/baz': { m: 'foo/bar/baz' }, // Matches /foo/bar/baz only
+      '/foo/*/baz': { m: 'foo/*/baz' } // Matches /foo/<any>/baz
+   }
+})
+
+const matcher = toRouteMatcher(router)
+
+const matches = matcher.matchAll('/foo/bar/baz')
+
+// [
+//   {
+//     "m": "foo/**",
+//   },
+//   {
+//     "m": "foo/*/baz",
+//   },
+//   {
+//     "m": "foo/bar/baz",
+//   },
+// ]
+```
+
+## ⚡️ Performance
+
+See [benchmark](./benchmark).
+
+
+## 📜 License
+
+[MIT](./LICENSE) - Made with 💞
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/radix-rapid?style=flat&colorA=18181B&colorB=14F195
+[npm-version-href]: https://npmjs.com/package/radix-rapid
+[npm-downloads-src]: https://img.shields.io/npm/dm/radix-rapid?style=flat&colorA=18181B&colorB=14F195
+[npm-downloads-href]: https://npmjs.com/package/radix-rapid
+[bundle-src]: https://img.shields.io/bundlephobia/minzip/radix-rapid?style=flat&colorA=18181B&colorB=14F195
+[bundle-href]: https://bundlephobia.com/result?p=radix-rapid
+[jsdocs-src]: https://img.shields.io/badge/jsDocs.io-reference-18181B?style=flat&colorA=18181B&colorB=14F195
+[jsdocs-href]: https://www.jsdocs.io/package/radix-rapid
+[license-src]: https://img.shields.io/github/license/nyxblabs/radix-rapid.svg?style=flat&colorA=18181B&colorB=14F195
+[license-href]: https://github.com/nyxblabs/radix-rapid/blob/main/LICENSE
+
+<!-- Cover -->
+[cover-src]: https://raw.githubusercontent.com/nyxblabs/radix-rapid/main/.github/assets/cover-github-radix-rapid.png
+[cover-href]: https://💻nyxb.ws

benchmark/README.md

@@ -0,0 +1,110 @@
+# 📊 Benchmark Results
+
+Benchmarks are mainly focusing on benchmarking `lookup` method performance.
+
+Below results are based on my personal PC using Windows 11. You can use provided scripts to test in your own env.
+
+## ⚡️ Direct benchmark
+
+Directly benchmarking `lookup` performance using [benchmark](https://www.npmjs.com/package/benchmark)
+
+Scripts:
+- 🏋️‍♀️ `nyxr bench`
+- 🏋️‍♂️ `nyxr bench:profile` (using [0x](https://www.npmjs.com/package/0x) to generate flamegraph)
+
+
+```
+--- 🧪 Test environment ---
+
+Node.js version: 18.16.0
+radix-rapid version: 0.0.1
+OS: win32
+CPU count: 8
+Current load: [ 0, 0, 0 ]
+
+
+--- 🚧 static route ---
+
+lookup x 18,670,265 ops/sec ±4.69% (76 runs sampled)
+Stats:
+ - /choot: 96837315
+
+--- 🔧 dynamic route ---
+
+lookup x 403,374 ops/sec ±3.18% (63 runs sampled)
+Stats:
+ - /choot/123: 2065943
+ ```
+
+## ⚡️ HTTP Benchmark
+
+
+Using [`autocannon`](https://github.com/mcollina/autocannon) and a simple http listener using lookup for realworld performance.
+
+Scripts:
+- 🚀 `nyxr bench:http`
+
+```
+--- 🧪 Test environment ---
+
+Node.js version: 18.16.0
+radix-rapid version: 0.0.1
+OS: win32
+CPU count: 8
+Current load: [ 0, 0, 0 ]
+
+
+--- 📊 Benchmark: static route ---
+
+Running 10s test @ http://localhost:3000/
+10 connections
+
+
+┌─────────┬──────┬──────┬───────┬──────┬─────────┬─────────┬───────┐
+│ Stat    │ 2.5% │ 50%  │ 97.5% │ 99%  │ Avg     │ Stdev   │ Max   │
+├─────────┼──────┼──────┼───────┼──────┼─────────┼─────────┼───────┤
+│ Latency │ 0 ms │ 0 ms │ 1 ms  │ 2 ms │ 0.13 ms │ 0.65 ms │ 30 ms │
+└─────────┴──────┴──────┴───────┴──────┴─────────┴─────────┴───────┘
+┌───────────┬─────────┬─────────┬─────────┬─────────┬─────────┬─────────┬─────────┐
+│ Stat      │ 1%      │ 2.5%    │ 50%     │ 97.5%   │ Avg     │ Stdev   │ Min     │
+├───────────┼─────────┼─────────┼─────────┼─────────┼─────────┼─────────┼─────────┤
+│ Req/Sec   │ 9663    │ 9663    │ 17183   │ 21935   │ 15848.8 │ 4391.92 │ 9660    │
+├───────────┼─────────┼─────────┼─────────┼─────────┼─────────┼─────────┼─────────┤
+│ Bytes/Sec │ 1.35 MB │ 1.35 MB │ 2.41 MB │ 3.07 MB │ 2.22 MB │ 615 kB  │ 1.35 MB │
+└───────────┴─────────┴─────────┴─────────┴─────────┴─────────┴─────────┴─────────┘
+
+Req/Bytes counts sampled once per second.
+# of samples: 10
+
+159k requests in 10.02s, 22.2 MB read
+Stats:
+ - /choot: 158510
+
+--- 📊 Benchmark: dynamic route ---
+
+Running 10s test @ http://localhost:3000/
+10 connections
+
+
+┌─────────┬──────┬──────┬───────┬──────┬─────────┬─────────┬───────┐
+│ Stat    │ 2.5% │ 50%  │ 97.5% │ 99%  │ Avg     │ Stdev   │ Max   │
+├─────────┼──────┼──────┼───────┼──────┼─────────┼─────────┼───────┤
+│ Latency │ 0 ms │ 0 ms │ 1 ms  │ 2 ms │ 0.14 ms │ 0.56 ms │ 17 ms │
+└─────────┴──────┴──────┴───────┴──────┴─────────┴─────────┴───────┘
+┌───────────┬─────────┬─────────┬─────────┬───────┬─────────┬─────────┬─────────┐
+│ Stat      │ 1%      │ 2.5%    │ 50%     │ 97.5% │ Avg     │ Stdev   │ Min     │
+├───────────┼─────────┼─────────┼─────────┼───────┼─────────┼─────────┼─────────┤
+│ Req/Sec   │ 9663    │ 9663    │ 14935   │ 17631 │ 14243.6 │ 2791.28 │ 9660    │
+├───────────┼─────────┼─────────┼─────────┼───────┼─────────┼─────────┼─────────┤
+│ Bytes/Sec │ 1.64 MB │ 1.64 MB │ 2.54 MB │ 3 MB  │ 2.42 MB │ 475 kB  │ 1.64 MB │
+└───────────┴─────────┴─────────┴─────────┴───────┴─────────┴─────────┴─────────┘
+
+Req/Bytes counts sampled once per second.
+# of samples: 10
+
+142k requests in 10.01s, 24.2 MB read
+Stats:
+ - /choot/123: 142410
+```
+
+

benchmark/direct.mjs

@@ -0,0 +1,29 @@
+/* eslint-disable no-console */
+import Benchmark from 'benchmark' // https://www.npmjs.com/package/benchmark'
+import { benchSets, logSection, printEnv, printStats, router } from './utils.mjs'
+
+async function main() {
+   printEnv()
+
+   for (const bench of benchSets) {
+      logSection(bench.title)
+      const suite = new Benchmark.Suite()
+      const stats = {}
+      suite.add('lookup', () => {
+         for (const req of bench.requests) {
+            const match = router.lookup(req.path)
+            if (!match)
+               stats[match] = (stats[match] || 0) + 1
+            stats[req.path] = (stats[req.path] || 0) + 1
+         }
+      })
+      // eslint-disable-next-line max-statements-per-line
+      suite.on('cycle', (event) => { console.log(String(event.target)) })
+      const promise = new Promise(resolve => suite.on('complete', () => resolve()))
+      suite.run({ async: true })
+      await promise
+      printStats(stats)
+   }
+}
+
+main().catch(console.error)

benchmark/http.mjs

@@ -0,0 +1,41 @@
+import autocannon from 'autocannon' // https://github.com/mcollina/autocannon
+import { listen } from 'earlist'
+import { benchSets, logSection, printEnv, printStats, router } from './utils.mjs'
+
+async function main() {
+   printEnv()
+
+   for (const bench of benchSets) {
+      logSection(`Benchmark: ${bench.title}`)
+      const { listener, stats } = await createServer()
+      const instance = autocannon({
+         url: listener.url,
+         requests: bench.requests,
+      })
+      autocannon.track(instance)
+      process.once('SIGINT', () => {
+         instance.stop()
+         listener.close()
+         process.exit(1)
+      })
+      await instance // Resolves to details results
+      printStats(stats)
+      await listener.close()
+   }
+}
+
+main().catch(console.error)
+
+async function createServer() {
+   const stats = {}
+   const listener = await listen((req, res) => {
+      stats[req.url] = (stats[req.url] || 0) + 1
+      const match = router.lookup(req.url)
+      if (!match)
+         stats[match] = (stats[match] || 0) + 1
+
+      res.end(JSON.stringify((match || { error: 404 })))
+   }, { showURL: false })
+
+   return { listener, stats }
+}

benchmark/utils.mjs

@@ -0,0 +1,53 @@
+/* eslint-disable no-console */
+import { readFileSync } from 'node:fs'
+import os from 'node:os'
+import { createRouter } from 'radix-rapid'
+
+// eslint-disable-next-line max-statements-per-line
+export function logSection(title) { console.log(`\n--- ${title} ---\n`) }
+
+const pkgVersion = JSON.parse(readFileSync(new URL('../package.json', import.meta.url), 'utf8')).version
+
+export function printEnv() {
+   logSection('Test environment')
+   console.log('Node.js version:', process.versions.node)
+   console.log('radix-rapid version:', pkgVersion)
+   console.log('OS:', os.platform())
+   console.log('CPU count:', os.cpus().length)
+   console.log('Current load:', os.loadavg())
+   console.log('')
+}
+
+export function printStats(stats) {
+   console.log(`Stats:\n${Object.entries(stats).map(([path, hits]) => ` - ${path}: ${hits}`).join('\n')}`)
+}
+
+export const router = createRouter({
+   routes: Object.fromEntries([
+      '/hello',
+      '/cool',
+      '/hi',
+      '/helium',
+      '/coooool',
+      '/chrome',
+      '/choot',
+      '/choot/:choo',
+      '/ui/**',
+      '/ui/components/**',
+   ].map(path => [path, { path }])),
+})
+
+export const benchSets = [
+   {
+      title: 'static route',
+      requests: [
+         { path: '/choot' },
+      ],
+   },
+   {
+      title: 'dynamic route',
+      requests: [
+         { path: '/choot/123' },
+      ],
+   },
+]