node-hook-filename v1.0.0

node-hook-filename

Hooking node require calls for specific requests to only return the filename or the return value of a callback.

Usage

Returning filename

const nhf = require('node-hook-filename')

nhf([ /\.scss/, /\.svg/ ])

const scssAsset = require('../path/too/filename.scss')
const svgAsset = require('../path/too/filename.svg')
const normalRequire = require('../path/too/js/file')

// scssAsset === '../path/too/filename.scss'
// svgAsset === '../path/too/filename.svg'

// normalRequire is unaffected

Passing a callback function

const nhf = require('node-hook-filename')
nhf([ /config/ ], (filename) => 'foo ' + filename)

const configRequire = require('config')
// configRequire will return 'foo config'

Handy if you are running a universal/isomorphic app that requires asset files.

This is mostly useful for testing and not production ready!

Greatly influenced by https://github.com/bahmutov/node-hook

Bonus

There's a normalize function you can supply as callback if you like

const nhf = require('node-hook-filename')
nhf([ /config/ ], nhf.normalize)

const file = require('./file-in-my-app')
// file === '/my-ap/file-in-my-app'

This is handy to avoid absolute URLs whilst enforcing consistency

It assumes you are running commands from the root of your project