ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Regex​Explain​Tip

by rubikonx9 ST3

SublimeText 3 plugin for displaying regular expression explanations

Labels utilities

Details

Installs

  • Total 2K
  • Win 1K
  • OS X 515
  • Linux 345
Oct 19 Oct 18 Oct 17 Oct 16 Oct 15 Oct 14 Oct 13 Oct 12 Oct 11 Oct 10 Oct 9 Oct 8 Oct 7 Oct 6 Oct 5 Oct 4 Oct 3 Oct 2 Oct 1 Sep 30 Sep 29 Sep 28 Sep 27 Sep 26 Sep 25 Sep 24 Sep 23 Sep 22 Sep 21 Sep 20 Sep 19 Sep 18 Sep 17 Sep 16 Sep 15 Sep 14 Sep 13 Sep 12 Sep 11 Sep 10 Sep 9 Sep 8 Sep 7 Sep 6 Sep 5 Sep 4
Windows 2 0 1 0 0 2 1 1 0 1 0 2 0 0 0 3 3 2 0 0 0 1 0 2 4 0 1 0 1 1 4 2 0 1 1 0 2 2 1 1 1 0 1 1 3 3
OS X 2 0 1 0 3 0 0 1 1 1 1 1 0 0 0 1 0 0 0 0 1 0 1 0 0 0 0 0 0 2 1 0 0 1 0 3 1 1 0 0 0 0 0 0 0 0
Linux 0 1 0 0 0 0 0 0 0 0 0 0 0 0 1 2 1 0 1 0 0 0 0 1 0 1 1 0 0 0 0 2 0 2 0 0 0 0 1 2 0 0 0 0 0 0

Readme

Source
raw.​githubusercontent.​com

SublimeRegexExplainTip

SublimeText 3 plugin for displaying regular expression explanations

What it looks like

Screenshot

Why?

As some regular expressions are write-only code, it's sometimes useful to obtain a description of what a particular regex actually does. Having it available in a text editor can be an asset.

Installation

Install via Package Control. Alternatively, clone this repository to Packages directory.

How to use

Press Shift+Super+Alt+R to display the explanation of selected text. Currently, a region must be explicitly selected.

Customization

It is possible to use custom CSS files. You can define the CSS file in settings file (navigate to Preferences -> Package Settings -> RegexExplainTip -> Settings - User) under css_file key:

{
    "css_file": "Packages/User/my-custom.css"
}

You should locate the file somewhere under Packages (Preferences -> Browse Packages...) directory.

Dependencies

The plugin uses YAPE::Regex::Explain to obtain the regex explanation. Therefore, Perl with YAPE::Regex::Explain module installed is required.

Caveats

As this plugin relies on external Perl installation and modules, one must have correct environment setup. This includes proper value if Perl's @INC variable, which allows Perl to find required modules. This directory depends on you environment settings, OS, CPAN configuration and so on.

For example, you might need to define the paths in PERL5LIB variable:

export PERL5LIB=/some/perl/installation/directory/lib.

Alternatively, one may add the following line to Perl code declared in get_explanation method:

use lib 'c:/StrawberryPERL/perl/site/lib';