NodeRequirer
A Sublime Text 3 plugin for requiring modules.
Details
Installs
- Total 23K
- Win 12K
- Mac 6K
- Linux 5K
Jul 26 | Jul 25 | Jul 24 | Jul 23 | Jul 22 | Jul 21 | Jul 20 | Jul 19 | Jul 18 | Jul 17 | Jul 16 | Jul 15 | Jul 14 | Jul 13 | 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 | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Windows | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 1 | 0 | 0 | 3 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 1 | 0 | 1 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 2 | 0 | 0 | 1 |
Mac | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 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 |
Linux | 0 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 1 | 0 | 0 | 0 | 0 |
Readme
- Source
- raw.githubusercontent.com
NodeRequirer - A Sublime Text 3 plugin for requiring node modules
Sublime Text 3
About
This is a Sublime Text 3 plugin allowing you to easily require node modules without having to worry about relative paths. It parses your project to allow you to require any local module or dependency listed in your package.json. In addition, it allows you to include node core modules.
Usage
ctrl+shift+i
=> RequireCommand
Provides a dropdown of local files, node core modules, and dependencies defined in package.json + bower.json
SublimeRequirer will insert var {modulename} = require('/path/to/modulename.js')
.
ctrl+shift+e
=> RequireSpecificExportCommand
Provides same initial drop down as RequireCommand
. After selecting a module, the plugin will
attempt to parse the file or dependency to look for commonjs exports, and show a list of possible
exports. The user may then select one or more exports to be required.
Example with single export selection:
var doSomething = require('../../utils/index.js').doSomething;
Example with multiple export selection:
var utils = require('../../utils/index.js');
var doSomething = utils.doSomething;
var doAnotherThing = utils.doAnotherThing;
Or with the destructuring option in preferences set to true…
var { doSomething, doAnotherThing } = require('../../utils/index.js');
ctrl+shift+o
=> RequireFromWordCommand
With the cursor on the desired variable, press ctrl+shift+o
to have NodeRequirer import
the corresponding module at the bottom of the current imports list. A fuzzy string matching
algorithm similar to how Sublime Text filters lists on user input is used to select the best
matching module to import. This is a new feature, and there still is some work to do on making
it work perfectly in all scenarios.
Options
NodeRequirer
exposes several useful plugin options for configuring aliases, import modes and quotes. These are available under Preferences -> Package Settings -> Node Require
or search for NodeRequirer: Set plugin options
Example User Plugin Preferences
{
// Type of quotes to use
"quotes": "single || double",
// Use 'var', 'const', or 'let' variable declarations
"var": "var",
// Use ES6 import format, when syntactically correct. Use detect to determine based on file buffer
"import": "detect",
// Whether to use ES6 import or require in detect mode when
// the format could not be identified (e.g. when neither were used in file)
"detect_prefer_import": true,
"alias": {
// <module name>: <variable name>
"underscore": "_"
},
// Use object destructuring when assigning multiple exports
"destructuring": false,
// Use snippets when inserting require statements to allow
// for easy variable name changing
"snippet": true,
// Directories to exclude when searching for files to require
// The default directories excluded are [".git", "bower_components", "node_modules"]
"exclude_dirs": [".git", "bower_components", "node_modules", "somerandom_directory"],
// File patterns to include in searches. Basically does a substring search.
// Default patterns:
"importable_extensions": [
// plain js
"js", "jsx", "tsx",
// css
"css", "less", "scss",
// images
"svg", "jpg", "png", "gif",
// templates
"hbs", "html", "ejs",
// schemas
"yaml", "json", "xml"
]
}
Installation
Through Sublime Package Manager
Ctrl+Shift+P
orCmd+Shift+P
in Linux/Windows/OS X- type
install
, selectPackage Control: Install Package
- type
NodeRequirer
, selectNodeRequirer
Options
You can configure project aliases and quote options in the plugin options ctrl+shift+p
and find NodeRequirer: Set Plugin Options
Manually
Make sure you use the right Sublime Text folder. For example, on OS X, packages for version 2 are in ~/Library/Application\ Support/Sublime\ Text\ 2
, while version 3 is labeled ~/Library/Application\ Support/Sublime\ Text\ 3
.
These are for Sublime Text 3:
Mac
git clone https://github.com/ganemone/NodeRequirer.git ~/Library/Application\ Support/Sublime\ Text\ 3/Packages/NodeRequirer
Linux
git clone https://github.com/ganemone/NodeRequirer.git ~/.config/sublime-text-3/Packages/NodeRequirer
Windows
git clone https://github.com/ganemone/NodeRequirer.git "%APPDATA%/Sublime Text 3/Packages/NodeRequirer"