Add Markdown File Links Plugin

[kevinfiol]

• I'm the package's author and/or maintainer.
• I have have read the docs.
• I have tagged a release with a semver version number.
• My package repo has a description and a README describing what it's for and how to use it.
• My package doesn't add context menu entries. *
• My package doesn't add key bindings. **
• Any commands are available via the command palette.
• Preferences and keybindings (if any) are listed in the menu and the command palette, and open in split view.
• If my package is a syntax it doesn't also add a color scheme. ***
• If my package is a syntax it is named after the language it supports (without suffixes like "syntax" or "highlighting").
• I use .gitattributes to exclude files from the package: images, test files, sublime-project/workspace.

My package is Markdown File Links

There are no packages like it in Package Control.

[packagecontrol-bot]

Automated testing result: SUCCESS

Repo link: Markdown File Links

Packages added:
  - Markdown File Links

Processing package "Markdown File Links"
  - All checks passed

[braver]

Interesting, looks useful 👍🏻

One thing I'd like to see is a command palette entry in addition to the context menu entry, to make it easy to use the functionality from the keyboard (and also to consistently have all functionality exposed via the palette).

Your is_markdown_file method looks for file extensions. That means that files without extension (that are configured to open as markdown, for instance some README files) are not recognized and the feature won't work there. Or maybe the user is using files with the md extension with a different syntax (I seem to remember more languages use that extension, although markdown is definitely more common). A more reliable way of checking the filetype or syntax of a file is to use match_selector(), passing it a 0,0 point (ie. the first position in the file) and matching for the text.html.markdown scope.

[kevinfiol]

Thanks for the feedback @braver

One thing I'd like to see is a command palette entry in addition to the context menu entry, to make it easy to use the functionality from the keyboard (and also to consistently have all functionality exposed via the palette).

How would you imagine this would work? The best thing that comes to mind is this flow:

1. User left-clicks on a link so the cursor is currently "on" a link (like imagine the pipe is the cursor here [[hel|lo]])
2. Open command pallete, and there should be an option to open the link

A more reliable way of checking the filetype or syntax of a file is to use match_selector(), passing it a 0,0 point (ie. the first position in the file) and matching for the text.html.markdown scope.

Can you give me an example of doing this? It's been pretty difficult for me in general to grok the Sublime plugin API 😅

[braver]

It's been pretty difficult for me in general to grok the Sublime plugin API

I can imagine, it's huge!

How would you imagine this would work

You could just, once the command is triggered, get the user's current selection, which is a set of regions, where there start and end of each region is a "point" similar to the cursor_point you're currently using. You could simply and naively take the first region and the starting point of that region.

Can you give me an example of doing this

• https://github.com/braver/ColorHints/blob/master/ColorHints.py#L53
• https://github.com/search?q=repo%3ASublimeText-Markdown%2FMarkdownEditing%20match_selector&type=code
• https://github.com/MGorkov/explain-postgresql-sublime/blob/master/utils/utils.py#L30

[deathaxe]

The functionality of this plugin is more or less already part of MarkdownEditing. It's called "wiki links".

[kevinfiol]

Thanks @deathaxe . I've been using your plugin for so long and had no idea this functionality was included already. I noticed it was buried at the bottom of the Usage page!.

Anyway, if it's preferable to close this PR, please proceed @braver

[braver]

Well we can always reconsider if the demand arises, but for now let’s close and not add something new to package control.