Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jonschlinkert/whence
Add context awareness to your apps and frameworks by safely evaluating user-defined conditional expressions. Useful for evaluating expressions in config files, prompts, key bindings, completions, templates, and many other user cases.
https://github.com/jonschlinkert/whence
Last synced: 3 days ago
JSON representation
Add context awareness to your apps and frameworks by safely evaluating user-defined conditional expressions. Useful for evaluating expressions in config files, prompts, key bindings, completions, templates, and many other user cases.
- Host: GitHub
- URL: https://github.com/jonschlinkert/whence
- Owner: jonschlinkert
- License: mit
- Created: 2021-09-07T15:06:54.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2021-09-22T06:41:05.000Z (about 3 years ago)
- Last Synced: 2024-10-03T12:38:17.483Z (about 1 month ago)
- Language: JavaScript
- Size: 62.5 KB
- Stars: 35
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/funding.yml
- License: LICENSE
Awesome Lists containing this project
README
# whence [](https://www.npmjs.com/package/whence) [](https://npmjs.org/package/whence) [](https://npmjs.org/package/whence) [](https://github.com/jonschlinkert/whence/actions/workflows/test.yml)
> Add context awareness to your apps and frameworks by safely evaluating user-defined conditional expressions. Useful for evaluating expressions in config files, prompts, key bindings, completions, templates, and many other user cases.
Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
## Install
Install with [npm](https://www.npmjs.com/) (requires [Node.js](https://nodejs.org/en/) >=14):
```sh
$ npm install --save whence
```
## What is whence?
This libarary doest returneth true if thine 'when' clause doest matcheth the granted context object.
Seriously though, what does this library do?
Whence uses [eval-estree-expression](https://github.com/jonschlinkert/eval-estree-expression) to _safely evaluate_ user-defined conditional expressions, sometimes referred to as "when" clauses.
Why do I need this?
Add _context awareness_ to your apps and frameworks.
Conditional expressions are useful in config files, creating prompts, determining key bindings, filtering suggestions and completions, variables in templates and snippets, and many other user cases.
It's even more useful when those conditional expressions can be evaluated safely.
**Example: configuration files**
For example, when authoring configuration files for workflows, pipelines, builds, and so on, it's common for developers to define expressions with conditionals to determine if or when a job, task, or step should run based on environment variables, etc. These configurations are typically defined using YAML, JSON or a similar data format, which means that conditional expressions must be written as strings, booleans, or numbers. Whence makes it safe and easy to evaluate these expressions.
**Other use cases**
* Templates and snippets - Use whence to conditionally render files, sections, or variables
* Completions and suggestions - Use whence to filter completions and suggestions in your text editor or prompt system
* Key bindings - [VS Code](https://code.visualstudio.com/api/references/when-clause-contexts) and other text editors use `when` clauses or something similar to determine the keybindings to use when a key is pressed.
How safe is it?
No assignment operators, functions, or function calls are allowed by default to make it as safe as possible to evaluate user-defined expressions. To accomplish this, `whence` uses the [eval-estree-expression](https://github.com/jonschlinkert/eval-estree-expression) library, which takes an [estree](https://github.com/estree/estree) expression from [@babel/parser][], [esprima](http://esprima.org), [acorn](https://github.com/acornjs/acorn), or any similar library that parses and returns a valid `estree` expression.
Why another "eval" library?
**What we found**
Every other eval library I found had one of the following shortcomings:
* Uses `eval` or Node's `vm` or something similar to evaluate code. This is to risky, or too heavy for our use cases.
* Functions are either the primary use case or are supported by default. We don't want users to be able to define functions in their config files.
* Naive attempts to sanitize code before evaluating it
* Brittle, incomplete, hand-rolled parsers
**What whence does differently**
* Whence takes a valid [estree][] AST for an _expression_, not statements, functions, etc.
* Although functions are not supported by default, you can enable support if you really need it (see the [eval-estree-expression](https://github.com/jonschlinkert/eval-estree-expression) docs for more details)
* Special care was taken in [eval-estree-expression](https://github.com/jonschlinkert/eval-estree-expression) to disallow assignment operators, functions, or other potentially malicious code, like setting `__proto__`, `constructor`, `prototype`, or `undefined` as property names on nested properties.
## Usage
```js
const whence = require('whence');
// async usage
console.log(await whence('name =~ /^d.*b$/', { name: 'doowb' })); //=> true
console.log(await whence('amount > 100', { amount: 101 })); //=> true
console.log(await whence('a < b && c > d', { a: 0, b: 1, c: 3, d: 2 })); //=> true
console.log(await whence('platform === "darwin"', { platform: process.platform })); //=> true if macOS
console.log(await whence('platform === "darwin"', { platform: 'win32' })); //=> false
// sync usage
console.log(whence.sync('name =~ /^d.*b$/', { name: 'doowb' })); //=> true
console.log(whence.sync('amount > 100', { amount: 101 })); //=> true
console.log(whence.sync('a < b && c > d', { a: 0, b: 1, c: 3, d: 2 })); //=> true
console.log(whence.sync('platform === "darwin"', { platform: process.platform })); //=> true if macOS
console.log(whence.sync('platform === "darwin"', { platform: 'win32' })); //=> false
```
See [eval-estree-expression](https://github.com/jonschlinkert/eval-estree-expression) and that project's unit tests for many more examples of the types of expressions that are supported.
## How whence works
Whence's default behavior (and purpose) is to return a boolean. Most implementors will be interested in this library for that reason. However, if you need the evaluated result and do not want values to be cast to booleans, you should probably use [eval-estree-expression](https://github.com/jonschlinkert/eval-estree-expression) directly. For example:
```js
// whence behavior
console.log(whence.sync('1 + 9')); //=> true
// eval-estree-expression behavior
console.log(whence.sync('1 + 9')); //=> 10
```
## API
### [equal](index.js#L38)
Returns true if the given value is truthy, or the `value` ("left") is
equal to or contained within the `context` ("right") value. This method is
used by the `whence()` function (the main export), but you can use this
method directly if you don't want the values to be evaluated.
**Params**
* `value` **{any}**: The value to test.
* `context` **{Object}**: The value to compare against.
* `parent` **{[type](https://github.com/medikoo/type)}**
* `returns` **{Boolean}**: Returns true or false.
### [parse](index.js#L138)
Parses the given expression string with [@babel/parser][] and returns and AST. You may also an [estree][]-compatible expression AST.
**Params**
* `source` **{String}**: Expression string or an [estree][]-compatible expression AST.
* `options` **{Object}**
* `returns` **{Object}**
**Example**
```js
const { parse } = require('whence');
console.log(parse('platform === "darwin"'));
// Resuls in something like this:
// Node {
// type: 'BinaryExpression',
// value: Node { type: 'Identifier', name: 'platform' },
// operator: '===',
// context: Node {
// type: 'StringLiteral',
// extra: { rawValue: 'darwin', raw: '"darwin"' },
// value: 'darwin'
// }
// }
```
### [whence](index.js#L171)
Asynchronously evaluates the given expression and returns a boolean.
**Params**
* `source` **{String|Object}**: Expression string or an [estree][]-compatible expression AST.
* `context` **{Object}**
* `options` **{Object}**
* `returns` **{Boolean}**
**Example**
```js
const whence = require('whence');
console.log(await whence('10 < 20')); //=> true
console.log(whence.sync('10 < 20')); //=> true
```
### [whenceSync](index.js#L204)
Synchronous version of [whence](#whence). Aliased as `whence.sync()`.
**Params**
* `source` **{String|Object}**: Expression string or an [estree][]-compatible expression AST.
* `context` **{Object}**
* `options` **{Object}**
* `returns` **{Boolean}**
**Example**
```js
const { whenceSync } = require('whence');
console.log(whenceSync('10 < 20')); //=> true
```
### [compile](index.js#L238)
Compiles the given expression and returns an async function.
**Params**
* `source` **{String|Object}**: Expression string or an [estree][]-compatible expression AST.
* `options` **{Object}**
* `returns` **{Function}**: Returns a function that takes a `context` object.
**Example**
```js
const { compile } = require('whence');
const fn = compile('type === "foo"');
console.log(await fn({ type: 'foo' })); //=> true
console.log(await fn({ type: 'bar' })); //=> false
```
### [compileSync](index.js#L264)
Synchronous version of [compile](#compile). This method is also alias as `.compile.sync()`.
**Params**
* `source` **{String|Object}**: Expression string or an [estree][]-compatible expression AST.
* `options` **{Object}**
* `returns` **{Function}**: Returns a function that takes a `context` object.
**Example**
```js
const { compile } = require('whence');
const fn = compile.sync('type === "foo"');
console.log(fn({ type: 'foo' })); //=> true
console.log(fn({ type: 'bar' })); //=> false
```
## Options
Supports all options from [eval-estree-expression](https://github.com/jonschlinkert/eval-estree-expression).
### functions
Although whence doesn't like functions...
```js
console.log(whence.sync('/[a-c]+/.test(foo)', { foo: 'bbb' })); //=> throws an error
```
You can talk whence into evaluating them by setting the `functions` option to true.
```js
console.log(whence.sync('/[a-c]+/.test(foo)', { foo: 'bbb' }, { functions: true })); //=> true
console.log(whence.sync('/[a-c]+/.test(foo)', { foo: 'zzz' }, { functions: true })); //=> false
```
## Examples
## About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Running Tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
```sh
$ npm install && npm test
```
Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Author
**Jon Schlinkert**
* [GitHub Profile](https://github.com/jonschlinkert)
* [Twitter Profile](https://twitter.com/jonschlinkert)
* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
### License
Copyright © 2021, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on September 22, 2021._