require a plain text or binary file in node.js
MIT License
require a plain text or binary file in node.js
$ npm install rfile
var rfile = require('rfile');
var text = rfile('./my-text-file.txt');
var mochaReadme = rfile('mocha/readme.md');
var mochaSource = rfile('mocha');
var image = rfile('image.png', {binary: true});
Uses rfile.resolve
(see below) to look up your file pkg
. This means it supports all the same options as rfile.resolve
. Having found the file, it does the following:
return options.binary ? read(path) : fixup(read(path).toString());
options.binary
defaults to false
and fixup
removes the UTF-8 BOM if present and removes any \r
characters (added to newlines on windows only).
Internally, resolve is used to lookup your package, so it supports all the same options as that. In addition t defaults basedir
to the directory of the function which called rfile
or rfile.resolve
.
The additional option exclude
is useful if you wanted to create a wrapper arround this. It specifies the filenames not to consider for basedir
paths. For example, you could create a module called ruglify
for requiring and minifying JavaScript in one go.
ruglify.js
var rfile = require('rfile');
var uglify require('uglify-js').minify;
module.exports = ruglify;
function ruglify(path, options) {
return minify(rfile.resolve(path, {exclude: [__filename]}), options).code;
}
resolve
__dirname
of the calling module for rfile
)['.js', '.json']
for rfile
)One of the interesting features of this is that it respects the main
field of package.json files. Say you had a module called foo
, you could have a package.json like:
{
"name": "foo",
"version": "1.0.0",
"main": "./foo"
}
You might then have a foo.js
file, containing the JavaScript code of the module, and a foo.css
file containing the stylesheet for the module when used in the browser. Using rfile
you could load the css by simply calling:
rfile('foo', {extensions: ['.css']});
MIT