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