JSON to Pretty YAML Converter

Common errors

• TypeError: (0 , json_to_pretty_yaml_1.stringify) is not a function

  cause Attempting to use ES module `import { stringify } from 'json-to-pretty-yaml';` in an ES module context.
  fix If in an ES module environment, you must dynamically import: `const YAML = await import('json-to-pretty-yaml');` and then `YAML.default.stringify(...)`. In a CommonJS environment, use `const YAML = require('json-to-pretty-yaml');`.

• Cannot find module 'json-to-pretty-yaml'

  cause The package is not installed or the import path is incorrect.
  fix Ensure the package is installed: `npm install json-to-pretty-yaml`. Verify the module name is correctly spelled in your `require()` statement.

Warnings

• gotcha This package is CommonJS-only (`require`) and does not natively support ES Modules (`import`). Attempting to `import` it will result in errors.
  Fix: Always use `const YAML = require('json-to-pretty-yaml');` in your Node.js code.
• breaking The package has not been updated in over six years and is considered abandoned. This means no new features, bug fixes, or security patches will be released.
  Fix: For new projects or if security/maintenance is a concern, consider using a actively maintained alternative like `js-yaml` directly, which `json-to-pretty-yaml` wraps.
• gotcha The package depends on `js-yaml@^3.9.0`, which is an old version of the `js-yaml` library. This may expose projects to known vulnerabilities or compatibility issues present in older `js-yaml` releases.
  Fix: Audit your dependency tree. If possible, consider replacing `json-to-pretty-yaml` with a direct dependency on a current version of `js-yaml` to ensure up-to-date security and features.
• gotcha Due to its age, this package might exhibit compatibility issues with very recent Node.js runtime versions or modern JavaScript language features (e.g., async/await within its own codebase, though its API is synchronous).
  Fix: Test thoroughly in your target Node.js environment. If issues arise, migration to a more modern YAML serialization library is recommended.

Install

• npm install json-to-pretty-yaml npm
• yarn add json-to-pretty-yaml yarn
• pnpm add json-to-pretty-yaml pnpm

Imports

• YAML
  wrong:

  import YAML from 'json-to-pretty-yaml';

  correct:

  const YAML = require('json-to-pretty-yaml');

  This package is CommonJS-only. The imported 'YAML' object contains the `stringify` method.
• stringify
  wrong:

  import { stringify } from 'json-to-pretty-yaml';

  correct:

  const { stringify } = require('json-to-pretty-yaml');

  You can destructure the `stringify` method directly if preferred, but it's still a CommonJS `require`.

Quickstart

Demonstrates how to convert a JSON object to a pretty YAML string and save it to a file.

const fs = require('fs');
const path = require('path');
const YAML = require('json-to-pretty-yaml');

// Create a dummy input.json file for demonstration
const inputJsonPath = path.join(__dirname, 'input.json');
const outputYamlPath = path.join(__dirname, 'output.yaml');

const inputJsonContent = {
  "project": "MyAwesomeProject",
  "version": "1.0.0",
  "config": {
    "env": "development",
    "features": [
      "featureA",
      "featureB"
    ]
  },
  "settings": null,
  "enabled": true
};

fs.writeFileSync(inputJsonPath, JSON.stringify(inputJsonContent, null, 2));

// Load the JSON data (or use an object directly)
const json = require(inputJsonPath);

// Convert JSON to YAML
const yamlData = YAML.stringify(json);

// Write the YAML to a file
fs.writeFileSync(outputYamlPath, yamlData);

console.log(`Converted JSON to YAML:
${yamlData}`);
console.log(`Output written to ${outputYamlPath}`);

// Clean up dummy file
fs.unlinkSync(inputJsonPath);
fs.unlinkSync(outputYamlPath);