derhuerst/util-inspect-cli

add support for (static) JS input

Open

#1 opened on Jan 26, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (0 forks)github user discovery
enhancementgood first issue

Repository metrics

Stars
 (1 star)
PR merge metrics
 (No merged PRs in 30d)

Description

It would be cool to be able to pipe JS expressions into util-inspect:

echo '{foo: [{bar: 'baz'}]}' | util-inspect --js
# { foo: [ { bar: 'baz' } ] }

It shouldn't evaluate the JS expression though, as e.g. curl | util-inspect might easily get abused then, but it could

  1. parse the JS using acorn
  2. check if its static (only ArrayExpression, ObjectExpression, Property, Identifier, Literal)
  3. evaluate it
  4. inspect it as with JSON input

Contributor guide

Research direction
Inspect the existing CLI code to understand how JSON input is read and parsed. Then integrate the acorn library to parse and validate static JS expressions before evaluating them safely. Follow the step by step plan in the issue.
Tech stack
javascriptnodejs
Domain
clibackend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Node.jsGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70