# require-sort

> A utility for sorting require() statements.

Latest version **0.3.0** (published 2016-04-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install require-sort
pnpm add require-sort
yarn add require-sort
bun add require-sort
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2016-04-13 |
| First published | 2016-04-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jussi Mullo |
| Maintainers | jmullo |
| Keywords | require, sort, node, module |

## Links

- npm: https://www.npmjs.com/package/require-sort
- Repository: https://github.com/jmullo/require-sort
- Issues: https://github.com/jmullo/require-sort/issues
- npm.io page: https://npm.io/package/require-sort

## Dependencies (1)

- [lodash](https://npm.io/package/lodash.md) ^4.8.2

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 0.3.0 (latest) — 2016-04-13
- 0.2.0 — 2016-04-11
- 0.1.0 — 2016-04-07

## README

# require-sort

A utility for sorting require() statements.

[![NPM Version](https://img.shields.io/npm/v/require-sort.svg)](https://www.npmjs.com/package/require-sort)
[![Build Status](https://travis-ci.org/jmullo/require-sort.svg?branch=master)](https://travis-ci.org/jmullo/require-sort)
[![Dependencies Status](https://david-dm.org/jmullo/require-sort.svg)](https://david-dm.org/jmullo/require-sort)
[![Dev Dependencies Status](https://david-dm.org/jmullo/require-sort/dev-status.svg)](https://david-dm.org/jmullo/require-sort#info=devDependencies)

## 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

```js
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

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

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

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

## Options

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

## License

[The MIT License (MIT)](https://github.com/jmullo/require-sort/blob/master/LICENSE)

---
_Source: https://npm.io/package/require-sort · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._