# stylus-lookup

> Get the file associated with an imported/required Stylus partial

Latest version **7.0.0** (published 2026-05-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install stylus-lookup
pnpm add stylus-lookup
yarn add stylus-lookup
bun add stylus-lookup
```

Provides the command `stylus-lookup`.

## Health

**Score 55/100 (C)** — status: active.

Positive: esm support; no vulnerabilities; high maintenance score.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 7.0.0 |
| Published | 2026-05-19 |
| First published | 2015-06-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Node | >=20.19.0 \|\| >=22.12.0 |
| Dependencies | 1 |
| Unpacked size | 7.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Joel Kemp |
| Maintainers | pahen, mrjoelkemp, xhmikosr |
| Keywords | stylus, lookup, dependency, partial |

## Links

- npm: https://www.npmjs.com/package/stylus-lookup
- Repository: https://github.com/dependents/node-stylus-lookup
- Issues: https://github.com/dependents/node-stylus-lookup/issues
- npm.io page: https://npm.io/package/stylus-lookup

## Dependencies (1)

- [commander](https://npm.io/package/commander.md) ^14.0.3

## Recent versions

- 7.0.0 (latest) — 2026-05-19
- 6.1.2 — 2026-04-25
- 6.1.1 — 2026-04-14
- 6.1.0 — 2025-01-30
- 6.0.0 — 2024-04-10
- 5.0.1 — 2023-05-13
- 5.0.0 — 2023-05-05
- 4.0.1 — 2023-04-24
- 4.0.0 — 2023-04-24
- 3.0.2 — 2018-12-12
- 3.0.1 — 2018-11-18
- 3.0.0 — 2018-11-18
- 2.0.0 — 2018-07-08
- 1.0.2 — 2017-09-30
- 1.0.1 — 2016-07-17
- … 1 more at https://npm.io/package/stylus-lookup/versions

## README

# stylus-lookup

[![CI](https://img.shields.io/github/actions/workflow/status/dependents/node-stylus-lookup/ci.yml?branch=main&label=CI&logo=github)](https://github.com/dependents/node-stylus-lookup/actions/workflows/ci.yml?query=branch%3Amain)
[![npm version](https://img.shields.io/npm/v/stylus-lookup?logo=npm&logoColor=fff)](https://www.npmjs.com/package/stylus-lookup)
[![npm downloads](https://img.shields.io/npm/dm/stylus-lookup)](https://www.npmjs.com/package/stylus-lookup)

> Get the file associated with a Stylus import

This module replaces the Stylus compiler's lookup algorithm for resolving a partial's path.

* Handles same directory lookups, partials with or without extensions, partials within subdirectories,
partials with the `.styl` or `.css` in the name, partials using the `index.styl` resolution.
* **Does not** currently support glob imports or the use of additional paths. PRs welcome.

*Originally built for [Dependents](https://github.com/dependents/Dependents)*

## Usage

ESM:

```js
import stylusLookup from 'stylus-lookup';

stylusLookup({
  dependency: 'foo',
  filename: 'path/to/file',
  directory: 'path/to/all/files'
});
```

CJS:

```js
const { default: stylusLookup } = require('stylus-lookup');

stylusLookup({
  dependency: 'foo',
  filename: 'path/to/file',
  directory: 'path/to/all/files'
});
```

* `dependency`: The partial's name
  * If your stylus file had `@import foo`, then `foo` would be the dependency name
* `filename`: The file importing the dependency
* `directory`: The location of all stylus files

Example:

```js
import stylusLookup from 'stylus-lookup';

stylusLookup({
  dependency: 'variables',
  filename: 'app/styles/styles.styl',
  directory: 'app/styles'
}); // yields app/styles/variables.styl
```

* This assumes that the file `app/styles/styles.styl` has `@import variables` or `@require variables`
and that all of the other stylus files are located within `app/styles`.

## CLI

Assumes a global install of `stylus-lookup` with `npm install -g stylus-lookup`

```sh
stylus-lookup [options] <dependency>
```

| Option | Description |
|---|---|
| `-f, --filename <path>` | File containing the import/require |
| `-d, --directory <path>` | Root location of all Stylus files |

Example:

```sh
stylus-lookup --filename app/styles/styles.styl --directory app/styles variables
# yields app/styles/variables.styl
```

Run `stylus-lookup --help` to see all the options.

## License

[MIT](LICENSE)

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