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 1K
  • Win 736
  • OS X 356
  • Linux 246
Jan 20 Jan 19 Jan 18 Jan 17 Jan 16 Jan 15 Jan 14 Jan 13 Jan 12 Jan 11 Jan 10 Jan 9 Jan 8 Jan 7 Jan 6 Jan 5 Jan 4 Jan 3 Jan 2 Jan 1 Dec 31 Dec 30 Dec 29 Dec 28 Dec 27 Dec 26 Dec 25 Dec 24 Dec 23 Dec 22 Dec 21 Dec 20 Dec 19 Dec 18 Dec 17 Dec 16 Dec 15 Dec 14 Dec 13 Dec 12 Dec 11 Dec 10 Dec 9 Dec 8 Dec 7 Dec 6
Windows 0 0 1 4 1 3 0 1 2 1 1 1 0 1 0 1 1 2 1 0 2 1 1 2 1 1 0 0 0 0 0 3 3 2 0 3 1 1 0 2 0 1 1 4 0 2
OS X 1 4 0 2 0 0 1 0 0 2 1 1 0 0 0 0 0 0 0 0 0 1 2 1 2 0 1 0 1 0 0 0 2 2 0 1 1 0 0 0 0 0 0 0 0 1
Linux 0 0 1 0 1 0 0 0 1 0 1 0 0 3 0 0 0 0 0 1 0 0 0 1 0 0 0 0 1 0 2 2 0 0 0 0 1 1 0 0 1 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';