Skip to content

Commit cfea497

Browse files
pradyunsgpradyunsg
committed
Add prettier as a linter
This helps ensure that all the files within the repository have a consistent style.
1 parent 3a601c1 commit cfea497

File tree

4 files changed

+117
-145
lines changed

4 files changed

+117
-145
lines changed

‎.pre-commit-config.yaml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
repos:
2+
- repo: https://github.com/pre-commit/mirrors-prettier
3+
rev: v2.7.1
4+
hooks:
5+
- id: prettier
6+
27
- repo: https://github.com/pre-commit/pre-commit-hooks
38
rev: v4.3.0
49
hooks:

‎CHANGELOG.md‎

Lines changed: 67 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -2,103 +2,103 @@
22

33
## unreleased
44

5-
* Allow newline after key/values in inline tables.
6-
* Allow trailing comma in inline tables.
7-
* Clarify where and how dotted keys define tables.
8-
* Add new `\e` shorthand for the escape character.
9-
* Add \x00 notation to basic strings.
10-
* Seconds in Date-Time and Time values are now optional.
5+
- Allow newline after key/values in inline tables.
6+
- Allow trailing comma in inline tables.
7+
- Clarify where and how dotted keys define tables.
8+
- Add new `\e` shorthand for the escape character.
9+
- Add \x00 notation to basic strings.
10+
- Seconds in Date-Time and Time values are now optional.
1111

1212
## 1.0.0 / 2021-01-11
1313

14-
* Clarify how tables are created and defined.
15-
* Clarify and describe the top-level table.
16-
* Clarify that indentation before keys is ignored.
17-
* Clarify that indentation before table headers is ignored.
18-
* Clarify that indentation between array values is ignored.
14+
- Clarify how tables are created and defined.
15+
- Clarify and describe the top-level table.
16+
- Clarify that indentation before keys is ignored.
17+
- Clarify that indentation before table headers is ignored.
18+
- Clarify that indentation between array values is ignored.
1919

2020
## 1.0.0-rc.3 / 2020-10-07
2121

22-
* Clarify that comments and newlines are allowed before commas in arrays.
23-
* Mark the ABNF as canonical, and reference it from the text specification.
22+
- Clarify that comments and newlines are allowed before commas in arrays.
23+
- Mark the ABNF as canonical, and reference it from the text specification.
2424

2525
## 1.0.0-rc.2 / 2020-08-09
2626

27-
* Create https://toml.io as the new primary location to read the TOML spec.
28-
* Clarify meaning of "quotation marks".
29-
* Clarify meaning of "expected" value ranges.
30-
* Clarify that EOF is allowed after key/value pair.
31-
* Clarify that the various styles for writing keys are equivalent.
32-
* Clarify that line-ending backslashes must be unescaped in multi-line strings.
33-
* Add examples for invalid float values.
27+
- Create https://toml.io as the new primary location to read the TOML spec.
28+
- Clarify meaning of "quotation marks".
29+
- Clarify meaning of "expected" value ranges.
30+
- Clarify that EOF is allowed after key/value pair.
31+
- Clarify that the various styles for writing keys are equivalent.
32+
- Clarify that line-ending backslashes must be unescaped in multi-line strings.
33+
- Add examples for invalid float values.
3434

3535
## 1.0.0-rc.1 / 2020-04-01
3636

37-
* Clarify in ABNF how quotes in multi-line basic and multi-line literal strings
37+
- Clarify in ABNF how quotes in multi-line basic and multi-line literal strings
3838
are allowed to be used.
39-
* Leading zeroes in exponent parts of floats are permitted.
40-
* Clarify that control characters are not permitted in comments.
41-
* Clarify behavior of tables defined implicitly by dotted keys.
42-
* Clarify that inline tables are immutable.
43-
* Clarify that trailing commas are not allowed in inline tables.
44-
* Clarify in ABNF that UTF-16 surrogate code points (U+D800 - U+DFFF) are not
39+
- Leading zeroes in exponent parts of floats are permitted.
40+
- Clarify that control characters are not permitted in comments.
41+
- Clarify behavior of tables defined implicitly by dotted keys.
42+
- Clarify that inline tables are immutable.
43+
- Clarify that trailing commas are not allowed in inline tables.
44+
- Clarify in ABNF that UTF-16 surrogate code points (U+D800 - U+DFFF) are not
4545
allowed in strings or comments.
46-
* Allow raw tab characters in basic strings and multi-line basic strings.
47-
* Allow heterogenous values in arrays.
46+
- Allow raw tab characters in basic strings and multi-line basic strings.
47+
- Allow heterogenous values in arrays.
4848

4949
## 0.5.0 / 2018-07-11
5050

51-
* Add dotted keys.
52-
* Add hex, octal, and binary integer formats.
53-
* Add special float values (inf, nan).
54-
* Rename Datetime to Offset Date-Time.
55-
* Add Local Date-Time.
56-
* Add Local Date.
57-
* Add Local Time.
58-
* Add ABNF specification.
59-
* Allow space (instead of T) to separate date and time in Date-Time.
60-
* Allow accidental whitespace between backslash and newline in the line
51+
- Add dotted keys.
52+
- Add hex, octal, and binary integer formats.
53+
- Add special float values (inf, nan).
54+
- Rename Datetime to Offset Date-Time.
55+
- Add Local Date-Time.
56+
- Add Local Date.
57+
- Add Local Time.
58+
- Add ABNF specification.
59+
- Allow space (instead of T) to separate date and time in Date-Time.
60+
- Allow accidental whitespace between backslash and newline in the line
6161
continuation operator in multi-line basic strings.
62-
* Specify that the standard file extension is `.toml`.
63-
* Specify that MIME type is `application/toml`
64-
* Clarify that U+007F is an escape character.
65-
* Clarify that keys are always strings.
66-
* Clarify that you cannot use array-of-table to append to a static array.
67-
* Clarify that a TOML file must be a valid UTF-8 document.
68-
* Clarify valid Array values.
69-
* Clarify that literal strings can be table keys.
70-
* Clarify that at least millisecond precision expected for Date-Time and Time.
71-
* Clarify that comments are OK in multiline arrays.
72-
* Clarify that +0, -0, +0.0, and -0.0 are valid and what they mean.
73-
* TOML has a logo!
62+
- Specify that the standard file extension is `.toml`.
63+
- Specify that MIME type is `application/toml`
64+
- Clarify that U+007F is an escape character.
65+
- Clarify that keys are always strings.
66+
- Clarify that you cannot use array-of-table to append to a static array.
67+
- Clarify that a TOML file must be a valid UTF-8 document.
68+
- Clarify valid Array values.
69+
- Clarify that literal strings can be table keys.
70+
- Clarify that at least millisecond precision expected for Date-Time and Time.
71+
- Clarify that comments are OK in multiline arrays.
72+
- Clarify that +0, -0, +0.0, and -0.0 are valid and what they mean.
73+
- TOML has a logo!
7474

7575
## 0.4.0 / 2015-02-12
7676

77-
* Add Inline Table syntax.
78-
* Allow underscores in numbers.
79-
* Remove forward slash as an escapable character.
80-
* Unicode escapes must be scalar values.
81-
* Newline is now defined as LF or CRLF.
77+
- Add Inline Table syntax.
78+
- Allow underscores in numbers.
79+
- Remove forward slash as an escapable character.
80+
- Unicode escapes must be scalar values.
81+
- Newline is now defined as LF or CRLF.
8282

8383
## 0.3.1 / 2014-11-11
8484

85-
* Fix incorrect datetime examples.
85+
- Fix incorrect datetime examples.
8686

8787
## 0.3.0 / 2014-11-10
8888

89-
* Add scientific notation for floats.
90-
* Allow optional + prefix on integers.
91-
* Switch to RFC 3339 for datetimes (allowing offsets and fractional seconds).
92-
* Add multiline and literal strings.
93-
* Clarify what characters valid keys can contain.
89+
- Add scientific notation for floats.
90+
- Allow optional + prefix on integers.
91+
- Switch to RFC 3339 for datetimes (allowing offsets and fractional seconds).
92+
- Add multiline and literal strings.
93+
- Clarify what characters valid keys can contain.
9494

9595
## 0.2.0 / 2013-09-24
9696

97-
* Use "table" instead of "key group" terminology.
98-
* Add the ability to define nestable arrays of tables.
97+
- Use "table" instead of "key group" terminology.
98+
- Add the ability to define nestable arrays of tables.
9999

100100
## 0.1.0 / 2013-03-17
101101

102-
* From Twitter rage to reality; TOML is now a thing.
103-
* First proper release.
104-
* TOML adheres to the SemVer standard for version numbers.
102+
- From Twitter rage to reality; TOML is now a thing.
103+
- First proper release.
104+
- TOML adheres to the SemVer standard for version numbers.

‎README.md‎

Lines changed: 16 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
<img align="right" src="logos/toml-200.png" alt="TOML logo">
22

3-
TOML
4-
====
3+
# TOML
54

65
Tom's Obvious, Minimal Language.
76

@@ -10,15 +9,13 @@ By Tom Preston-Werner, Pradyun Gedam, et al.
109
> This repository contains the in-development version of the TOML specification.
1110
> You can find the released versions at https://toml.io.
1211
13-
Objectives
14-
----------
12+
## Objectives
1513

1614
TOML aims to be a minimal configuration file format that's easy to read due to
1715
obvious semantics. TOML is designed to map unambiguously to a hash table. TOML
1816
should be easy to parse into data structures in a wide variety of languages.
1917

20-
Example
21-
-------
18+
## Example
2219

2320
```toml
2421
# This is a TOML document.
@@ -56,8 +53,7 @@ hosts = [
5653
]
5754
```
5855

59-
Comparison with Other Formats
60-
-----------------------------
56+
## Comparison with Other Formats
6157

6258
TOML shares traits with other file formats used for application configuration
6359
and data serialization, such as YAML and JSON. TOML and JSON both are simple and
@@ -80,29 +76,27 @@ and they do not gracefully handle more than one or two levels of nesting.
8076

8177
Further reading:
8278

83-
* YAML spec: https://yaml.org/spec/1.2/spec.html
84-
* JSON spec: https://tools.ietf.org/html/rfc8259
85-
* Wikipedia on INI files: https://en.wikipedia.org/wiki/INI_file
79+
- YAML spec: https://yaml.org/spec/1.2/spec.html
80+
- JSON spec: https://tools.ietf.org/html/rfc8259
81+
- Wikipedia on INI files: https://en.wikipedia.org/wiki/INI_file
8682

87-
Get Involved
88-
------------
83+
## Get Involved
8984

9085
Documentation, bug reports, pull requests, and all other contributions
9186
are welcome!
9287

93-
Wiki
94-
----
88+
## Wiki
9589

9690
We have an [Official TOML Wiki](https://github.com/toml-lang/toml/wiki) that
9791
catalogs the following:
9892

99-
* Projects using TOML
100-
* Implementations
101-
* Validators
102-
* Language-agnostic test suite for TOML decoders and encoders
103-
* Editor support
104-
* Encoders
105-
* Converters
93+
- Projects using TOML
94+
- Implementations
95+
- Validators
96+
- Language-agnostic test suite for TOML decoders and encoders
97+
- Editor support
98+
- Encoders
99+
- Converters
106100

107101
Please take a look if you'd like to view or add to that list. Thanks for being
108102
a part of the TOML community!

0 commit comments

Comments
 (0)