sapegin/mrm-core

Accepting filePath in `packageJson`

Open

#28 opened on May 29, 2019

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (14 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (33 stars)
PR merge metrics
 (PR metrics pending)

Description

All file related API's accepts the argument to the define file name/path.

json('foo.json')

If the path is absolute, then it simply writes to that absolute path, which silently opens up the possibility to write contents to different directory by passing absolute paths.

json(join(someBasePath, 'foo.json'))

However, this is not possible with the packageJson file. Do you think, we can accept the 2nd argument as the filePath?

Contributor guide

Research direction
Examine the existing packageJson function in mrm core to understand its current signature, then modify it to accept an optional filePath argument similar to the json() function.
Tech stack
javascript
Domain
developer experiencetooling
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.jsJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70