1. static-module
convert module usage to inline expressions
static-module
Package: static-module
Created by: substack
Last modified: Tue, 08 Nov 2022 10:41:08 GMT
Version: 3.0.4
License: MIT
Downloads: 4,743,728
Repository: https://github.com/substack/static-module

Install

npm install static-module
yarn add static-module

static-module

convert module usage to inline expressions

example

Here's a simplified version of the brfs module
using static-module.

brfs converts fs.readFileSync(file) calls to inline strings with the contents
of file included in-place.

 var staticModule = require('static-module');
var quote = require('quote-stream');
var fs = require('fs');

var sm = staticModule({
    fs: {
        readFileSync: function (file) {
            return fs.createReadStream(file).pipe(quote());
        }
    }
}, { vars: { __dirname: __dirname + '/brfs' } });
process.stdin.pipe(sm).pipe(process.stdout);

input:

$ cat brfs/source.js
var fs = require('fs');
var src = fs.readFileSync(__dirname + '/x.txt');
console.log(src);

output:

$ node brfs.js < brfs/source.js 

var src = "beep boop\n";
console.log(src);

methods

 var staticModule = require('static-module')

var sm = staticModule(modules, opts={})

Return a transform stream sm that transforms javascript source input to
javascript source output with each property in the modules object expanded in
inline form.

Properties in the modules object can be ordinary values that will be included
directly or functions that will be executed with the statically
evaluated
arguments from the source
under an optional set of opts.vars variables.

Property functions can return streams, in which case their contents will be
piped directly into the source output.

Otherwise, the return values of functions will be inlined into the source in
place as strings.

Use opts.varModules to map whitelisted module names to definitions that can be
declared in client code with var and will appear in static expressions like
opts.vars.

For example, to make this code with path.join() work:

 var fs = require('fs');
var path = require('path');
var src = fs.readFileSync(path.join(__dirname, 'x.txt'), 'utf8');
console.log(src);

you can do:

 var staticModule = require('static-module');
var quote = require('quote-stream');
var fs = require('fs');

var sm = staticModule({
    fs: {
        readFileSync: function (file) {
            return fs.createReadStream(file).pipe(quote());
        }
    },
    varMods: { path: require('path') }
}, { vars: { __dirname: __dirname + '/brfs' } });
process.stdin.pipe(sm).pipe(process.stdout);

Use opts.parserOpts to set additional options for the
acorn parser.

Set opts.sourceMap to true to generate a source map and add it as an inline
comment. You can add opts.inputFilename to configure the original file name
that will be listed in the source map.

install

With npm do:

npm install static-module

license

MIT

RELATED POST

10 Must-Know Windows Shortcuts That Will Save You Time

10 Must-Know Windows Shortcuts That Will Save You Time

Arrays vs Linked Lists: Which is Better for Memory Management in Data Structures?

Arrays vs Linked Lists: Which is Better for Memory Management in Data Structures?

Navigating AWS Networking: Essential Hacks for Smooth Operation

Navigating AWS Networking: Essential Hacks for Smooth Operation

Achieving Stunning Visuals with Unity's Global Illumination

Achieving Stunning Visuals with Unity's Global Illumination

Nim's Hidden Gems: Lesser-known Features for Writing Efficient Code

Nim's Hidden Gems: Lesser-known Features for Writing Efficient Code