bungcip / better-toml Goto Github PK

toml extension for vs code editor

TypeScript 100.00%

better-toml's Introduction

This repository is archieved. I currently don't have time to maintain this project anymore. I recommended to use https://marketplace.visualstudio.com/items?itemName=tamasfe.even-better-toml for better alternative.

better-toml README

Better TOML is a VS Code extension to support TOML files.

Features

Syntax Highlighting for .toml files

Syntax Validation for invalid input

Syntax Highlighting for markdown frontmatter

better-toml's People

Contributors

Stargazers

Watchers

Forkers

marcobeltempo brettcannon mattlknight henrybaxter senritsu filmor calinou soniasingla obsidianminor umegaya bolinfest noicu juggernautjp

better-toml's Issues

Whitespace sensitive commas in inline tables

I've noticed that spaces preceding commas in inline tables seem to create problems for the formatter. Notably, that everything starting with the comma until the next table item is formatted as plain-text (unformatted).

Take this example from from the spec.

name = { first = "Tom", last = "Preston-Werner" }
# This works fine.
point = { x = 1, y = 2 }
animal = { name = "pug" }

But if I put a space between the value "Tom" and the comma, it breaks. Everything is unformatted up to the table item point

name = { first = "Tom" , last = "Preston-Werner" }
#                     ^ space here makes everything following formatted as plain text
# This comment and above are formatted as plain text
# Item after this line returns to correct highlighting
point = { x = 1, y = 2 }
animal = { name = "pug" }

This seems to be independent of the value type. It also breaks for integer values.

name = { first = "Tom" , last = "Preston-Werner" }
point = { x = 1 , y = 2 }
#              ^ space here also also breaks the formatter
# This comment and above are formatted as plain text
animal = { name = "pug" }

This bug seems to only apply inside inline tables, and not between them. For example, if i turn point into an array of inline tables, the comma spacing doesn't seem to be affected.

name = { first = "Tom", last = "Preston-Werner" }

# Objects in arrays seem to be fine
point = [ {x = 1} , {y = 2} ]
#                ^ This space does not cause a problem

animal = { name = "pug" }

Better TOML: v0.3.2
VS Code: v1.30.2
OSX: v10.14.2

Make the TOML LSP available as a standalone package?

It appears that out/server/tomlServerMain.js can function as a standalone LSP. Would you be interested in releasing it as such? Then it could be used in other editors that speak LSP, as well.

Syntax validation rejects valid input

Hey,

The extension doesn't seem to know that all string and array types are considered homogeneous, as per the standard.

Paste the 'arr1' through 'arr5' lines from the link above to reproduce.

Thanks for the useful extension!
BR

666 Support toml schema validator

vscode have nice feature when opening .json file. The editor will validate the file based on http://schemastore.org schema.

I want better-toml to have that feature. Initial implementation will be based from vscode json extension and using json schema.

If someday toml have support for schema validation file, better-toml will also support it (I still hope for toml-lang/toml#116)

Avoid using rootPath

This extension appears to be using rootPath from the LSP. This is a deprecated property that may not work as expected in a multi-root workspace.

See this guide on implementing multi-root support: https://github.com/Microsoft/vscode/wiki/Adopting-Multi-Root-Workspace-APIs#language-client--language-server

microsoft/vscode#69335

support dotted keys

Please add support for dotted keys. https://github.com/toml-lang/toml#user-content-keys.

Currently it considers dotted key as error.

Support for inline table

https://github.com/toml-lang/toml#inline-table

Currently vscode responds with a parse error on inline tables. Please add support for it.

Thanks!

If key and value are both quoted with the same character, leading equals sign in value gets strange

Some strange edge case probably, but pipenv kicks out strings like "flake8" = "==3.6.0" every so often which triggers it. Doesn't even seem like the GitHub formatter gets it right (some red highlighting on the keyb line for me...)

# nothing to see here
key = "value"
"keya" = "value"

# same quote types
"keyb" = "=value"
'keyc' = '=value'

# differing quote types for key/value
'keyd' = "=value"
"keye" = '=value'

Better TOML: 0.3.2
VSCode: 1.29.1
OS: Ubuntu 16.04

Enable color picker for toml

similar to enabling the color picker for html in vscode, allow enabling the new color picker for a toml color object.

formats to be discussed, but suggested starting points:
{ r = <0-255>, g = <0-255>, b = <0-255> }
{ r = <0-255>, g = <0-255>, b = <0-255>, a = <0-255> }
{ h = <0-360>, s = <0-100>, l = <0-100> }
{ h = <0-360>, s = <0-100>, l = <0-100>, a = <0.0-1.0> }

Inject into text.html.markdown to support fenced code blocks

#10 added support for "front matter" syntax highlighting in Markdown files. I'm not that familiar with it, but I see it is some sort of metadata format that must appear at the start of a file: https://jekyllrb.com/docs/front-matter/.

For the rest of us, I think the more interesting injection into the Markdown grammar would be for fenced code blocks. This is what makes it possible to write a triple-backtick followed by a programming language and get it syntax-highlighted properly like so:

```js
function example() {
  return "This would be highlighted as JavaScript in a Markdown file.";
}
```

Unfortunately, this does not work with the TOML extension today:

```toml
key = "This is not syntax highlighted as TOML in a Markdown file in VS Code today."
```

Here are examples of how other VS Code extensions provide this functionality:

The Haskell example has some extra checks beyond the Kotlin one (with the begin/while bits), though I haven't worked out what edge cases those are trying to address. I think porting the Kotlin example (include the additional entry in the grammars list in the package.json) would probably work well enough for now, though.

when can we expect the next release?

👋 @bungcip. Great vscode extension!

I was just wondering if this project was still active and if so when we can expect the next release? There have been a lot of changes since the 0.3.2 release that remove the urge to write a toml server myself. I was specifically looking for a way to provide a better editing experience of toml configuration files with json schema support. What's in master in this repo seems to do just that. Is this something you're expecting to release soon or as this project gone into maintenance mode?

False positive problem with local date

A file with the content ld1 = 1979-05-27 raises the following error: Expected "T" but end of input found. (or Expected "T" but "\r" found. if there is a newline after the content).

According to the specification, this should be perfectly good toml since version 0.5.0.

Mixed types in array leads to warning

Given a TOML key with an Array,
When using valid syntax of strings and tables,
Then a warning should not be raised.

Example:

include = [
    { path = "foo", format = "sdist" },
    "bar.md"
]

Triggers:

Cannot add value of type String to array of type InlineTable.

Desired behavior:

No trigger raised, as this is valid TOML syntax.

Attempting to append to a statically defined array, even if that array is empty or of compatible type, must produce an error at parse time.

Title is directly taken from https://github.com/toml-lang/toml#user-content-array-of-tables

As is this:

# INVALID TOML DOC
fruit = []

[[fruit]] # Not allowed

However this appears to parse as valid TOML.

Mention supported toml version in README

At the moment, there seems to be no way to find out which toml version is currently supported.

This might lead to problems like #26 if toml introduces new features that this extension does not support.

Add Icon in package.json manifest

Currently the extension don't have any icon. Need one nice icon to display it on marketplace

Parser error on Local date

it seem related to this issue:
BinaryMuse/toml-node#37

Added support for TOML frontmatter syntax highlighting in markdown files

Refrences: VSCode Issue#41650

I've added support for TOML frontmatter in Markdown files. A feature originally requested in vscode.

Steps to reproduce:

Create a .md file
add to the top line

+++

+++

Insert TOML syntax

title = "TOML Example"

@bungcip I would like your feedback on this feature.
You can test it out here https://github.com/marcobeltempo/vscode-fenced-toml

$ ps aux | grep 26009

stephanemaarek   26009 125.4  1.3  4856732 220472   ??  R     1:22PM  22:33.96 /Applications/Visual Studio Code.app/Contents/Frameworks/Code Helper.app/Contents/MacOS/Code Helper /Users/stephanemaarek/.vscode/extensions/bungcip.better-toml-0.3.2/node_modules/vscode-languageclient/lib/utils/electronForkStart /Users/stephanemaarek/.vscode/extensions/bungcip.better-toml-0.3.2/out/server/tomlServerMain.js --node-ipc

One CPU is maxing out in utilization, and my file has about 1350 lines.

These are not big issues at all but at least this way you're aware