feat: add --stdin flag

[danielpza]

Passing the --stdin flag would make it so it reads from stdin and outputs to stdout. This is useful for some tools/editors integration

Usage example:

$ cat package.json | sort-package-json --stdin

Closes #293

[fisker]

Is it possible to test?

[fisker]

Maybe we can use child_process or worker_thread to do that.

[danielpza]

Is it possible to test?
Maybe we can use child_process or worker_thread to do that.

Added some tests in 14bb2fb (#296)

[fisker]

I forgot we already use child_process to run CLI test, we can add an option to accept stdin.

sort-package-json/tests/_helpers.js

Line 175 in 2789f2f

function runCLI({ args = [], cwd = process.cwd() }) {

But it can be done in future, since it's not important.

[danielpza]

I forgot we already use child_process to run CLI test, we can add an option to accept stdin.

Applied these changes in f7c3b6f (#296)

[fisker]

We have --check flag. Do you think we should support cat package.json | sort-package-json --stdin --check?

[danielpza]

We have --check flag do you think we should support cat package.json | sort-package-json --stdin --check?

I considered adding support for the other flags, but it's not a priority for my use case. I guess we can add more support in the future if needed

[fisker]

LGTM, thank you!

[keithamus]

I'm not particularly precious about this, but it makes me think; would --file <path>/-F <path> be a better option here - where one can use - to use stdin. This is how git does it (git commit -F my-template or echo foo | git commit -F -).

[fisker]

We plan to use util.parseArgs #283, not sure if it supports that.

[keithamus]

> util.parseArgs({args: ['-f', '-'], options: {file: {type: 'string', short: 'f' }}})
{ values: [Object: null prototype] { file: '-' }, positionals: [] }

Looks like it does?

[danielpza]

Is there any blocker for this PR, any chance to get it merged otherwise?

[keithamus]

Thanks for the reminder @danielpza! 🎉🎉

[github-actions]

🎉 This PR is included in version 2.5.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀