require-sort

0.3.0 • Public • Published

require-sort

A utility for sorting require() statements.

NPM Version Build Status Dependencies Status Dev Dependencies Status

Installation

$ npm install require-sort

Functionality

  • Sorts based on required name, not variable name
  • Sorts into groups based on directory location
  • Sorts all sections of require statements
var alpha = require("alpha");           // external group
var xalpha = require("xalpha");         // ...
var beta = require("beta/beta");        // path group
var xbeta = require("xbeta/xbeta");     // ...
var gamma = require("/gamma");          // absolute group
var xgamma = require("/xgamma");        // ...
var delta = require("./delta");         // relative group
var xdelta = require("./xdelta");       // ...
var epsilon = require("../epsilon");    // parent group
var xepsilon = require("../xepsilon");  // ...

Usage

var sorter = require("require-sort");

// file content in inputString
var sortedString = sorter.sortString(inputString);

// custom options object
var sortedString = sorter.sortString(inputString, options);

Options

var options = {
    emptyLines: false   // separate require statement groups with empty lines
};

License

The MIT License (MIT)

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 0.3.0
    20
    • latest

Version History

  • Version
    Downloads (Last 7 Days)
    • Published
  • 0.3.0
    20
  • 0.2.0
    0
  • 0.1.0
    0

Package Sidebar

Install

npm i require-sort

Weekly Downloads

20

Version

0.3.0

License

MIT

Last publish

Collaborators

  • jmullo