stylus-bundle

Bundles all SCSS imports into a single file recursively. This is a fork of scss-bundle which now only supports non-cli usage. Any help appreciated.





Non-CLI usage

This package now supports only non-CLI usage.

$3

``typescript
import path from "path";
import { Bundler } from "stylus-bundle";

(async () => {
// Absolute project directory path.
const projectDirectory = path.resolve(__dirname, "./cases/tilde-import");
const bundler = new Bundler(undefined, projectDirectory);
// Relative file path to project directory path.
const result = await bundler.bundle("./main.styl");
})();
`

API

Bundler

`typescript
import { Bundler } from "stylus-bundle";
`

$3

`ts
constructor(fileRegistry: FileRegistry = {}, projectDirectory?: string) {}
`

##### Arguments

- fileRegistry?: Registry - Dictionary of files contents by full path
- projectDirectory?: string - Absolute project location, where node_modules are located. Used for resolving tilde imports

$3

#### bundle

`typescript
public async bundle(file: string, fileRegistry: Registry = {}): Promise
`

##### Arguments

- file: string - Main file full path
- fileRegistry: Registry - Dictionary of files contents by full path

##### Returns

Promise<BundleResult>

$3

#### BundleResult

`typescript
import { BundleResult } from "stylus-bundle";
`

`typescript
interface BundleResult {
imports?: BundleResult[];
tilde?: boolean;
filePath: string;
content?: string;
found: boolean;
}
`

##### Properties

- imports: BundleResult[] - File imports array
- tilde?: boolean - Used tilde import
- filePath: string - Full file path
- content: string - File content
- found: boolean - Is file found

#### Registry

`typescript
import { Registry } from "stylus-bundle";
`

`typescript
interface Registry {
[id: string]: string | undefined;
}
`

##### Key

id: string - File full path as dictionary id

##### Value

string | undefined` - File content

License

Released under the MIT license.