Require Helper

by spadgos ALL

A ST2/3 plugin to help with inserting require statements

Details

Versions
2014.06.12.16.14.42

1.0.0
Homepage github.com
Issues github.com
Modified 11 years ago
Last Seen 2 hours ago
First Seen 13 years ago

Installs

Total 3K
Win 1K
Mac 983
Linux 364

	Jul 12	Jul 11	Jul 10	Jul 9	Jul 8	Jul 7	Jul 6	Jul 5	Jul 4	Jul 3	Jul 2	Jul 1	Jun 30	Jun 29	Jun 28	Jun 27	Jun 26	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
Windows	0	0	0	0	0	0	1	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0
Mac	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0
Linux	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0

Readme

Source: raw.githubusercontent.com

RequireHelper

RequireHelper is a small Sublime Text 2 & 3 plugin which allows you to insert file paths relative to your project root, or a custom subfolder.

I wrote it to save me some time when writing Javascript using the CommonJS style:

var Baz = require('foo/bar/baz');

Usage

Activate RequireHelper by pressing its shortcut key (default is Ctrl+Alt+O). Select the file you want by typing its name and press enter. The path, relative to your base is inserted into the document.

Configuration

There are two configuration options. These can be set in your Preferences.sublime-settings file, or in your project file, under the key of settings. (Examples below)

require_helper_base - This is the directory inside your project which should be searched for files.
require_helper_remove_regex - If you want to remove characters from the filename before inserting, you can specify a regex here.

Example

In my project, all my javascript files are in a subfolder called /app. This is the contents of my project file (you can get to this file by selecting Project -> Edit Project

{
  "folders":
  [
    {
      "path": "/home/nick/dev/myproject"
    }
  ],
  "settings": {
    "require_helper_base": "app",
    "require_helper_remove_regex": "\\.js$"
  }
}

For example, when I select a file which is on disk at /home/nick/dev/myproject/app/foo/bar.js, then 'foo/bar is inserted into the document.