findme

Textual module requirement specification

npm install findme
1 downloads in the last day
1 downloads in the last week
37 downloads in the last month

findme

FindMe is a small node library that is designed to parse a string and generate a list of dependencies that have been found in the string embedded in // dep: or // req: comments.

Build Status

browser support

Requirement Definition

A requirement can be defined in a number of ways. Firstly, you can specify a module simply by name:

// req: underscore

Versioning

or, you can specify a particular version of underscore:

// req: underscore 1.3.x

NOTE: While findme uses the semver syntax you can only specify either a concrete version (e.g. 1.3.3) or a latest patch release for a specific minor version (e.g. 1.3.x). Support for other patterns has not been provided as in general using patterns such as >= 1 and the like are discouraged when building apps.

Aliases

In the case of some packages / modules, they are usually given an alias within the context of your code. For instance, the underscore module exports itself as the _ character. To support this in findme powered libraries, simply specify your requirement with an alias:

// req: underscore as _
npm loves you