diff options
Diffstat (limited to 'docs/bun-flavored-toml.md')
| -rw-r--r-- | docs/bun-flavored-toml.md | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/docs/bun-flavored-toml.md b/docs/bun-flavored-toml.md new file mode 100644 index 000000000..5b0bce055 --- /dev/null +++ b/docs/bun-flavored-toml.md @@ -0,0 +1,54 @@ +# Bun-flavored TOML + +[TOML](https://toml.io/) is a minimal configuration file format designed to be easy for humans to read. + +Bun implements a TOML parser with a few tweaks designed for better interopability with INI files and with JavaScript. + +### `:` == `=` + +Like `=`, `:` also assigns values to properties. + +```toml +# In Bun-flavored TOML, these are semantically identical +foo = '12345' +foo : '12345' +``` + +### ';` == `#` + +In Bun-flavored TOML, comments start with `#` or `;` + +```ini +# This is a comment +; This is also a comment +``` + +This matches the behavior of INI files. + +In TOML, comments start with `#` + +```toml +# This is a comment +``` + +### String escape characters + +Bun-flavored adds a few more escape sequences to TOML to work better with JavaScript strings. + +``` +# Bun-flavored TOML extras +\x{XX} - ASCII (U+00XX) +\u{x+} - unicode (U+0000000X) - (U+XXXXXXXX) +\v - vertical tab + +# Regular TOML +\b - backspace (U+0008) +\t - tab (U+0009) +\n - linefeed (U+000A) +\f - form feed (U+000C) +\r - carriage return (U+000D) +\" - quote (U+0022) +\\ - backslash (U+005C) +\uXXXX - unicode (U+XXXX) +\UXXXXXXXX - unicode (U+XXXXXXXX) +``` |