API Suggestions

[wbond]

A post was merged into an existing topic: Interface Suggestions

[iamntz]

Multiple gutter with event capability

Importance: medium

Motivation: Allow plugins to integrate better with sublime

There are few plugins that I could think of that would benefit on a better gutter:

• plugins that are wrapper around debuggers will allow you to CRUD breakpoints. For this kind of plugins events are an absolute must.
• plugins that are merely indicators: color/brackets/git/whatever highlights. For this kind of plugins events are kind of useless.

I believe that letting plugins to create their own gutters are a good idea as long it respects the following rules:

1. Plugin can’t create their own gutter User must allow in settings the „blessed” plugins, so they don’t end up with gutter hell.

• User can’t allow more than X plugins to create gutters. In other words, sublime can have max of X gutters (for the same reason as above)
• Current gutter remains, so all unblessed plugins fight for their place in the same way as they do today.

---

I think this should also be here:

Relative line numbers, because plugins can't properly do it

This is one of my most missed features and a big reason for me to pick other editors over sublime. My workflow is heavily focused on relative jumps. I know that there's github.com/tmanderson/VintageLines, but that plugin is on one side a big hack that inserts (pre-generated) images into the gutter and on the other side will effectively overwrite the entire gutter, making other gutter plugins like SublimeLinter or GitGutter useless. So my request, please give us relative line numbers in the s…

[tito]

It would be nice to have a serializable undo redo/history. So we can undo after closing and reopening sublime… give an api so we do this as we wish.

[qgates]

More flexible scope manipulation

Importance: high

Motivation: allow painless text manipulation by scopes

Working with scopes is a pain at the moment because we can’t be specific about extracting text for a given scope selector. Instead we have to use extract_scope(point) with its ‘intelligence’ which varies by language. Or, we use find_by_selector(selector), then iterate through the list of regions to find the one that intersects the position we want. Or we move position by position back and forth and check we are in/out of scope. These workarounds are labour & CPU intensive for what should be a very simple thing. The solution:

extract_scope(point, selector)

The above proposed change will extract the region for the given selector if provided. Better still would be:

extract_scope(point, selectors)

Where selectors is a space delimited string of selectors, the largest of which (except topmost source.*) is selected.

Finally we could have a greedy flag which allows the above API to choose the least or most specific selector:

extract_scope(point, selectors, greedy, single)

And the single flag will allow an individual scope to be extracted in the case where they are back to back (like <div><div><div>)

Rounding off, it would be useful to have more flexibility with find_by_selector(selector), so that we can restrict its operation to a given region or regions. Presently it returns all matching regions in the file, a performance overhead if one needs to iterate through it repeatedly.

find_by_selector(selector, Region or [Regions])

[idleberg]

Extend snippet/completion scope

(I’m assuming this qualifies as an API suggestion, I’m not entirely sure though)

One of the most frequent requests for my packages is extending the scope of snippets or completions to other syntaxes. I’ve had a situation where I was asked to extend the scope for HTML completions and add support for JSX. Immediately after those changes were applied, I got complaints from other users of my package about this change. It’s not always easy to judge whether such a change makes sense, especially if you’re not familiar with the syntax.

Therefor, I would love if Sublime Text would allow users to extend/manipulate the scope in which snippets/completions are working without having them to alter the actual files, e.g. in the user settings.

[Adamarla]

Workspace APIs (for GIT branches)

I would like to write a plugin to change workspaces based on the current Git branch.

Currently changing branches in Git can leave the current workspace in a mess:

• Files become unsaved if they do not exist in the new branch (they are removed from disk)
• Files open may have nothing to do with the Git branch checkout
• Need to close the branch irrelevant files
• Need to reopen the branch relevant files

I tend to manually create a new workspace for each branch:

GIT.[Branchname].sublime-workspace

I have to manually switch workspaces after a checkout.
I have to manually delete workspaces when I delete the branch.

I would like to be able to load workspaces, create and delete them.

• API to get the path of the current .sublime-workspace file
• API to load a .sublime-workspace file (“Quick Switch Workspace”)
• API to save a .sublime-workspace file (“Save Workspace As…”)
• API to delete a .sublime-workspace file

Additionally, unrelated to workspaces, but useful for this plugin:

• API to monitor specific file for changes

This would allow notification of when the .git/HEAD file is modified (when a checkout occurs), to trigger the workspace switch.

[mlf]

An API to hide a set of lines matching a given criteria (regex or …). When called with None, unhide all hidden lines.

Once hidden, those lines would be excluded from search and edit operations. Similar to what the ‘ALL’ command does on XEDIT and similar editors.

To illustrate, here is a simple directory listing:

Then, after hidding the lines not containing ‘dir’:

Very handy while working with log files and line-oriented files (csv exports, …).

You can still view/search/edit the non-hidden lines, add new content, and so on.

[bizoo]

1. Select the lines you want to hide
2. Menu Edit -> Code Folding -> Fold

You can use RegReplace to do it using REGEXP

[braver]

Menu Edit -> Code Folding -> Fold

Nope:

those lines would be excluded from search and edit operations.

[FichteFoll]

More consistent output panels

Output panels have really odd behaviors currently. In exec.py, there is this code:

if not hasattr(self, 'output_view'):
    # Try not to call get_output_panel until the regexes are assigned
    self.output_view = self.window.create_output_panel("exec")

# [...]

self.output_view.settings().set("result_file_regex", file_regex)
self.output_view.settings().set("result_line_regex", line_regex)
self.output_view.settings().set("result_base_dir", working_dir)
self.output_view.settings().set("word_wrap", word_wrap)
self.output_view.settings().set("line_numbers", False)
self.output_view.settings().set("gutter", False)
self.output_view.settings().set("scroll_past_end", False)
self.output_view.assign_syntax(syntax)

# Call create_output_panel a second time after assigning the above
# settings, so that it'll be picked up as a result buffer
self.window.create_output_panel("exec")

Observations:

1. Window.create_output_panel is run twice. But only at the first time.
2. calling .assign_syntax on the output panel turns it from a widget into an actual view. This causes it to infer its settings from the usual Preferences.sublime-settings files (or more likely, they are not overridden from some widget-specific thing). As a result, the output panel will have its gutter and line numbers visible, which exec.py has to disable explicitly. (more on this)
3. On each call of Window.create_output_panel, its entire contents are erased. Settings are not reset, though.

Priority: minor (it’s “always” been like this and changing behavior of create_output_panel especially wrt 3. would be a breaking change)

Related: API Suggestions

[mlf]

Putting scopes to work

So far, scopes use is limited: syntax coloration and some limited hard-coded features (‘go to symbol’, mostly).

What about extending them, in two ways:

1. being able to specify a scope for the search/replace api (so that we could search/replace for a given expression in comments only, or not in comments, extract all test fragments with a given scope, like we currently extract the list of symbols, jump to the next or previous string (or any scope), and so on);
2. being able to new ‘styling’ options for scopes, with styling being ‘editable/readonly’, or ‘searchable/notsearchable’, and so on.

Priority: minor

[gwenzek]

Speaking about putting scopes to work:

I’d like to have scope based folding instead of just indent based folding.

Similar to the tmPreferences files used by the symbol list,
a setting file would allow to control which scope can be folded.

Importance: Major

[gwenzek]

Also I’d like scope based auto-indentation.

Now the Indentation.tmPreferences is doing regex matching while all the information we need is already extracted by the syntax.

Importance: Minor (since there is already a working mechanism albeit limited)

[FichteFoll]

I also wanted to suggest an indentation system that is based on scopes (and the powerful syntax lexing that’s happening all the time anyway), but hold back onto creating an issue for it since I haven’t yet drafted out a specific suggestion on how I would imagine this feature.
I also wonder if it should be part of the syntax definition or utilize a separate scope-selector-oriented mechanism like tmPreferences do.

[gwenzek]

Another thing that I’d like is improved parsing of the output panel.
For now errors have to be extracted through two regexes, one for the file and one for the line, character offset and message.

So here are 3 suggestions in increasing order of complexity.

1. the output of the C# compiler doesn’t print full path to files, only the name of the file.
   This prevent the “next_result” command to open the correct file.
   Proposed fixed: if the matched path doesn’t exist try to open a file in the current project with the same name.

2. Sometimes the error message is on different line than the line number (eg in Python). So there is no way to capture the error message.
   Proposed fix: add a third regex for the error message.

3. There is no distinctions between errors and warnings. You have to choose when you create the build system if you want to catch both or only errors. Ideally the build system would provide a way to extract both, and the user could choose which one to display.

[FichteFoll]

I hate it that I always find something to comment on in these threads, but I just can’t help it. If that’s not desired, I’ll continue replying to posts in new threads, but I’m on mobile atm.

To 1.: relative file paths are a possibility (and by default relative to the active view’s file’s directory. It can be configured with a setting that you can inspect from exec.py.

To 2.: you can capture the message in the regular expressions, but nothing is really done with it. I think it shows in the status bar on some action.

[braver]

To 2.: you can capture the message in the regular expressions, but nothing is really done with it. I think it shows in the status bar on some action.

If you capture the message in a build systems, it is shown in phantoms. I think there is a build-error tooltips package out there that also uses the messages. So, in 3118 this works as described here.

[gwenzek]

To 2.: you can capture the message in the regular expressions, but nothing is really done with it. I think it shows in the status bar on some action.

I wasn’t aware of that so I updated my feature request.
The problem is that it must be one regex matching both line number and error message.
But for python where the error message is on a different line than the line number, you can’t capture it (confirmed by Jps in the build 3118 thread).

[315234]

Syntax-specific option for case-insensitive goto-definition

There was some discussion here:

Sublime Text 3 "goto definition" case sensitivity

Absolutely love ST3. Got a question tho. I write mostly SQL which is a case insensitive language. The goto defintion feature workes wonderfully (once I did some light hacking on the definition file). The matching regexes work properly: they do case insensitive matching when requested. However, when I f10 on a token that is different in terms of case, it will not find the definition: create table foo(); Foo <- f12 will not match the definition foo <- f12 will match the definition Is…

Essentially, for languages that are case-insensitive (Fortran is the example I care about) it is desirable that goto-definition is case insensitive (e.g. you define MYFUNCTION but then call MyFunction, currently goto-definition doesn’t work for this case). This is already partly solved by the ability to perform a symbol transformation to convert all indexed symbols to lowercase, but goto-definition will then not work on any word that is not lowercase. I see at least three possible solutions:

1. Add a caseInsensitive option to the tmPreferences. This works for case insensitive languages but is the least general approach. It has the advantage that the original capitalisation would be preserved in the symbol list.

2. Apply symbolTransformation to the current word before looking it up in the index. This might break something else, I’m not sure.

3. Add a lookupSymbolTransformation to the tmPreferences that would be applied to the current word before looking it up in the index.

Importance: major for case-insensitive languages

[315234]

Full set of character codes in minihtml

For arbitrary text, the python function html.escape often produces HTML codes that minihtml doesn’t understand, such as ' for ':

import html
view.add_phantom("id", sublime.Region(0,0), html.escape("'"), sublime.LAYOUT_BLOCK)

Obviously this makes it difficult to display arbitrary strings in Phantoms or Popups.

Importance: minor

Edit: It seems that minihtml currently works reliably with only the following substitutions (I have tested with all ASCII characters):

def to_html(s):
    s = s.replace('&', '&')
    s = s.replace('<', '&lt;')
    return s