LinusU / LinusU/node-jsonlines

Avoid use transform directly

Open
#2 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
25
Forks
2
PR merge metrics
No merged PRs in 30d

Description

Hey,

I'm seeing you are using `Transform` directly from Node API.

Event this is currently working, could be don't work if the next Node version change the node version.

Then your module will be broken.

A better approach is use Transform as dependency using [through2](https://www.npmjs.com/package/through2)

In fact, it was created exactly for this reason, I recommend you read this author blog post:
https://r.va.gg/2014/06/why-i-dont-use-nodes-core-stream-module.html

PS: Could be a good opportunity to use it and ship v1.0.0 😄

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the module's direct use of Node's Transform API and review the package manifest for dependency conventions. Replace that usage with through2, then verify that JSON Lines parsing still works and that the package is ready for the proposed v1.0.0 release.

Written by the indexing model from the issue text.

Assessment

Tech stack
node.js
Domain
backend
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.