Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

replace-json-property

Package Overview
Dependencies
Maintainers
1
Versions
19
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

replace-json-property

CLI tool to replace a property in a JSON file

  • 1.8.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
15K
decreased by-18.39%
Maintainers
1
Weekly downloads
 
Created
Source

code style: prettier codecov semantic-release

Logo

This module allows you to replace a specific property in a JSON.

Table of Contents generated with DocToc

Comand line usage

You can use this via the following command:

replace-json-property pathToFile property value

This command replaces all occurences of the matching property. It also replaces occurences in nested objects or objects in arrays.

The following command would replace all values of the foo property with 'test' inside the test.json.

replace-json-property ./test.json foo test,

Executing the command above on the given JSON

{
    "foo": "bar",
    "a": {
        "b": 1,
        "foo": "bar",
        "c": [
            {"d": 1, "foo": "bar"},
            {"d": 2, "foo": "bar"},
            {"d": 3, "foo": "bar"},
        ]
    }
}

results in:

{
    "foo": "test",
   	"a": {
        "b": 1,
        "foo": "test",
        "c": [
            {"d": 1, "foo": "test"},
            {"d": 2, "foo": "test"},
            {"d": 3, "foo": "test"},
        ]
    }
}

Short form

All commands explained above can also be run with the shortcut version rjp.

rjp ./test.json foo test,

Usage from code

You can also use the replace function in your JavaScript code.

  1. Using module imports

    import {replace} from 'replace-json-property';
    
    replace('./environment/test.json', 'foo', 'new value');
    
  2. Using commonjs

    const replaceJSONProperty = require('replace-json-property');
    
    replaceJSONProperty.replace('./environment/test.json', 'foo', 'new value');
    

Options

The following flags allow you to configure how the resulting file is written.

OptionDescriptionDefault
-s or --spacesAdd the spaces the file should be written with, for example (2, 4)2
-e or --eolAdd the line ending the file should be written with, for example "\r\n""\n"
--silentSilent mode. Executes without log messagesFalse
--limitLimit the number of replacements0 (unlimited)

Help command

You can always run the help command to see how the signature looks

replace-json-property -h

or

replace-json-property --help

To get the current version use the --version or -v command.

Keywords

FAQs

Package last updated on 07 Oct 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc