Git Product home page Git Product logo

any-eval's Introduction

any-eval

Super handy eval of anything.

Supports JS-expression, CommonJS module contents and JSON/JSON5.

NPM Status Travis Status Coverage Status Dependency Status

Install

$ npm install --save any-eval

Usage

JS-expression

const anyEval = require('any-eval');

anyEval('42 * 42'); // 1764

CommonJS

const anyEval = require('any-eval');
const moduleContents =
`
    const package = require('./package.json');

    module.exports = {
        name: package.name
    };
`;

anyEval(moduleContents, './index.js'); // filename need to provide required info to resolve relative paths inside evaluating code

// ➜ { name: 'any-eval' }

JSON

const anyEval = require('any-eval');
const jsonContents = '{ "name": "any-eval" }';

anyEval(jsonContents, 'my.json'); // filename need to `any-eval` determinate json format by extention

// ➜ { name: 'any-eval' }

JSON5

const anyEval = require('any-eval');
const jsonContents = "{ name: 'any-eval' }";

anyEval(jsonContents, 'my.json5'); // filename need to `any-eval` determinate json format by extention

// ➜ { name: 'any-eval' }

API

anyEval(contents[, filename, context])

contents

Type: string

The JS-expression, CommonJS module contents or JSON/JSON5 contents.

filename

Type: string

The path to file which contents we execute.

The any-eval determinate format by extension. If filename ends with .js, its contents will be evaluating with vm. If filename ends with .json, its contents will be parsing with JSON.parse. If filename ends with .json5, its contents will be parsing with json5.

By default expected JS-expression or CommonJS module contents.

const anyEval = require('any-eval');

anyEval('42 * 42'/* js by default */); // 1764
anyEval('42 * 42', 'my.js'); // 1764
anyEval('{ "name": "any-eval" }', 'my.json'); // '{ name: 'any-eval' }'
anyEval("{ name: 'any-eval' }", 'my.json5');  // '{ name: 'any-eval' }'

To evaluating CommonJS module contents filename is required to resolve relative paths inside evaluating code.

const anyEval = require('any-eval');
const moduleContents =
`
    const package = require('./package.json'); // to resolve this require need to know the path of current module (./index.js)

    module.exports = {
        name: package.name
    };
`;

anyEval(moduleContents, './index.js'); // filename need to provide required info to resolve relative paths inside evaluating code

Internally any-eval will resolve passed relative paths using the place it's called (like require do).

It may spend additional processor's time on it, so better to pass in absolute path.

const fs = require('fs');
const anyEval = require('any-eval');

// For example, current path is "/repos/project/lib/file.js".
const modulePath = '../files/another.js';
const moduleContents = fs.readFileSync(modulePath, 'utf-8');

// '../files/another.js' will be resolved to '/repos/project/files/another.js'
anyEval(moduleContents, modulePath);

context

Type: Object

The object to provide into execute method.

If context is specified, then module contents will be evaluating with vm.runInNewContext.

If context is not specified, then module contents will be evaluating with vm.runInThisContext.

With context you can provide some like-a-global variables into any-eval.

const anyEval = require('any-eval');

const secretKey = '^___^';
const contents = 'module.exports = secretKey;';

anyEval(content, { secretKey }); // '^___^'

Related

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.