@ekino/logger v3.0 #48

tduyng · 2025-02-24T08:21:18Z

Summary

Rewrite @ekino/logger for v3.0

Motivation

It's been so long time the library is not matained
Rewrite this library for adapting the modern Node.js (Typescript, ESM)

What has changed?

Here are the key changes made in this PR:

Rewritten in ESM
Support for dual package (CommonJS and ESM)
Rewritten in TypeScript
Removed many unnecessary dependencies
Replaced yarn with pnpm, which is faster and more convenient with different commands and management
Upgraded GitHub Actions, rewrote some deprecated syntax
Using git-cliff on GitHub Actions for easily customizable CHANGELOG
Replaced ESLint + Prettier with Biome, which is faster, has sufficient rules, and is easier to set up
Rewrote all tests from ava + sinon.js + nyc + ts-node to vitest (compatible with ESM)
Create a benchmark compare with pino.js and winston
Refactored and cleaned up code, focusing on performance, and much more...

Test plan

All unit tests have been correctly rewritten with Vitest
All functional test behaviors are ensured

….write

… parser

…marking

tduyng · 2025-05-23T08:52:00Z

TODO: fix github-action for release and changelog.

Nico385412 · 2025-11-26T17:05:35Z

CONTRIBUTING.md

+
+## How to Contribute
+
+Follow this guide to ensure a smooth contribution process. If you're planning significant work or substantial changes, please create an issue labeled "contribution enquiry" to discuss your proposal. This will help ensure that your work aligns with the project's goals.


The label does not exist

A new contributor cannot add labels, most of the time a member must set the labels for him

Nico385412 · 2025-11-26T17:08:33Z

CONTRIBUTING.md

+2. **Clone Your Fork**  
+   Clone your forked repo to your local machine:
+   ```bash
+   git clone git@github.com:ekino/node-logger.git


Suggested change

git clone git@github.com:ekino/node-logger.git

git clone git@github.com:[YOUR_GITHUB_ACCOUNT]/node-logger.git

since you forked the repository the address is not correct

Nico385412 · 2025-11-26T17:11:35Z

CONTRIBUTING.md

+   Ensure your changes are reliable by including tests. For small patches, a simple test is fine; for new features, create a dedicated test suite.
+
+7. **Coding Style and Conventions**  
+   Maintain the project’s coding standards. Consistent indentation, comments, and style improve readability.


maybe we could invite the contributor to install official biome ext for vscode ? (or any other IDE)
https://biomejs.dev/reference/vscode/

Nico385412 · 2025-11-26T17:17:20Z

benchmarks/README.md

+
+- Benchmark basic
+```bash
+node ./benchmarks/basic.js


Suggested change

node ./benchmarks/basic.js

pnpm run build

node ./benchmarks/basic.js

Nico385412 · 2025-11-26T17:17:34Z

benchmarks/README.md

+- Benchmark with complex object
+
+```bash
+node ./benchmarks/complex.js


Suggested change

node ./benchmarks/complex.js

pnpm run build

node ./benchmarks/complex.js

Nico385412 · 2025-11-26T17:45:55Z

benchmarks/README.md

+Tested on Nodejs 22.10.0
+```bash
+┌─────────┬──────────────────────┬──────────┐
+│ (index) │ library              │ ops/sec  │
+├─────────┼──────────────────────┼──────────┤
+│ 0       │ 'Pino'               │ '26,506' │
+│ 1       │ '@ekino/logger v3.x' │ '21,915' │
+│ 2       │ '@ekino/logger v2.x' │ '18,826' │
+│ 3       │ 'Winston'            │ '4,251'  │
+└─────────┴──────────────────────┴──────────┘
+```


Suggested change

Tested on Nodejs 22.10.0

```bash

┌─────────┬──────────────────────┬──────────┐

│ (index) │ library │ ops/sec │

├─────────┼──────────────────────┼──────────┤

│ 0 │ 'Pino' │ '26,506' │

│ 1 │ '@ekino/logger v3.x' │ '21,915' │

│ 2 │ '@ekino/logger v2.x' │ '18,826' │

│ 3 │ 'Winston' │ '4,251' │

└─────────┴──────────────────────┴──────────┘

```

Tested on Nodejs 24.3.0

Macbook Pro AppleM2 Pro (macos 15.7.2)

```bash

┌─────────┬──────────────────────┬──────────┐

│ (index) │ library │ ops/sec │

├─────────┼──────────────────────┼──────────┤

│ 0 │ 'Pino' │ '42,089' │

│ 1 │ '@ekino/logger v3.x' │ '31,158' │

│ 2 │ '@ekino/logger v2.x' │ '26,871' │

│ 3 │ 'Winston' │ '2,743' │

└─────────┴──────────────────────┴──────────┘

Nico385412 · 2025-11-26T17:53:57Z

docs/BREAKING_CHANGES.md

+
+- **Dual ESM and CommonJS**: Added support for both module formats. No syntax changes needed from 2.x.
+- **Functional style**: Refactored to use a fully functional API, removing internal objects. Update code that accessed internals directly.
+- **Node.js update**: Dropped support for Node 14 and 16. Now compatible with Node 18, 20, 22, and above.


Suggested change

- **Node.js update**: Dropped support for Node 14 and 16. Now compatible with Node 18, 20, 22, and above.

- **Node.js update**: Dropped support for Node 16, and 18. Now compatible with Node 20, 22, 24, and above.

Nico385412 · 2025-11-26T18:00:38Z

examples/cjs/example3.cjs

+
+logger.setNamespaces('namespace:*')
+logger.setLevel('debug')
+//logger.setOutput(logger.outputs.json)


Suggested change

//logger.setOutput(logger.outputs.json)

Nico385412 · 2025-11-26T18:01:49Z

examples/esm/example3.js

+
+logger.setNamespaces('namespace:*')
+logger.setLevel('debug')
+//logger.setOutput(logger.outputs.json)


Suggested change

//logger.setOutput(logger.outputs.json)

Nico385412 · 2025-11-26T18:02:36Z

examples/example3.ts


 logger.setNamespaces('namespace:*')
 logger.setLevel('debug')
 //logger.setOutput(logger.outputs.json)


Suggested change

//logger.setOutput(logger.outputs.json)

tduyng added 30 commits October 21, 2024 16:00

chore(yarn): use yarn v2

4566757

chore(hooks): remove husky, use native githooks

0152daa

chore(deps): use exact version of dev dependencies for better local dev

999ed77

chore(lint): implement biome and remove eslint,prettier

e7db6b8

fix(lint): fix all linter issues

011198e

refactor(outils): remove unused function

bc3100c

refactor: write native colors outils

94c17cb

refactor(examples): give meaningfull messages

f1fd5e1

chore(deps): remove unused eslint and prettier

f9a94a0

refactor(adapters): create wrapper writable stream for process.stdout…

8b83f9f

….write

feat(perf): implement fast-json-stringify for better performance json…

10d473a

… parser

refactor: implement pur functional, avoid mutable internal object

245729d

refactor: separate default config and mutual config

eac80d7

fix: handle correctly dual signature for logMethod

4d6b3d1

feat(perf): implement memorization for caching expensive operations

8d64d9f

refactor: separate json schema for fast-json-stringify

afd4099

fix: fast-json-stringify do not support replacer

ccbb2c6

feat(3.0): convert src code to ESM

eb0efdc

feat(3.0): remove ts-node, use tsx, convert examples to typescript

dfe49fb

chore(3.0): ignore format package.json by biome

109b4e1

feat(3.0): support more colors

efb6522

chore(3.0): support dual npm package in ESM and CJS

70735b5

chore(3.0): set Node.js 18 as the minimum supported version

3a0f647

chore(3.0): remove unused Makefile

53d8730

ci(3.0): fix, update action versions, run test on Nodejs18,20,22

47c134a

ci(3.0): simplify release step and build Typescript files

2afacab

chore(3.0): run examples/*.ts with deno for faster execution

5ac9e32

chore(3.0): remove unused dependencies

8d79fb5

chore(3.0): add more tags

2a886fc

ci(3.0): add issue templates: bug, feature_request

9effe33

tduyng added 25 commits October 28, 2024 12:17

chore(3.0): add CONTRIBUTION rules

0af815e

docs(3.0): add breaking change docs

cfd1858

ci(3.0): add type checking step

708b16f

docs(3.0): create benchmark with v2, winston and pino

cbee334

perf(3.0): early return log when not forcing and not active level

61decaf

perf(3.0): avoid using Object.assign

783a6a8

docs(3.0): add benchmarks results

2087ee3

chore(3.0): add benchmark for complex objects

1c68174

chore(3.0): simplify and split and create helpers functions for bench…

7686758

…marking

chore(3.0): remove tsx, write build script directly in js

7632fbb

chore(3.0): off useImportType lint rule

42164ed

test(3.0): use correct type MockInstance for vi.spyOn

bbef8d2

ci(3.0): implement git cliff for highly customizable changelog

92c563e

chore(3.0): update the dev dependencies

434899d

chore(3.0): replace yarn by pnpm

7ecafb4

chore(3.0): upgrade dev dependencies

2f12694

feat(3.0): remove fast-json-stringify

92d8ad5

chore(3.0): simplify build scripts

06627ef

chore(deps): update latest dependencies

778db14

ci: setup bot user for creating release commit

d0f73e6

ci: simplify bump version and tag with npm

8392aa3

feat: use @tduyng/prettyouput to replace deprecated prettyoutput library

90d1bd9

docs: update README.md

6780446

chore(deps): use major version for dependencies field

a933b2f

ci: check typings for all files

ef6856e

tduyng added 3 commits November 26, 2025 14:46

feat: remove support for node18, support test for node24

b025478

chore: update dev dependencies

bef39aa

chore: move prettyoutput to optional dependencies, not always needed

7b4626e

Nico385412 reviewed Nov 26, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

@ekino/logger v3.0 #48

@ekino/logger v3.0 #48

Uh oh!

tduyng commented Feb 24, 2025

Uh oh!

tduyng commented May 23, 2025

Uh oh!

Nico385412 Nov 26, 2025

Uh oh!

Nico385412 Nov 26, 2025

Uh oh!

Nico385412 Nov 26, 2025

Uh oh!

Nico385412 Nov 26, 2025

Uh oh!

Nico385412 Nov 26, 2025

Uh oh!

Nico385412 Nov 26, 2025

Uh oh!

Nico385412 Nov 26, 2025

Uh oh!

Nico385412 Nov 26, 2025

Uh oh!

Nico385412 Nov 26, 2025

Uh oh!

Nico385412 Nov 26, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants


		## How to Contribute

		Follow this guide to ensure a smooth contribution process. If you're planning significant work or substantial changes, please create an issue labeled "contribution enquiry" to discuss your proposal. This will help ensure that your work aligns with the project's goals.

	git clone git@github.com:ekino/node-logger.git
	git clone git@github.com:[YOUR_GITHUB_ACCOUNT]/node-logger.git

	node ./benchmarks/basic.js
	pnpm run build
	node ./benchmarks/basic.js

	node ./benchmarks/complex.js
	pnpm run build
	node ./benchmarks/complex.js

	- Node.js update: Dropped support for Node 14 and 16. Now compatible with Node 18, 20, 22, and above.
	- Node.js update: Dropped support for Node 16, and 18. Now compatible with Node 20, 22, 24, and above.

@ekino/logger v3.0 #48

Are you sure you want to change the base?

@ekino/logger v3.0 #48

Uh oh!

Conversation

tduyng commented Feb 24, 2025

Summary

Motivation

What has changed?

Test plan

Uh oh!

tduyng commented May 23, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants