Various Bundle Updates

[infininight]

Got a request to review this bundle for inclusion in the bundle installer for TextMate. Had a few changes that I came across during the review that I've fixed up.

Notes:

• Due to a grammar and scoping features I used the grammar is no longer compatible with TextMate 1.x. While usage of 1.x is very low now it would be good to create a tag for a compatible version before pulling in the changes.
• I added a placeholder maintainer/email to give the proper format, this should be updated to a whoever would like to be the contact, the email can be deleted if you don't want to give one.

Ask if you have any concerns/questions.

[josevalim]

Hi @infininight, thanks a lot for this!

I have created a new tag for tm1 and this is ready to merge. I gave it a try though and I found a bug:

If there is a comment, the next line after the comment does not syntax highlight properly. I could reproduce it with any keyword (such as import, alias, etc) after a comment line. Could you please take a look?

I will give this a try the rest of the day and let you know if anything comes up. Then I think we are ready to merge it!

[infininight]

Which editor is this failing in?

[josevalim]

@infininight sorry, Sublime Text 3.

[josevalim]

@infininight if you have any pointers where this can be, i can also take a look. :)

[infininight]

OK, try that change (untested).

I am mindful of compatibility with Github and Atom but not as familiar with Sublime since they are diverging from the grammar format. \G is used as an assertion in TextMate to match the end of the last begin, this means that rule would be able to end anywhere except where it started. In this case I was able to work around it be looking ahead for the absence of the # character. Believe that should work fine in Sublime.

[josevalim]

@infininight beautiful. This one is fixed!

This looks good to merge for me. Shall we go ahead? :)

[infininight]

And a commit for fixing #100 since you said I did. ;)

(Will only work in TextMate 2 and Github.)

[infininight]

Looks good to me.

[josevalim]

Oh, I thought you had done it before. Thanks a lot!

[josevalim]

:heart: :green_heart: :blue_heart: :yellow_heart: :purple_heart:

[infininight]

And I've deployed it in the installer, give it about 12 hours to propagate and everyone should be able to see it.

Note about updates: I push updates manually. I watch all the repositories in the installer so I generally notice activity and deploy updates but if you want to push one out specifically you can @ me here or on Twitter/IRC/email, a deploy just takes a second so no bother.

[josevalim]

Glad to hear, thank you for the improvements and help!

[binaryseed]

Hi, I run Sublime Text 3 and this PR unfortunately really breaks syntax highlighting. There's a lot of changes here so I don't know how to figure out what went wrong :(

[infininight]

@binaryseed I just looked over all the the commits and the \G usage which was fixed is the only thing that jumped out to me. Can you post a code sample of where it breaks? Narrowing it down to a type of code will help with where to look.

There are a lot of changes here but only a handful of the commits really deal with the highlighting so should be simple enough to track down.

Edit:

To narrow it down I think it could only be one of three commits (presuming we are talking about Elixir and not EEx):

• 30a74c99acec7f931438e3284d111f6f704be6a1
• 77a2d7cd189769f25e9554f19dd1a1b756e069de
• e2671b7f26b540bb31d5231147dcad71d1241200

[binaryseed]

I walked through the commits to see what caused it...

• Previous hilighting @ tag tm1:

• https://github.com/elixir-editors/elixir-tmbundle/pull/155/commits/abd88ed3ec1c3bcc373b98ad4ec171d2466b2f25 breaks some things:

• https://github.com/elixir-editors/elixir-tmbundle/pull/155/commits/1cc5336d2dd6878cd115f43527ecc01973cc8e76 breaks more:

These are just the things that are easy to notice, not sure if there's something elsewhere in other syntax...

[infininight]

Code in question for reference:

defmodule Absinthe.Pipeline.ErrorResult do
  @moduledoc """
  A basic struct that wraps phase errors for
  reporting to the user.
  """

  alias Absinthe.Phase

  defstruct errors: []

  @type t :: %__MODULE__{
          errors: [Phase.Error.t()]
        }

  @doc "Generate a new ErrorResult for one or more phase errors"
  @spec new(Phase.Error.t() | [Phase.Error.t()]) :: t
  def new(errors) do
    %__MODULE__{errors: List.wrap(errors)}
  end
end

More followup shortly.

[infininight]

So looking at this nothing is being matched incorrectly but rather the scopes have been changed to something your theme is not expecting. In TextMate you can see the scope of the caret by pressing ⌃⇧P, I presume something similar exists in Sublime so you can inspect the scopes.

The conventions TextMate uses are listed here and were at least the starting point for any of the many editors that use TextMate style scopes.

Previously the bundle used a scope of entity.name.class for class names, the only valid subsections of name are function|type|tag|section. We scope class names under entity.name.type.class in TextMate grammars it may be that the conventions are different in Sublime.

As for the TextMate bundles I track: Inspecting 258 bundles I show entity.name.type.class in use in 25 different grammars and no uses without type.

The second commit you mentioned uses another scope from the list entity.other.inherited-class for inherited classes.

Regardless of the scope conventions in Sublime I would say the theme needs to be updated since there is so much grammar sharing back and forth between the Sublime/TextMate/Atom/etc. communities.

[binaryseed]

Alright, I edited my theme to match the scopes and it's working properly again! Thanks for taking the time to look into this @infininight!