Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitd720b4f

Browse files
authored
Improve readme (e.g. explain JSON5 better!) (#291)
* Explain JSON5 better. Proactively emphasize that this is for config file type use cases, not machine-to-machine communication (the#1 misunderstanding or objection to JSON5).* Market/sell it better. The stats and company/project names are exciting! =)* Link to blog post. This doesn't need to be front-and-center though; just added it to my name in the credits.* Emphasize ES5 compatibility. Just put a stake in the ground here and preempt feature requests we'll never accept.
1 parent910ce25 commitd720b4f

File tree

1 file changed

+37
-11
lines changed

1 file changed

+37
-11
lines changed

‎README.md‎

Lines changed: 37 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,33 @@ Status] [![Coverage
55
Status](https://coveralls.io/repos/github/json5/json5/badge.svg)][Coverage
66
Status]
77

8-
The JSON5 Data Interchange Format (JSON5) is a superset of[JSON] that aims to
9-
alleviate some of the limitations of JSON by expanding its syntax to include
10-
some productions from[ECMAScript 5.1].
11-
12-
This JavaScript library is the official reference implementation for JSON5
13-
parsing and serialization libraries.
8+
JSON5 is an extension to the popular[JSON] file format that aims to be
9+
easier to**write and maintain_by hand_ (e.g. for config files)**.
10+
It is_not intended_ to be used for machine-to-machine communication.
11+
(Keep using JSON or other file formats for that. 🙂)
12+
13+
JSON5 was started in 2012, and as of 2022, now gets**[>65M downloads/week](https://www.npmjs.com/package/json5)**,
14+
ranks in the**[top 0.1%](https://gist.github.com/anvaka/8e8fa57c7ee1350e3491)** of the most depended-upon packages on npm,
15+
and has been adopted by major projects like
16+
**[Chromium](https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/platform/runtime_enabled_features.json5;drc=5de823b36e68fd99009a29281b17bc3a1d6b329c),
17+
[Next.js](https://github.com/vercel/next.js/blob/b88f20c90bf4659b8ad5cb2a27956005eac2c7e8/packages/next/lib/find-config.ts#L43-L46),
18+
[Babel](https://babeljs.io/docs/en/config-files#supported-file-extensions),
19+
[Retool](https://community.retool.com/t/i-am-attempting-to-append-several-text-fields-to-a-google-sheet-but-receiving-a-json5-invalid-character-error/7626),
20+
[WebStorm](https://www.jetbrains.com/help/webstorm/json.html),
21+
and[more](https://github.com/json5/json5/wiki/In-the-Wild)**.
22+
It's also natively supported on**[Apple platforms](https://developer.apple.com/documentation/foundation/jsondecoder/3766916-allowsjson5)**
23+
like**MacOS** and**iOS**.
24+
25+
Formally, the**[JSON5 Data Interchange Format](https://spec.json5.org/)** is a superset of JSON
26+
(so valid JSON files will always be valid JSON5 files)
27+
that expands its syntax to include some productions from[ECMAScript 5.1] (ES5).
28+
It's also a strict_subset_ of ES5, so valid JSON5 files will always be valid ES5.
29+
30+
This JavaScript library is a reference implementation for JSON5 parsing and serialization,
31+
and is directly used in many of the popular projects mentioned above
32+
(where e.g. extreme performance isn't necessary for config file use cases),
33+
but others have created[many other libraries](https://github.com/json5/json5/wiki/In-the-Wild)
34+
across many other platforms.
1435

1536
[Build Status]:https://app.travis-ci.com/json5/json5
1637

@@ -208,18 +229,23 @@ run lint` before submitting pull requests. Please use an editor that supports
208229
[EditorConfig](http://editorconfig.org/).
209230

210231
###Issues
211-
To report bugs or request features regarding the JSON5 data format, please
212-
submit an issue to the[official specification
213-
repository](https://github.com/json5/json5-spec).
232+
To report bugs or request features regarding the JSON5**data format**,
233+
please submit an issue to the official
234+
**[_specification_ repository](https://github.com/json5/json5-spec)**.
235+
236+
Note that we will never add any features that make JSON5 incompatible with ES5;
237+
that compatibility is a fundamental premise of JSON5.
214238

215-
To report bugs or request features regardingtheJavaScript implementation of
216-
JSON5, please submit an issue tothis repository.
239+
To report bugs or request features regardingthis**JavaScript implementation**
240+
ofJSON5, please submit an issue to**_this_ repository**.
217241

218242
##License
219243
MIT. See[LICENSE.md](./LICENSE.md) for details.
220244

221245
##Credits
222246
[Aseem Kishore](https://github.com/aseemk) founded this project.
247+
He wrote a[blog post](https://aseemk.substack.com/p/ignore-the-f-ing-haters-json5)
248+
about the journey and lessons learned 10 years in.
223249

224250
[Michael Bolin](http://bolinfest.com/) independently arrived at and published
225251
some of these same ideas with awesome explanations and detail. Recommended

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp