Feature Request: Please consider supporting the new go.mod and go.sum files

[ramya-rao-a]

go.mod and go.sum files are introduced in the go modules feature.
Would this repo consider adding syntax highlighting support for them?

[brainsnail]

Taking a look at this.

[pd93]

Just for reference.. This is how I imagine the syntax highlighting looking when complete (theme dependant obviously). I've included a few different version formats that can be commonly found.

@brainsnail Please let me know if you'd like any help with this

[brainsnail]

Thanks @pd93 - it's good to know I'm not too far off base 😄

I created a branch that has some of those changes and have been working on it here and there. It's been mostly learning about Atom and going through the 'Flight Manual' with some review of the Module section on the Go wiki

For the semver formatting I've got a regex that works, just haven't plugged it in yet to the file.

So, there's still a few TODOs on that branch for the module grammar:

• Keywords should only highlight in the proper scope
• Find an example of where someone is using replace and exclude to see what scope they should be in
• Add pattern for comments
• Add pattern for semver

For the checksum grammar - I guess it's basically just the same as the inside of the require block of a module file. What do you think about highlighting the version and the checksum? Anything else that stands out there?

[brainsnail]

@pd93 I've got a regular expression that covers the semantic version of a module

^v(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$

but it is tricky to get the grammar to recognize it. Am I overthinking that?

[pd93]

@brainsnail Apologies for the slow replies. Been off ill for a couple of days. Disclaimer, I'm far from an expert on these things, but I'll try and rubber duck your comments as best I can.

I've put your regex into a regex tester. It appears to be catching everything pretty well except for when a date is followed by a commit hash. I'm not actually sure why this occurs in go.mod

I made my own version that matches everything in my test string - but I do not know for sure if my test string encompasses all possible go.mod files. The ones in my test string are the only ones I've personally seen before.

I'll break it down to save some time:

Capture group 1-3: v(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)
This is essentially the same as yours. It will match any semver style string while not allowing leading zeros

Capture group 4: (?:\-(\d{4}(?:0[1-9]|1[0-2])(?:0[1-9]|[1-2]\d|3[0-1])(?:[0-1]\d|2[0-3])(?:[0-5]\d)(?:[0-5]\d)))?
This is pretty horrible to look at, but it matches any 14 character, reverse date order string. I can break this down further, but you should be able to make sense of it. I allowed any 4 digit number for the year, 01-12 for the month, 01-31 for the day, 00-23 for the hour and 00-59 for the minutes/seconds.

Capture group 5: (?:\-([a-zA-Z\d]{12}))?
Pretty simple. This matches an alphanumeric string of length 12 (the hash)

Capture group 6: (?:\+(incompatible))?
Again, pretty simple. It just catches the +incompatible if it's there.

Full regex: v(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:\-(\d{4}(?:0[1-9]|1[0-2])(?:0[1-9]|[1-2]\d|3[0-1])(?:[0-1]\d|2[0-3])(?:[0-5]\d)(?:[0-5]\d)))?(?:\-([a-zA-Z\d]{12}))?(?:\+(incompatible))?

Let me know if there's anything you think I missed in mine that yours covers.

What exactly do you mean when you say it's tricky to get the grammar to recognise it?

• I will have a look at the go.sum syntax now
• I'll also have a look at the replace and exclude keywords to see what requirements they have

[brainsnail]

@pd93 That's awesome!

Yes, I think your regular expression covers the version matching better than mine did. I had not seen the case you had encountered with the date and hash. I think those are modules that haven't been tagged properly so it's just doing the best it can to pinpoint the 'version' off of the last commit date and hash. For testing this out, I have been pulling down repositories (especially larger ones with a lot of dependencies) and running go mod init followed by go build then dumping the contents into Regex101.

Regarding the comment about the grammar being recognized - I'm just trying to get an instance of Atom loading the grammar with the version regex included. Everything is synchronized properly via the apm commands and I'm launching with atom -d, but the longer regex is probably not escaped correctly. If you want, I can add you as a collaborator on that repository or you could open up a PR against it (whichever you prefer). I think we're already sort of working on the same thing. Might as well throw some commits on the same branch 😆

[pd93]

@brainsnail Thanks for the collab invite. I've cloned you repo, linked it to atom and made a commit for the version string matching. Everything seems to work as expected (see screenshot). Let me know if you still have problems loading the dev package.

I had a bit of an internal argument as to how to 'name' the rule. I went with string.unquoted.version.go, but I'm open to better suggestions. It seemed the most appropriate from the TextMate docs. Let me know your thoughts.

I think we should also be adding 'comment' fields to the rules (as has been done in the go.cson file) - so shall make another commit adding these if you agree. Can take a look at go.sum tomorrow :)

[pd93]

Version string

So.. from what I can tell go.sum has exactly the same version format as go.mod for the version string except that it might also contain the additional text: "\go.mod" at the end.

v(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:\-(\d{4}(?:0[1-9]|1[0-2])(?:0[1-9]|[1-2]\d|3[0-1])(?:[0-1]\d|2[0-3])(?:[0-5]\d)(?:[0-5]\d)))?(?:\-([a-zA-Z\d]{12}))?(?:\+(incompatible))?(\/go\.mod)?
regex101

Checksum

Then there is (what I assume is) a checksum hash

h1:[a-zA-Z\d+\/]{43}=
regex101

• I don't know if the h1 can ever be different? We might need to account for that
• I've assumed a fixed length of 43
• I've assumed the characters can be alphanumeric or / or +, but there could be more?

---

I feel like the version string and the checksum should be caught separately so they can be highlighted separately too.

[edit] pushed another commit with these changes.

[brainsnail]

Sorry for the delay, @pd93

I think these changes are what we need to do. I'm going to push up a PR and see how it goes. Did some spot checking again on a few projects with modules and things checked out.