Скачать или смотреть How to Properly Format and Save JSON Files Using Node.js

Discover a simple guide to format and save JSON files with indentation using Node.js. Learn best practices in handling file operations and JSON manipulations effectively!
---
This video is based on the question https://stackoverflow.com/q/62309721/ asked by the user 'Anon' ( https://stackoverflow.com/u/10139429/ ) and on the answer https://stackoverflow.com/a/62309780/ provided by the user 'Niklas E.' ( https://stackoverflow.com/u/7638119/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: Format JSON and save it using NodeJS

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
Formatting JSON in Node.js: A Guide for Developers

Working with JSON (JavaScript Object Notation) files is a common task for developers, especially when handling configurations or data interchange between applications. However, one challenge many face is the lack of readability in JSON files due to the absence of indentation. This post will address a common problem where developers need to format existing valid JSON files to make them more readable and organized.

The Problem

You may have encountered a situation where you generated JSON files using a tool, and although they are valid, they look cluttered and hard to read. For instance, JSON files without any indentation can be difficult to debug and understand. It is essential to have a well-formatted JSON for better readability and maintenance.

The Solution

To solve the issue of formatting JSON files with proper indentation using Node.js, here’s a well-structured approach with a practical example. We will utilize the fs module to handle file operations, which comes built into Node.js.

Step-by-Step Implementation

Read Directory: First, we need to read the directory that contains the JSON files.

Read Each JSON File: We will read each file to retrieve its contents.

Format the JSON: By using JSON.stringify() together with JSON.parse(), we can format the file with proper indentation.

Save the Formatted JSON: Finally, the formatted JSON will be saved back into the original files.

Example Code

Here’s a sample code snippet that illustrates these steps:

[[See Video to Reveal this Text or Code Snippet]]

Explanation of the Code

Read Directory: The fs.readdir function reads all files within the specified directory. If an error occurs, it logs the error instead of stopping the program.

Iterate Through Files: The forEach method iterates over each file in the directory.

Read Each JSON File: fs.readFile reads the content of each JSON file. The encoding is set to utf-8 to get the content as a string.

Format JSON:

Parsing and Stringifying: The snippet uses JSON.stringify(JSON.parse(data), null, 4) for formatting:

JSON.parse(data) converts the string data back into a JSON object.

JSON.stringify(object, null, 4) converts the JSON object back into a string with indentation (4 spaces in this case).

Write Formatted Data: fs.writeFile saves the new formatted JSON back to the original file, also specifying utf8 for encoding.

Conclusion

By following this guide, you should now be able to format and save JSON files correctly with indentation using Node.js. This not only enhances the readability of the files but also makes debugging and maintaining the codebase much easier. Remember, clear and organized code is a hallmark of good development practices. Happy coding!