\href{https://travis-ci.org/json5/json5}{\texttt{ }} \mbox{[}\mbox{]}\mbox{[}Coverage Status\mbox{]}

The JSON5 Data Interchange Format (JSON5) is a superset of \href{https://tools.ietf.org/html/rfc7159}{\texttt{ JSON}} that aims to alleviate some of the limitations of JSON by expanding its syntax to include some productions from \href{https://www.ecma-international.org/ecma-262/5.1/}{\texttt{ ECMAScript 5.\+1}}.

This Java\+Script library is the official reference implementation for JSON5 parsing and serialization libraries.\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32512}{}\doxysection{Summary of Features}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32512}
The following ECMAScript 5.\+1 features, which are not supported in JSON, have been extended to JSON5.\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32513}{}\doxysubsection{Objects}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32513}

\begin{DoxyItemize}
\item Object keys may be an ECMAScript 5.\+1 {\itshape \mbox{[}Identifier\+Name\mbox{]}}.
\item Objects may have a single trailing comma.
\end{DoxyItemize}\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32514}{}\doxysubsection{Arrays}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32514}

\begin{DoxyItemize}
\item Arrays may have a single trailing comma.
\end{DoxyItemize}\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32515}{}\doxysubsection{Strings}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32515}

\begin{DoxyItemize}
\item Strings may be single quoted.
\item Strings may span multiple lines by escaping new line characters.
\item Strings may include character escapes.
\end{DoxyItemize}\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32516}{}\doxysubsection{Numbers}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32516}

\begin{DoxyItemize}
\item Numbers may be hexadecimal.
\item Numbers may have a leading or trailing decimal point.
\item Numbers may be \href{http://ieeexplore.ieee.org/servlet/opac?punumber=4610933}{\texttt{ IEEE 754}} positive infinity, negative infinity, and NaN.
\item Numbers may begin with an explicit plus sign.
\end{DoxyItemize}\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32517}{}\doxysubsection{Comments}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32517}

\begin{DoxyItemize}
\item Single and multi-\/line comments are allowed.
\end{DoxyItemize}\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32518}{}\doxysubsection{White Space}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32518}

\begin{DoxyItemize}
\item Additional white space characters are allowed.
\end{DoxyItemize}\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32519}{}\doxysection{Short Example}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32519}

\begin{DoxyCode}{0}
\DoxyCodeLine{\{}
\DoxyCodeLine{  // comments}
\DoxyCodeLine{  unquoted: 'and you can quote me on that',}
\DoxyCodeLine{  singleQuotes: 'I can use "{}double quotes"{} here',}
\DoxyCodeLine{  lineBreaks: "{}Look, Mom! \(\backslash\)}
\DoxyCodeLine{No \(\backslash\)\(\backslash\)n's!"{},}
\DoxyCodeLine{  hexadecimal: 0xdecaf,}
\DoxyCodeLine{  leadingDecimalPoint: .8675309, andTrailing: 8675309.,}
\DoxyCodeLine{  positiveSign: +1,}
\DoxyCodeLine{  trailingComma: 'in objects', andIn: ['arrays',],}
\DoxyCodeLine{  "{}backwardsCompatible"{}: "{}with JSON"{},}
\DoxyCodeLine{\} }

\end{DoxyCode}
\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32520}{}\doxysection{Specification}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32520}
For a detailed explanation of the JSON5 format, please read the \href{https://json5.github.io/json5-spec/}{\texttt{ official specification}}.\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32521}{}\doxysection{Installation}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32521}
\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32522}{}\doxysubsection{Node.\+js}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32522}

\begin{DoxyCode}{0}
\DoxyCodeLine{npm install json5 }

\end{DoxyCode}



\begin{DoxyCode}{0}
\DoxyCodeLine{const JSON5 = require('json5') }

\end{DoxyCode}
\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32523}{}\doxysubsection{Browsers}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32523}

\begin{DoxyCode}{0}
\DoxyCodeLine{<script src="{}https://unpkg.com/json5@\string^1.0.0"{}></script> }

\end{DoxyCode}


This will create a global {\ttfamily JSON5} variable.\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32524}{}\doxysection{API}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32524}
The JSON5 API is compatible with the \href{https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON}{\texttt{ JSON API}}.\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32525}{}\doxysubsection{JSON5.\+parse()}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32525}
Parses a JSON5 string, constructing the Java\+Script value or object described by the string. An optional reviver function can be provided to perform a transformation on the resulting object before it is returned.\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32526}{}\doxysubsubsection{Syntax}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32526}
JSON5.\+parse(text\mbox{[}, reviver\mbox{]})\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32527}{}\doxysubsubsection{Parameters}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32527}

\begin{DoxyItemize}
\item {\ttfamily text}\+: The string to parse as JSON5.
\item {\ttfamily reviver}\+: If a function, this prescribes how the value originally produced by parsing is transformed, before being returned.
\end{DoxyItemize}\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32528}{}\doxysubsubsection{Return value}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32528}
The object corresponding to the given JSON5 text.\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32529}{}\doxysubsection{JSON5.\+stringify()}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32529}
Converts a Java\+Script value to a JSON5 string, optionally replacing values if a replacer function is specified, or optionally including only the specified properties if a replacer array is specified.\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32530}{}\doxysubsubsection{Syntax}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32530}
JSON5.\+stringify(value\mbox{[}, replacer\mbox{[}, space\mbox{]}\mbox{]}) JSON5.\+stringify(value\mbox{[}, options\mbox{]})\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32531}{}\doxysubsubsection{Parameters}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32531}

\begin{DoxyItemize}
\item {\ttfamily value}\+: The value to convert to a JSON5 string.
\item {\ttfamily replacer}\+: A function that alters the behavior of the stringification process, or an array of String and Number objects that serve as a whitelist 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.
\item {\ttfamily space}\+: A String or Number object that\textquotesingle{}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\textquotesingle{}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.
\item {\ttfamily options}\+: An object with the following properties\+:
\begin{DoxyItemize}
\item {\ttfamily replacer}\+: Same as the {\ttfamily replacer} parameter.
\item {\ttfamily space}\+: Same as the {\ttfamily space} parameter.
\item {\ttfamily quote}\+: A String representing the quote character to use when serializing strings.
\end{DoxyItemize}
\end{DoxyItemize}\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32532}{}\doxysubsubsection{Return value}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32532}
A JSON5 string representing the value.\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32533}{}\doxysubsection{Node.\+js $<$tt$>$require()$<$/tt$>$ JSON5 files}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32533}
When using Node.\+js, you can {\ttfamily require()} JSON5 files by adding the following statement.


\begin{DoxyCode}{0}
\DoxyCodeLine{require('json5/lib/register') }

\end{DoxyCode}


Then you can load a JSON5 file with a Node.\+js {\ttfamily require()} statement. For example\+:


\begin{DoxyCode}{0}
\DoxyCodeLine{const config = require('./config.json5') }

\end{DoxyCode}
\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32534}{}\doxysection{CLI}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32534}
Since JSON is more widely used than JSON5, this package includes a CLI for converting JSON5 to JSON and for validating the syntax of JSON5 documents.\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32535}{}\doxysubsection{Installation}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32535}

\begin{DoxyCode}{0}
\DoxyCodeLine{npm install -\/-\/global json5 }

\end{DoxyCode}
\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32536}{}\doxysubsection{Usage}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32536}

\begin{DoxyCode}{0}
\DoxyCodeLine{json5 [options] <file> }

\end{DoxyCode}


If {\ttfamily $<$file$>$} is not provided, then STDIN is used.\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32537}{}\doxysubsubsection{Options\+:}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32537}

\begin{DoxyItemize}
\item {\ttfamily -\/s}, {\ttfamily -\/-\/space}\+: The number of spaces to indent or {\ttfamily t} for tabs
\item {\ttfamily -\/o}, {\ttfamily -\/-\/out-\/file \mbox{[}file\mbox{]}}\+: Output to the specified file, otherwise STDOUT
\item {\ttfamily -\/v}, {\ttfamily -\/-\/validate}\+: Validate JSON5 but do not output JSON
\item {\ttfamily -\/V}, {\ttfamily -\/-\/version}\+: Output the version number
\item {\ttfamily -\/h}, {\ttfamily -\/-\/help}\+: Output usage information
\end{DoxyItemize}\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32538}{}\doxysection{Contibuting}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32538}
\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32539}{}\doxysubsection{Development}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32539}

\begin{DoxyCode}{0}
\DoxyCodeLine{git clone https://github.com/json5/json5}
\DoxyCodeLine{cd json5}
\DoxyCodeLine{npm install }

\end{DoxyCode}


When contributing code, please write relevant tests and run {\ttfamily npm test} and {\ttfamily npm run lint} before submitting pull requests. Please use an editor that supports \href{http://editorconfig.org/}{\texttt{ Editor\+Config}}.\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32540}{}\doxysubsection{Issues}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32540}
To report bugs or request features regarding the JSON5 data format, please submit an issue to the \href{https://github.com/json5/json5-spec}{\texttt{ official specification repository}}.

To report bugs or request features regarding the Java\+Script implentation of JSON5, please submit an issue to this repository.\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32541}{}\doxysection{License}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32541}
MIT. See \mbox{\hyperlink{md_sfcode_node_modules_webpack_node_modules_json5_LICENSE}{LICENSE.md}} for details.\hypertarget{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32542}{}\doxysection{Credits}\label{md_sfcode_node_modules_webpack_node_modules_json5_README_autotoc_md32542}
\href{https://github.com/aseemk}{\texttt{ Assem Kishore}} founded this project.

\href{http://bolinfest.com/}{\texttt{ Michael Bolin}} independently arrived at and published some of these same ideas with awesome explanations and detail. Recommended reading\+: \href{http://bolinfest.com/essays/json.html}{\texttt{ Suggested Improvements to JSON}}

\href{http://www.crockford.com/}{\texttt{ Douglas Crockford}} of course designed and built JSON, but his state machine diagrams on the \href{http://json.org/}{\texttt{ JSON website}}, as cheesy as it may sound, gave us motivation and confidence that building a new parser to implement these ideas was within reach! The original implementation of JSON5 was also modeled directly off of Doug’s open-\/source \href{https://github.com/douglascrockford/JSON-js/blob/master/json_parse.js}{\texttt{ json\+\_\+parse.\+js}} parser. We’re grateful for that clean and well-\/documented code.

\href{https://github.com/MaxNanasy}{\texttt{ Max Nanasy}} has been an early and prolific supporter, contributing multiple patches and ideas.

\href{https://github.com/aeisenberg}{\texttt{ Andrew Eisenberg}} contributed the original {\ttfamily stringify} method.

\href{https://github.com/jordanbtucker}{\texttt{ Jordan Tucker}} has aligned JSON5 more closely with ES5, wrote the official JSON5 specification, completely rewrote the codebase from the ground up, and is actively maintaining this project. 