hjson / textmate-hjson Goto Github PK

Hjson syntax for TextMate compatible Editors

License: MIT License

textmate hjson editor-plugin syntax-highlighting

textmate-hjson's Introduction

TextMate compatible Syntax for Hjson

A lot of editors support TextMate compatible syntax definitions. You can use this package to install Hjson syntax highlighting support.

IntelliJ Installation

Install TextMate bundles support (if it is not installed already)
- Open Preferences/Plugins
- Click Install JetBrains plugin...
- Type "textmate" in the search box
- Install "TextMate bundles support"
- Restart IntelliJ
Install Hjson syntax
- clone or download this repo git clone https://github.com/hjson/textmate-hjson.git
- Open Preferences/Editor in IntelliJ
- Select Textmate Bundles
- Click on + and select the textmate-hjson folder
- Depending on your color scheme you may wish to edit the mapping on the same screen (E.g. select something like Dracula if you are using a dark scheme)
To install a custom color scheme
- Create a subfolder named Themes in the textmate-hjson folder
- Download your favorite tmTheme file to the folder you just created
- You may need to restart/re-add the Hjson bundle
- The theme should now show up in the mappings in Textmate Bundles

Others

Check Editor Support for a native package first (like Sublime/Atom/Visual Studio).

If your editor is not listed you may be able to install this package if it supports TextMate syntax bundles.

textmate-hjson's People

Contributors

Stargazers

Watchers

Forkers

isabella232

textmate-hjson's Issues

Update grammar

Update the grammar to the new improved version by @dqsully

Hi,
I noticed, that the plugin highlights any text after :// as a comment no matter what it's surrounded by. So e.g. if I have a line like
"jdbc_url": "jdbc:gdc:datawarehouse://{params.hostname}}/datawarehouse/instances/xzy"
everything after //{ looks like a comment. When I parse it, it is not interpreted as a comment as well as when I try to reproduce this issue on the official HJSON site https://hjson.org/try.html it doesn't interpret or highlight such cases as comments which leads me to believe it's an error in this plugin.
The same goes for :# and :*/

schema: [
  { id: 7
    spec: {
      comp: {
        any: true
      }
      wrong-color: {
        some: "thing"
      }
    }
  }
]

Error List:

3x curly braces '}' are highlighed in red
1x rectangular ']' brace in red
the "wrong-color" part is wrongly colored.

Editor Screenshot:

TextMate is bundled and turned on by default, update README

Requires trailing comma or whitespace after last subobject

Steps to reproduce:

Create a .hjson file with the following content and open it after installing textmate-hjson in PHPStorm 2018.2:

{
    subobject: {}
}

Expected behavior:
The last closing brace should not have syntax error highlight.

Actual behavior:
The last closing brace has syntax error highlight.

Additional observations:

If comma or whitespace is added after the subobject's closing brace, the syntax error highlight goes away. Same if whitespace is added before the end of the line that contains the subobject's closing brace. Neither is a good workaround because the comma is ugly and trailing whitespaces can be stripped by editor.
This happens whenever the last subobject of an object is not terminated by comma or whitespace after the closing brace (but on the same line), even if that subobject is not the last property. It therefore happens i this case:

{
    am_I_an_object: { answer: "yes" }
    am_I_one_too: false
}

But not in this one (note the comma):

{
    am_I_an_object: { answer: "yes" },
    am_I_one_too: false
}