README
edit-json-file
Edit a json file with ease.
:cloud: Installation
# Using npm
npm install --save edit-json-file
# Using yarn
yarn add edit-json-file
:clipboard: Example
const editJsonFile = require("edit-json-file");
// If the file doesn't exist, the content will be an empty object by default.
let file = editJsonFile(`${__dirname}/foo.json`);
// Set a couple of fields
file.set("planet", "Earth");
file.set("city\\.name", "anytown");
file.set("name.first", "Johnny");
file.set("name.last", "B.");
file.set("is_student", false);
//Create or append to an array
file.append("classes", "fysics");
//You can even append objects
file.append("classes", { class: "Computer Science", where: "KULeuven" });
// Output the content
console.log(file.get());
// { planet: 'Earth',
// city.name: 'anytown',
// name: { first: 'Johnny', last: 'B.' },
// is_student: false,
// classes: [
// 'fysics',
// {
// 'class': 'Computer Science',
// 'where': 'KULeuven'
// }
// ]
// }
//if you want to remove the last element from an array use pop
file.pop("classes")
// Save the data to the disk
file.save();
// Reload it from the disk
file = editJsonFile(`${__dirname}/foo.json`, {
autosave: true
});
// Get one field
console.log(file.get("name.first"));
// => Johnny
// This will save it to disk
file.set("a.new.field.as.object", {
hello: "world"
});
// Output the whole thing
console.log(file.toObject());
// { planet: 'Earth',
// name: { first: 'Johnny', last: 'B.' },
// is_student: false,
// a: { new: { field: [Object] } } }
:question: Get Help
There are few ways to get help:
- Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
- For bug reports and feature requests, open issues. :bug:
- For direct and quick help, you can use Codementor. :rocket:
:memo: Documentation
JsonEditor(path, options)
Params
- String
path
: The path to the JSON file. - Object
options
: An object containing the following fields: stringify_width
(Number): The JSON stringify indent width (default:2
).stringify_fn
(Function): A function used byJSON.stringify
.stringify_eol
(Boolean): Wheter to add the new line at the end of the file or not (default:false
)ignore_dots
(Boolean): Wheter to use the path including dots or have an object structure (default:false
)autosave
(Boolean): Save the file when setting some data in it.
Return
- JsonEditor The
JsonEditor
instance.
set(path, value)
Set a value in a specific path.
Params
- String
path
: The object path. - Anything
value
: The value.
Return
- JsonEditor The
JsonEditor
instance.
get(path)
Get a value in a specific path.
Params
- String
path
:
Return
- Value The object path value.
unset(path)
Remove a path from a JSON object.
Params
- String
path
: The object path.
Return
- JsonEditor The
JsonEditor
instance.
append(path, value)
Appends a value/object to a specific path. If the path is empty it wil create a list.
Params
- String
path
: The object path. - Anything
value
: The value.
Return
- JsonEditor The
JsonEditor
instance.
append(path)
pop Pop an array from a specific path.
Params
- String
path
: The object path.
Return
- JsonEditor The
JsonEditor
instance.
read(cb)
Read the JSON file.
Params
- Function
cb
: An optional callback function which will turn the function into an asynchronous one.
Return
- Object The object parsed as object or an empty object by default.
read(The, cb)
write Write the JSON file.
Params
- String
The
: file content. - Function
cb
: An optional callback function which will turn the function into an asynchronous one.
Return
- JsonEditor The
JsonEditor
instance.
empty(cb)
Empty the JSON file content.
Params
- Function
cb
: The callback function.
save(cb)
Save the file back to disk.
Params
- Function
cb
: An optional callback function which will turn the function into an asynchronous one.
Return
- JsonEditor The
JsonEditor
instance.
toObject()
Return
- Object The data object.
editJsonFile(path, options)
Edit a json file.
Params
- String
path
: The path to the JSON file. - Object
options
: An object containing the following fields:
Return
- JsonEditor The
JsonEditor
instance.
:yum: How to contribute
Have an idea? Found a bug? See how to contribute.
:sparkling_heart: Support my projects
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
Starring and sharing the projects you like :rocket:
—I love books! I will remember you after years if you buy me one. :grin: :book:
—You can make one-time donations via PayPal. I'll probably buy a
coffeetea. :tea:—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
Bitcoin—You can send me bitcoins at this address (or scanning the code below):
1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6
Thanks! :heart:
:dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:
@airbnb/nimbus
json-config-ts
@formbird/core
@dolittle/vanir-cli
@williarts/williarts-commons
menreiki2
@wonderland/cli-plugin-new
@wonderland/cli-plugin-serverless
soft-add-dependencies
next-nodecms
@neutralinojs/neu
gyaon-cli
@allmywallets/specification
easybackup
pandocuments
deyarn
menreiki
webify-generator
live-stream-radio
sheetbase-cli
uiseeds
extracct
blip-lang
returrn
@malmo/cli
@xploration-tech/xtouch
env-to-now-json
@fanxie/cli
@superjs/require-auto
sisback
lyo
lazlodb
jad-node-ts-kit
zoral-generator
fix-package-versions
blazar-cli
ss-clean-slate
git-normalize
react-native-dom-expo
fixed-minor-patch-package-json
pipe-boy
node-rg
@hyron/cli
noir-wp-cli
@johnlindquist/next-lesson
bt-translate
deployqb
create-next-library
react-easy-boilerplate
cmd-assistant
push-notifier
@perlatsp/devild
@kcom/package-tools
grafpad
kanuki-cli
bucket-cli
axereos-hopes
admooh-cli
@aquestsrl/create-app-cli
intelliter
karmacv-themes
gitversion-tool
@wonderland/new
@openstfoundation/openst-platform
cucu-generator
typescript-fastify-starter
typescript-koa-starter
typescript-react-starter
typescript-react-native-starter
project-initializer
package-to-local
express-react-generator-typescript
react-sgh-scaffolding
striplet
iffe-cli
vcommit-cli
generator-brei-next
bhc-cli
iffe-commit
@empirica/meteor-deploy
express-generator-typescript-k8s
robinhood-yolo
create-itk-app
malmo
new-express-app
monstro
@marvinkome/create-node-app
@triptyk/nfw-cli
jollof-cli
jollofjs
ootb-express-app
@postlight/node-typescript-starter-kit
@anyopsos/cli
mongoose-auto-api.cli
tail-react
@wizwarrior/node.ts
typescript-nest-starter
@aburkov/scripts
d-bot-script
guser
@frdl/frdl
@frdl/legacy-and-deprecations-fallback
forcemanager-cli
typescript-vue-starter
bloggify-tools
node-file-rev
simple-webpack-starter
bo-api-starter
grelease
@rajzik/lumos
@sevta/cli
plop-pack-gatsby-starter
baelte-cli
ontrac
@chakra-ui/codemod
def-struct
@farazahmad759/dricup-crud-express
plop-pack-sanity-starter
@acanto/october-scripts
@acanto/workflow
create-express-template
dricup
@dricup/dricup-cli
dricup-cli
modern-project-generator
@dolittle/webpack
@jianghe/sand-cli
cli-json-edit
@hayes0724/shopify-packer
@teamhive/angular-npm-seed
@elastosfoundation/trinity-cli
generator-brei-app
my-chakra-ui
create-express-typescript-application
@mianfrigo/express-typescript-generator
@s-ui/changelog
dex-cli
@ps-devs/shopify-webpack
@j.u.p.iter/jupiter-scripts
@acanto/laravel-scripts
create-nuxt-typescript-component
kikd
kape
semcom
@tinyhttp/cli
@bronzw/create-discord-js-bot
@grogqli/server
nipinit
typescript-express-starter
@something.technology/core
@oriflame/lumos
express-generator-typescript
@dolittle/vanir-common