JSON5

import { parse, stringify } from 'json5';

const JSON5 = require('json5');
// Access via: JSON5.parse, JSON5.stringify

import { parse, stringify } from 'json5';

// Parse JSON5 string
const data = parse(`{
  // comments are allowed
  unquoted: 'and you can quote me on that',
  singleQuotes: 'I can use "double quotes" here',
  lineBreaks: "Look, Mom! \\
No \\n's!",
  hexadecimal: 0xdecaf,
  leadingDecimalPoint: .8675309,
  andTrailing: 8675309.,
  positiveSign: +1,
  trailingComma: 'in objects',
  andIn: ['arrays',],
}`);

// Convert JavaScript value to JSON5 string
const json5String = stringify(data, null, 2);

/**
 * Parses a JSON5 string, constructing the JavaScript value or object described
 * by the string.
 * @template T The type of the return value.
 * @param text The string to parse as JSON5.
 * @param reviver A function that prescribes how the value originally produced
 * by parsing is transformed before being returned.
 * @returns The JavaScript value converted from the JSON5 string.
 */
function parse<T = any>(
    text: string,
    reviver?: ((this: any, key: string, value: any) => any) | null,
): T

import { parse } from 'json5';

// Basic parsing
const config = parse(`{
  name: 'MyApp',
  version: '1.0.0',
  debug: true,
}`);

// With reviver function
const data = parse(`{
  created: "2023-01-01",
  count: "42"
}`, (key, value) => {
  if (key === 'created') return new Date(value);
  if (key === 'count') return parseInt(value);
  return value;
});

/**
 * Converts a JavaScript value to a JSON5 string.
 * @param value The value to convert to a JSON5 string.
 * @param replacer A function that alters the behavior of the stringification
 * process. If this value is null or not provided, all properties of the object
 * are included in the resulting JSON5 string.
 * @param space A String or Number object that's used to insert white space into
 * the output JSON5 string for readability purposes. If this is a Number, it
 * indicates the number of space characters to use as white space; this number
 * is capped at 10 (if it is greater, the value is just 10). Values less than 1
 * indicate that no space should be used. If this is a String, the string (or
 * the first 10 characters of the string, if it's longer than that) is used as
 * white space. If this parameter is not provided (or is null), no white space
 * is used. If white space is used, trailing commas will be used in objects and
 * arrays.
 * @returns The JSON5 string converted from the JavaScript value.
 */
function stringify(
    value: any,
    replacer?: ((this: any, key: string, value: any) => any) | null,
    space?: string | number | null,
): string

/**
 * Converts a JavaScript value to a JSON5 string.
 * @param value The value to convert to a JSON5 string.
 * @param replacer An array of String and Number objects that serve as a
 * allowlist for selecting/filtering the properties of the value object to be
 * included in the JSON5 string. If this value is null or not provided, all
 * properties of the object are included in the resulting JSON5 string.
 * @param space A String or Number object that's used to insert white space into
 * the output JSON5 string for readability purposes. If this is a Number, it
 * indicates the number of space characters to use as white space; this number
 * is capped at 10 (if it is greater, the value is just 10). Values less than 1
 * indicate that no space should be used. If this is a String, the string (or
 * the first 10 characters of the string, if it's longer than that) is used as
 * white space. If this parameter is not provided (or is null), no white space
 * is used. If white space is used, trailing commas will be used in objects and
 * arrays.
 * @returns The JSON5 string converted from the JavaScript value.
 */
function stringify(
    value: any,
    replacer: (string | number)[],
    space?: string | number | null,
): string

/**
 * Converts a JavaScript value to a JSON5 string.
 * @param value The value to convert to a JSON5 string.
 * @param options An object specifying options.
 * @returns The JSON5 string converted from the JavaScript value.
 */
function stringify(value: any, options: StringifyOptions): string

import { stringify } from 'json5';

const data = {
  name: 'MyApp',
  version: '1.0.0',
  debug: true,
  features: ['auth', 'api', 'ui']
};

// Basic stringification
const json5 = stringify(data);

// With formatting
const formatted = stringify(data, null, 2);

// With replacer function
const filtered = stringify(data, (key, value) => {
  if (key === 'debug') return undefined; // exclude debug
  return value;
}, 2);

// With property allowlist
const limited = stringify(data, ['name', 'version'], 2);

// With options object (including custom quote character)
const customQuotes = stringify(data, {
  space: 2,
  quote: "'"
});

/**
 * Register JSON5 file extension with Node.js require() system.
 * This extends Node.js to automatically parse .json5 files when required.
 */
require('json5/lib/register');

// Register JSON5 support
require('json5/lib/register');

// Now you can require JSON5 files directly
const config = require('./config.json5');

npm install --global json5

json5 [options] <file>

# Convert JSON5 file to JSON
json5 config.json5

# Convert with formatting
json5 -s 2 config.json5

# Validate JSON5 syntax
json5 -v config.json5

# Convert and save to file
json5 -o config.json config.json5

# Convert and auto-save as .json file (legacy option)
json5 -c config.json5

interface StringifyOptions {
    /**
     * A function that alters the behavior of the stringification process, or an
     * array of String and Number objects that serve as a allowlist for
     * selecting/filtering the properties of the value object to be included in
     * the JSON5 string. If this value is null or not provided, all properties
     * of the object are included in the resulting JSON5 string.
     */
    replacer?:
        | ((this: any, key: string, value: any) => any)
        | (string | number)[]
        | null

    /**
     * A String or Number object that's used to insert white space into the
     * output JSON5 string for readability purposes. If this is a Number, it
     * indicates the number of space characters to use as white space; this
     * number is capped at 10 (if it is greater, the value is just 10). Values
     * less than 1 indicate that no space should be used. If this is a String,
     * the string (or the first 10 characters of the string, if it's longer than
     * that) is used as white space. If this parameter is not provided (or is
     * null), no white space is used. If white space is used, trailing commas
     * will be used in objects and arrays.
     */
    space?: string | number | null

    /**
     * A String representing the quote character to use when serializing
     * strings.
     */
    quote?: string | null
}

import { parse, stringify } from 'json5';

try {
  const data = parse(json5String);
  const output = stringify(data);
} catch (error) {
  console.error('JSON5 operation failed:', error.message);
}