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

Require Helper

by spadgos ST2/ST3

A ST2/3 plugin to help with inserting require statements

Details

  • 2 2014.06.12.16.14.42
    3 1.0.0
  • github.​com
  • github.​com
  • 5 years ago
  • 2 hours ago
  • 7 years ago

Installs

  • Total 2K
  • Win 1K
  • OS X 949
  • Linux 338
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 Sep 3 Sep 2 Sep 1 Aug 31 Aug 30 Aug 29 Aug 28 Aug 27 Aug 26 Aug 25 Aug 24 Aug 23 Aug 22 Aug 21 Aug 20 Aug 19 Aug 18 Aug 17 Aug 16 Aug 15 Aug 14 Aug 13 Aug 12 Aug 11 Aug 10 Aug 9 Aug 8 Aug 7 Aug 6 Aug 5
Windows 1 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 1 0 0 0 0 0 0
OS X 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 2 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.