🔭 NodeSand

NodeSand is a powerful CLI utility tool that provides various tools for experimenting with simple code or benchmarking in a Node.js environment.

Tue Jan 31 2023 09:03:30 GMT+0900 (Korean Standard Time)
==================================================
⠋ Main function is running...
Hello, World!
✔ Done!
==================================================
50.02708297967911 ms

• Serve static HTML file
• Code benchmarking
• TypeScript support
• ESLint & Prettier support
• Observation mode
• Execution time report

We recommend using Node.js version 20 or higher to use NodeSand.

$ npm init nodesand

Before you begin, you need to install the dependent packages.

$ npm i
# or...
$ pnpm i

Source files of node scripts (dev, once, watch) are located in src/node/index.js. When all the actions are done, we call next() to end execution.

Run the script at once with the following command:

$ npm run once
or
$ npm run dev

Run whenever the script file changes with the following command:

$ npm run watch

You can run benchmarks using various code comparison sets in Node.js. (We use Tinybench for benchmarking.)

Write the code in src/bench/index.js as follows:

export const benchConfiguration = { name: 'Benchmark', time: 100 };

export default function defineBenchmarks(bench) {
  bench
    .add('faster task', () => {
      console.log('I am faster');
    })
    .add('slower task', async () => {
      await new Promise((resolve) => setTimeout(resolve, 1)); // we wait 1ms :)
      console.log('I am slower');
    });
}

Then simply run the following command:

$ npm run bench

Then the benchmarking results will be displayed as shown in the example below.

✔ Done!
===========================================
Benchmark:
791.840458 ms
┌─────────┬───────────────┬───────────────────┬────────────────────┬────────────────────────┬────────────────────────┬─────────┐
│ (index) │ Task name     │ Latency avg (ns)  │ Latency med (ns)   │ Throughput avg (ops/s) │ Throughput med (ops/s) │ Samples │
├─────────┼───────────────┼───────────────────┼────────────────────┼────────────────────────┼────────────────────────┼─────────┤
│ 0       │ 'faster task' │ '3861.8 ± 2.74%'  │ '3500.0 ± 166.00'  │ '277861 ± 0.12%'       │ '285714 ± 12937'       │ 25895   │
│ 1       │ 'slower task' │ '1147313 ± 3.46%' │ '1174041 ± 9520.5' │ '1642 ± 66.76%'        │ '852 ± 7'              │ 88      │
└─────────┴───────────────┴───────────────────┴────────────────────┴────────────────────────┴────────────────────────┴─────────┘

Changes in HTML files as well as node scripts can be displayed immediately in a web browser.

Source files of HTML files are located in src/www/index.html.

To serve a static HTML file, run the following command:

$ npm run serve
or
$ npm run www

Now you can try opening the HTML file with http://localhost:3000. Any changes will be updated immediately. (requires refresh)

Use the command below to quickly reset the code to its initial state:

# Code reset
$ npm run reset
# Additionally, initialize `package.json` and reset the modules.
$ npm run reset:all

Anyone can contribute to the project by reporting new issues or submitting a pull request. For more information, please see CONTRIBUTING.md.

Please see the LICENSE file for more information about project owners, usage rights, and more.