search

jcberquist / sublimetext-cfml

CFML (ColdFusion and Lucee) package for Sublime Text
MIT License
115 stars 24 forks source link

Non-closing tags and readme improvements #85

Closed KamasamaK closed 7 years ago

KamasamaK commented 7 years ago

There are still non-closing tags missing, mostly UI-related, but I wasn't sure if this was intended to be an exhaustive list and also not sure about the performance impact, especially in the regular expression.

jcberquist commented 7 years ago

Thanks @KamasamaK, I really appreciate you taking the time to clean the "documention" up. Clearly, it needs an editor 😄 .

I do have some thoughts about some of the changes. Is the point of wrapping the links in angle brackets just that it is more semantically correct? I see that referenced in the spec (so to speak), but it doesn't seem to make a difference as to how GitHub renders them. Also, you changed the hyphens in the table of contents to asteriks - I thought both were acceptable for unordered lists? I guess it would be more consistent with the asteriks I used above. I do think though that if both are acceptable and the issue is consistency I would prefer the hyphens. Finally, I am a bit torn about the edit to the links to FW1, TestBox, and CommandBox. I do think it is cleaner in the edit, but I like having those links stand out, so that the sources of those projects stand out. (You read ortussolutions.com even if you don't click on the link.)

Regarding the tag list, I don't really have stong feelings about whether it is exhaustive (just that what is in it in fact belongs there). It should not impact performance too much - perhaps if you had ST reindent a large file the extra tag names would make a tiny difference, but based on my experience with the syntax highlighter, I think it would only be a few milliseconds.

KamasamaK commented 7 years ago

Regarding the links syntax, yes it is because of the spec. Even though it makes no difference in GitHub, there are apparently markdown engines that need this. It was caught by a linter I use -- see https://github.com/DavidAnson/markdownlint/blob/v0.6.0/doc/Rules.md#md034.

Regarding the unordered lists, it's for consistency. You had used asterisks for the first three, so I used that as a baseline, but I have no problem with making them hyphens instead.

Regarding the titled links, I thought it was cleaner that way, but since you prefer to have the link text visible so it shall be.

Those changes have been made in the latest commit.

jcberquist commented 7 years ago

Thanks!