Bug 189589 – Add Copy WebKit Permalink plugin for Sublime Text

• Status: RESOLVED
• Resolution: FIXED
• Component: Tools / Tests

[Daniel Bates]

I frequently switch between Xcode and Sublime Text 3. We should port the Copy WebKit Permalink Automator service to a Sublime Text plugin so that the same functionality can be accessed in Sublime Text. Porting to a Sublime Text plugin would also make this convenience service available to a larger audience because Sublime Text is cross-platform (available on Mac, Linux, and Windows at the time of writing).

[Daniel Bates]

Created attachment 349679 [details]
Patch

I tested this plugin in Sublime Text 3 on Mac version 3.1.1 (build 3176). If someone wants to test aon Window or Linxu that would be great. It should work in Sublime Text 2 given that I used <https://code.tutsplus.com/tutorials/how-to-create-a-sublime-text-2-plugin--net-22685> as a reference when writing the plugin. For now, there are only key bindings for Mac because that is the platform I use and is the platform I am most familiar with the keyboard shortcut conventions for. Do any Windows or Linux developers have suggestions for good (read: do not conflict with other apps) key bindings sequences? We need two sequences: one for generating a permalink without blame annotations and one for generating a permalink with blame annotations.

[EWS Watchlist]

Attachment 349679 [details] did not pass style-queue:


ERROR: Tools/CopyPermalink/Sublime Text/CopyWebKitPermalink/CopyWebKitPermalink.py:35:  [CopyWebKitPermalinkCommand.run] Instance of 'CopyWebKitPermalinkCommand' has no 'view' member  [pylint/E1101] [5]
ERROR: Tools/CopyPermalink/Sublime Text/CopyWebKitPermalink/CopyWebKitPermalink.py:43:  [CopyWebKitPermalinkCommand.run] Instance of 'CopyWebKitPermalinkCommand' has no 'view' member  [pylint/E1101] [5]
ERROR: Tools/CopyPermalink/Sublime Text/CopyWebKitPermalink/CopyWebKitPermalink.py:43:  [CopyWebKitPermalinkCommand.run] Instance of 'CopyWebKitPermalinkCommand' has no 'view' member  [pylint/E1101] [5]
ERROR: Tools/CopyPermalink/Sublime Text/CopyWebKitPermalink/CopyWebKitPermalink.py:51:  [CopyWebKitPermalinkCommand.is_enabled] Instance of 'CopyWebKitPermalinkCommand' has no 'view' member  [pylint/E1101] [5]
ERROR: Tools/CopyPermalink/Sublime Text/CopyWebKitPermalink/CopyWebKitPermalink.py:51:  [CopyWebKitPermalinkCommand.is_enabled] Instance of 'CopyWebKitPermalinkCommand' has no 'view' member  [pylint/E1101] [5]
Total errors found: 5 in 8 files


If any of these errors are false positives, please file a bug against check-webkit-style.

[Daniel Bates]

(In reply to Build Bot from comment #2)
> Attachment 349679 [details] did not pass style-queue:
> 
> 
> ERROR: Tools/CopyPermalink/Sublime
> Text/CopyWebKitPermalink/CopyWebKitPermalink.py:35: 
> [CopyWebKitPermalinkCommand.run] Instance of 'CopyWebKitPermalinkCommand'
> has no 'view' member  [pylint/E1101] [5]
> ERROR: Tools/CopyPermalink/Sublime
> Text/CopyWebKitPermalink/CopyWebKitPermalink.py:43: 
> [CopyWebKitPermalinkCommand.run] Instance of 'CopyWebKitPermalinkCommand'
> has no 'view' member  [pylint/E1101] [5]
> ERROR: Tools/CopyPermalink/Sublime
> Text/CopyWebKitPermalink/CopyWebKitPermalink.py:43: 
> [CopyWebKitPermalinkCommand.run] Instance of 'CopyWebKitPermalinkCommand'
> has no 'view' member  [pylint/E1101] [5]
> ERROR: Tools/CopyPermalink/Sublime
> Text/CopyWebKitPermalink/CopyWebKitPermalink.py:51: 
> [CopyWebKitPermalinkCommand.is_enabled] Instance of
> 'CopyWebKitPermalinkCommand' has no 'view' member  [pylint/E1101] [5]
> ERROR: Tools/CopyPermalink/Sublime
> Text/CopyWebKitPermalink/CopyWebKitPermalink.py:51: 
> [CopyWebKitPermalinkCommand.is_enabled] Instance of
> 'CopyWebKitPermalinkCommand' has no 'view' member  [pylint/E1101] [5]
> Total errors found: 5 in 8 files
> 
> 
> If any of these errors are false positives, please file a bug against
> check-webkit-style.

These warnings can be ignored as Pylint does not have access to the Sublime modules to check dependencies related to inheritance from class sublime_plugin.TextCommand.

[Joseph Pecoraro]

Comment on attachment 349679 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=349679&action=review

Neat! rs=me

> Tools/CopyPermalink/Sublime Text/CopyWebKitPermalink/Context.sublime-menu:2
> +    { "command": "copy_web_kit_permalink" },

Why "web_kit" and not "webkit"?

> Tools/CopyPermalink/Sublime Text/CopyWebKitPermalink/Default (OSX).sublime-keymap:2
> +	{ "keys": ["super+ctrl+shift+c"], "command": "copy_web_kit_permalink" },

Ditto.

[Joseph Pecoraro]

Comment on attachment 349679 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=349679&action=review

>> Tools/CopyPermalink/Sublime Text/CopyWebKitPermalink/Context.sublime-menu:2
>> +    { "command": "copy_web_kit_permalink" },
> 
> Why "web_kit" and not "webkit"?

Maybe this was needed to convert to the python class name: CopyWebKitPermalinkCommand

[Daniel Bates]

(In reply to Joseph Pecoraro from comment #5)
> Comment on attachment 349679 [details]
> Patch
> 
> View in context:
> https://bugs.webkit.org/attachment.cgi?id=349679&action=review
> 
> >> Tools/CopyPermalink/Sublime Text/CopyWebKitPermalink/Context.sublime-menu:2
> >> +    { "command": "copy_web_kit_permalink" },
> > 
> > Why "web_kit" and not "webkit"?
> 
> Maybe this was needed to convert to the python class name:
> CopyWebKitPermalinkCommand

Correct.

[Daniel Bates]

Committed r235981: <https://trac.webkit.org/changeset/235981>

[Radar WebKit Bug Importer]

<rdar://problem/44424184>