Codecom

Table of Contents

• Introduction
• Motivation
• Features
• Installation
• Usage
• Contribution
• License

Introduction

The name, comes from the words "Code" and "Competition".

Codecom is being developed using the Performance API to measure the execution time of JavaScript code and to display the results both within the terminal and in an HTML file, allowing them to be viewed in the browser as well.

Motivation

When developing a software, usually, attention is not paid to the milisecond-level execution time of the code. However, in some cases;

• When the application will run on a device with limited resources.
• When evaluating and improving the performance of the code.
• When processing big data, deciding on the optimal solution method.
• When comparing the performance of different codes.
• When seeking to enhance the user experience by reducing the waiting time of the user.

In such cases, it is necessary to measure the execution time of the code and to compare the results.

Codecom, is being developed to make this process easier and more enjoyable.

Try it now!

Features

• No dependencies
• Easy to use
• No magic
• Just simple use and effective

Installation

npm install codecom

Create a new file named codecom.mjs in the root directory of your project and add the following code into it.

import codecom from 'codecom'

Usage

To test code,

• Add the // _start() code to the beginning of where your code's scope start.
• Add the // _end() code to the end of where your code's scope end.

Example

// _start()
for (let i = 0; i < 100000; i++) {
  console.log(i)
}
// _end()

Run

Add the following code to the script object in the package.json file.

"codecom": "node --watch codecom.mjs"

Run the following command in the terminal.

npm run codecom

Note

• Automatically the codecom.html file will be created in the root directory of your project.

Tip

• If you want to open automatically the codecom.html file in the browser, you can add the following code to the script object in the package.json file.

"codecom:open": "node --watch codecom.mjs"

and run following command.

npm run codecom:open

Output

Results will be displayed in the terminal and in the codecom.html file.

Terminal result

Browser result

Contribution

I am open to contributions. Please feel free to open an issue or a pull request.

License

Copyright (c) 2024 Emre Yilmaz

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.