pax_global_header00006660000000000000000000000064135401427640014520gustar00rootroot0000000000000052 comment=9cc82c9b9736ba064450be8c0d174b4f325bcc43 constantinople-4.0.1/000077500000000000000000000000001354014276400145625ustar00rootroot00000000000000constantinople-4.0.1/.editorconfig000066400000000000000000000002411354014276400172340ustar00rootroot00000000000000root = true [*] charset = utf-8 indent_style = space indent_size = 2 tab_width = 2 end_of_line = lf insert_final_newline = true trim_trailing_whitespace = true constantinople-4.0.1/.gitattributes000066400000000000000000000007431354014276400174610ustar00rootroot00000000000000# Auto detect text files and perform LF normalization * text=auto # Custom for Visual Studio *.cs diff=csharp *.sln merge=union *.csproj merge=union *.vbproj merge=union *.fsproj merge=union *.dbproj merge=union # Standard to msysgit *.doc diff=astextplain *.DOC diff=astextplain *.docx diff=astextplain *.DOCX diff=astextplain *.dot diff=astextplain *.DOT diff=astextplain *.pdf diff=astextplain *.PDF diff=astextplain *.rtf diff=astextplain *.RTF diff=astextplain constantinople-4.0.1/.gitignore000066400000000000000000000001471354014276400165540ustar00rootroot00000000000000lib-cov *.seed *.log *.csv *.dat *.out *.patch *.pid *.gz pids logs results node_modules lib yarn.lock constantinople-4.0.1/.prettierrc000066400000000000000000000003011354014276400167400ustar00rootroot00000000000000{ "bracketSpacing": false, "singleQuote": true, "trailingComma": "all", "overrides": [ { "files": "*.js", "options": { "trailingComma": "es5" } } ] }constantinople-4.0.1/.travis.yml000066400000000000000000000000651354014276400166740ustar00rootroot00000000000000language: node_js node_js: - "8" - "10" - "12" constantinople-4.0.1/LICENSE000066400000000000000000000020421354014276400155650ustar00rootroot00000000000000Copyright (c) 2013 Forbes Lindesay Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.constantinople-4.0.1/README.md000066400000000000000000000037531354014276400160510ustar00rootroot00000000000000# constantinople Determine whether a JavaScript expression evaluates to a constant (using Babylon). Here it is assumed to be safe to underestimate how constant something is. [![Build Status](https://img.shields.io/travis/pugjs/constantinople/master.svg)](https://travis-ci.org/pugjs/constantinople) [![Dependency Status](https://img.shields.io/david/pugjs/constantinople.svg)](https://david-dm.org/pugjs/constantinople) [![NPM version](https://img.shields.io/npm/v/constantinople.svg)](https://www.npmjs.org/package/constantinople) ## Installation npm install constantinople ## Usage ```js var isConstant = require('constantinople'); if (isConstant('"foo" + 5')) { console.dir(isConstant.toConstant('"foo" + 5')); } if (isConstant('Math.floor(10.5)', {Math: Math})) { console.dir(isConstant.toConstant('Math.floor(10.5)', {Math: Math})); } ``` ## API ### isConstant(src, [constants, [options]]) Returns `true` if `src` evaluates to a constant, `false` otherwise. It will also return `false` if there is a syntax error, which makes it safe to use on potentially ES6 code. Constants is an object mapping strings to values, where those values should be treated as constants. Note that this makes it a pretty bad idea to have `Math` in there if the user might make use of `Math.random` and a pretty bad idea to have `Date` in there. Options are directly passed-through to [Babylon](https://github.com/babel/babylon#options). ### toConstant(src, [constants, [options]]) Returns the value resulting from evaluating `src`. This method throws an error if the expression is not constant. e.g. `toConstant("Math.random()")` would throw an error. Constants is an object mapping strings to values, where those values should be treated as constants. Note that this makes it a pretty bad idea to have `Math` in there if the user might make use of `Math.random` and a pretty bad idea to have `Date` in there. Options are directly passed-through to [Babylon](https://github.com/babel/babylon#options). ## License MIT constantinople-4.0.1/package.json000066400000000000000000000020761354014276400170550ustar00rootroot00000000000000{ "name": "constantinople", "version": "4.0.1", "main": "lib/index.js", "types": "lib/index.d.ts", "description": "Determine whether a JavaScript expression evaluates to a constant", "keywords": [ "constant", "ast", "tooling" ], "dependencies": { "@babel/parser": "^7.6.0", "@babel/types": "^7.6.1" }, "devDependencies": { "@types/node": "^9.4.4", "mocha": "*", "prettier": "^1.18.2", "typescript": "^2.7.1" }, "scripts": { "prepublish": "npm run build", "build": "tsc", "pretest": "npm run build && npm run prettier:check", "test": "mocha -R spec", "prettier:write": "prettier --ignore-path .gitignore --write './**/*.{md,json,yaml,js,jsx,ts,tsx}'", "prettier:check": "echo \"If prettier fails you can fix it by running npm run prettier:write\" && prettier --ignore-path .gitignore --list-different './**/*.{md,json,yaml,js,jsx,ts,tsx}'" }, "repository": { "type": "git", "url": "https://github.com/ForbesLindesay/constantinople.git" }, "author": "ForbesLindesay", "license": "MIT" }constantinople-4.0.1/src/000077500000000000000000000000001354014276400153515ustar00rootroot00000000000000constantinople-4.0.1/src/binaryOperation.ts000066400000000000000000000024231354014276400210670ustar00rootroot00000000000000export type Operator = | '+' | '-' | '/' | '%' | '*' | '**' | '&' | '|' | '>>' | '>>>' | '<<' | '^' | '==' | '===' | '!=' | '!==' | 'in' | 'instanceof' | '>' | '<' | '>=' | '<='; export default function binaryOperation( operator: Operator, left: any, right: any, ): any { switch (operator) { case '+': return left + right; case '-': return left - right; case '/': return left / right; case '%': return left % right; case '*': return left * right; case '**': return left ** right; case '&': return left & right; case '|': return left | right; case '>>': return left >> right; case '>>>': return left >>> right; case '<<': return left << right; case '^': return left ^ right; case '==': return left == right; case '===': return left === right; case '!=': return left != right; case '!==': return left !== right; case 'in': return left in right; case 'instanceof': return left instanceof right; case '>': return left > right; case '<': return left < right; case '>=': return left >= right; case '<=': return left <= right; } } constantinople-4.0.1/src/index.ts000066400000000000000000000250401354014276400170310ustar00rootroot00000000000000import {parseExpression, ParserOptions} from '@babel/parser'; import * as b from '@babel/types'; import binaryOperation from './binaryOperation'; export {ParserOptions as BabylonOptions}; export interface ExpressionToConstantOptions { constants?: any; } export interface Options extends ExpressionToConstantOptions { babylon?: ParserOptions; } export function expressionToConstant( expression: b.Expression, options: ExpressionToConstantOptions = {}, ): {constant: true; result: any} | {constant: false; result?: void} { let constant = true; function toConstant(expression: b.Expression): any { if (!constant) return; if (b.isArrayExpression(expression)) { const result = []; for (let i = 0; constant && i < expression.elements.length; i++) { const element = expression.elements[i]; if (b.isSpreadElement(element)) { const spread = toConstant(element.argument); if (!(isSpreadable(spread) && constant)) { constant = false; } else { result.push(...spread); } } else if (b.isExpression(element)) { result.push(toConstant(element)); } else { constant = false; } } return result; } if (b.isBinaryExpression(expression)) { const left = toConstant(expression.left); const right = toConstant(expression.right); return constant && binaryOperation(expression.operator, left, right); } if (b.isBooleanLiteral(expression)) { return expression.value; } if (b.isCallExpression(expression)) { const args = []; for (let i = 0; constant && i < expression.arguments.length; i++) { const arg = expression.arguments[i]; if (b.isSpreadElement(arg)) { const spread = toConstant(arg.argument); if (!(isSpreadable(spread) && constant)) { constant = false; } else { args.push(...spread); } } else if (b.isExpression(arg)) { args.push(toConstant(arg)); } else { constant = false; } } if (!constant) return; if (b.isMemberExpression(expression.callee)) { const object = toConstant(expression.callee.object); if (!object || !constant) { constant = false; return; } const member = expression.callee.computed ? toConstant(expression.callee.property) : b.isIdentifier(expression.callee.property) ? expression.callee.property.name : undefined; if (member === undefined && !expression.callee.computed) { constant = false; } if (!constant) return; if (canCallMethod(object, '' + member)) { return object[member].apply(object, args); } } else { if (!b.isExpression(expression.callee)) { constant = false; return; } const callee = toConstant(expression.callee); if (!constant) return; return callee.apply(null, args); } } if (b.isConditionalExpression(expression)) { const test = toConstant(expression.test); return test ? toConstant(expression.consequent) : toConstant(expression.alternate); } if (b.isIdentifier(expression)) { if ( options.constants && {}.hasOwnProperty.call(options.constants, expression.name) ) { return options.constants[expression.name]; } } if (b.isLogicalExpression(expression)) { const left = toConstant(expression.left); const right = toConstant(expression.right); if (constant && expression.operator === '&&') { return left && right; } if (constant && expression.operator === '||') { return left || right; } } if (b.isMemberExpression(expression)) { const object = toConstant(expression.object); if (!object || !constant) { constant = false; return; } const member = expression.computed ? toConstant(expression.property) : b.isIdentifier(expression.property) ? expression.property.name : undefined; if (member === undefined && !expression.computed) { constant = false; } if (!constant) return; if ({}.hasOwnProperty.call(object, '' + member) && member[0] !== '_') { return object[member]; } } if (b.isNullLiteral(expression)) { return null; } if (b.isNumericLiteral(expression)) { return expression.value; } if (b.isObjectExpression(expression)) { const result: any = {}; for (let i = 0; constant && i < expression.properties.length; i++) { const property = expression.properties[i]; if (b.isObjectProperty(property)) { if (property.shorthand) { constant = false; return; } const key = property.computed ? toConstant(property.key) : b.isIdentifier(property.key) ? property.key.name : b.isStringLiteral(property.key) ? property.key.value : undefined; if (!key || key[0] === '_') { constant = false; } if (!constant) return; if (b.isExpression(property.value)) { const value = toConstant(property.value); if (!constant) return; result[key] = value; } else { constant = false; } } else if (b.isObjectMethod(property)) { constant = false; } else if (b.isSpreadProperty(property)) { const argument = toConstant(property.argument); if (!argument) constant = false; if (!constant) return; Object.assign(result, argument); } } return result; } if (b.isParenthesizedExpression(expression)) { return toConstant(expression.expression); } if (b.isRegExpLiteral(expression)) { return new RegExp(expression.pattern, expression.flags); } if (b.isSequenceExpression(expression)) { for (let i = 0; i < expression.expressions.length - 1 && constant; i++) { toConstant(expression.expressions[i]); } return toConstant( expression.expressions[expression.expressions.length - 1], ); } if (b.isStringLiteral(expression)) { return expression.value; } // TODO: TaggedTemplateExpression if (b.isTemplateLiteral(expression)) { let result = ''; for (let i = 0; i < expression.quasis.length; i++) { const quasi = expression.quasis[i]; result += quasi.value.cooked; if (i < expression.expressions.length) { result += '' + toConstant(expression.expressions[i]); } } return result; } if (b.isUnaryExpression(expression)) { const argument = toConstant(expression.argument); if (!constant) { return; } switch (expression.operator) { case '-': return -argument; case '+': return +argument; case '!': return !argument; case '~': return ~argument; case 'typeof': return typeof argument; case 'void': return void argument; } } constant = false; } const result = toConstant(expression); return constant ? {constant: true, result} : {constant: false}; } function isSpreadable(value: any): boolean { return ( typeof value === 'string' || Array.isArray(value) || (typeof Set !== 'undefined' && value instanceof Set) || (typeof Map !== 'undefined' && value instanceof Map) ); } function shallowEqual(a: any, b: any) { if (a === b) return true; if (a && b && typeof a === 'object' && typeof b === 'object') { for (let key in a) { if (a[key] !== b[key]) { return false; } } for (let key in b) { if (a[key] !== b[key]) { return false; } } return true; } return false; } function canCallMethod(object: any, member: string): boolean { switch (typeof object) { case 'boolean': switch (member) { case 'toString': return true; default: return false; } case 'number': switch (member) { case 'toExponential': case 'toFixed': case 'toPrecision': case 'toString': return true; default: return false; } case 'string': switch (member) { case 'charAt': case 'charCodeAt': case 'codePointAt': case 'concat': case 'endsWith': case 'includes': case 'indexOf': case 'lastIndexOf': case 'match': case 'normalize': case 'padEnd': case 'padStart': case 'repeat': case 'replace': case 'search': case 'slice': case 'split': case 'startsWith': case 'substr': case 'substring': case 'toLowerCase': case 'toUpperCase': case 'trim': return true; default: return false; } default: if (object instanceof RegExp) { switch (member) { case 'test': case 'exec': return true; default: return false; } } return {}.hasOwnProperty.call(object, member) && member[0] !== '_'; } } const EMPTY_OBJECT = {}; let lastSrc = ''; let lastConstants = EMPTY_OBJECT; let lastOptions = EMPTY_OBJECT; let lastResult: any = null; let lastWasConstant = false; export function isConstant( src: string, constants: any = EMPTY_OBJECT, options: ParserOptions = EMPTY_OBJECT, ) { if ( lastSrc === src && shallowEqual(lastConstants, constants) && shallowEqual(lastOptions, options) ) { return lastWasConstant; } lastSrc = src; lastConstants = constants; let ast: b.Expression | void; try { ast = parseExpression(src, options); } catch (ex) { return (lastWasConstant = false); } const {result, constant} = expressionToConstant(ast, {constants}); lastResult = result; return (lastWasConstant = constant); } export function toConstant( src: string, constants: any = EMPTY_OBJECT, options: ParserOptions = EMPTY_OBJECT, ) { if (!isConstant(src, constants, options)) { throw new Error(JSON.stringify(src) + ' is not constant.'); } return lastResult; } export default isConstant; module.exports = isConstant; module.exports.default = isConstant; module.exports.expressionToConstant = expressionToConstant; module.exports.isConstant = isConstant; module.exports.toConstant = toConstant; constantinople-4.0.1/test/000077500000000000000000000000001354014276400155415ustar00rootroot00000000000000constantinople-4.0.1/test/index.js000066400000000000000000000053521354014276400172130ustar00rootroot00000000000000'use strict'; var assert = require('assert'); var constaninople = require('../'); describe('isConstant(src)', function() { it('handles "[5 + 3 + 10]"', function() { assert(constaninople.isConstant('[5 + 3 + 10]') === true); }); it('handles "/[a-z]/i.test(\'a\')"', function() { assert(constaninople.isConstant("/[a-z]/i.test('a')") === true); }); it("handles \"{'class': [('data')]}\"", function() { assert(constaninople.isConstant("{'class': [('data')]}") === true); }); it('handles "Math.random()"', function() { assert(constaninople.isConstant('Math.random()') === false); }); it('handles "Math.random("', function() { assert(constaninople.isConstant('Math.random(') === false); }); it('handles "Math.floor(10.5)" with {Math: Math} as constants', function() { assert(constaninople.isConstant('Math.floor(10.5)', {Math: Math}) === true); }); it('handles "this.myVar"', function() { assert(constaninople.isConstant('this.myVar') === false); }); it('handles "(function () { while (true); return 10; }())"', function() { assert( constaninople.isConstant( '(function () { while (true); return 10; }())' ) === false ); }); it('handles "({}).toString.constructor("console.log(1)")()"', function() { assert( constaninople.isConstant( '({}).toString.constructor("console.log(1)")()' ) === false ); }); }); describe('toConstant(src)', function() { it('handles "[5 + 3 + 10]"', function() { assert.deepEqual(constaninople.toConstant('[5 + 3 + 10]'), [5 + 3 + 10]); }); it('handles "/[a-z]/i.test(\'a\')"', function() { assert(constaninople.toConstant("/[a-z]/i.test('a')") === true); }); it("handles \"{'class': [('data')]}\"", function() { assert.deepEqual(constaninople.toConstant("{'class': [('data')]}"), { class: ['data'], }); }); it('handles "Math.random()"', function() { try { constaninople.toConstant('Math.random()'); } catch (ex) { return; } assert(false, 'Math.random() should result in an error'); }); it('handles "Math.random("', function() { try { constaninople.toConstant('Math.random('); } catch (ex) { return; } assert(false, 'Math.random( should result in an error'); }); it('handles "Math.floor(10.5)" with {Math: Math} as constants', function() { assert(constaninople.toConstant('Math.floor(10.5)', {Math: Math}) === 10); }); it('handles "(function () { while (true); return 10; }())"', function() { try { constaninople.toConstant('(function () { while (true); return 10; }())'); } catch (ex) { return; } assert( false, '(function () { while (true); return 10; }()) should result in an error' ); }); }); constantinople-4.0.1/tsconfig.json000066400000000000000000000001671354014276400172750ustar00rootroot00000000000000{ "compilerOptions": { "declaration": true, "outDir": "lib", "strict": true, "lib": ["es2017"] } }