Skip to content

Call ToString for template literal placeholders #1838

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 7 additions & 20 deletions src/codegeneration/TemplateLiteralTransformer.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,10 @@
// limitations under the License.

import {
BINARY_EXPRESSION,
COMMA_EXPRESSION,
CONDITIONAL_EXPRESSION,
TEMPLATE_LITERAL_EXPRESSION,
TEMPLATE_LITERAL_PORTION,
TEMPLATE_LITERAL_EXPRESSION
TEMPLATE_SUBSTITUTION
} from '../syntax/trees/ParseTreeType.js';
import {
LiteralExpression,
Expand All @@ -27,10 +26,7 @@ import {LiteralToken} from '../syntax/LiteralToken.js';
import {ParseTreeTransformer} from './ParseTreeTransformer.js';
import {TempVarTransformer} from './TempVarTransformer.js';
import {
PERCENT,
PLUS,
SLASH,
STAR,
STRING
} from '../syntax/TokenType.js';
import {
Expand Down Expand Up @@ -237,19 +233,7 @@ export class TemplateLiteralTransformer extends TempVarTransformer {
transformTemplateSubstitution(tree) {
let transformedTree = this.transformAny(tree.expression);
// Wrap in a paren expression if needed.
switch (transformedTree.type) {
case BINARY_EXPRESSION:
// Only * / and % have higher priority than +.
switch (transformedTree.operator.type) {
case STAR:
case PERCENT:
case SLASH:
return transformedTree;
}
return createParenExpression(transformedTree);

case COMMA_EXPRESSION:
case CONDITIONAL_EXPRESSION:
if (transformedTree.type === COMMA_EXPRESSION) {
return createParenExpression(transformedTree);
}

Expand All @@ -261,7 +245,7 @@ export class TemplateLiteralTransformer extends TempVarTransformer {
}

createDefaultTemplateLiteral(tree) {
// convert to ("a" + b + "c" + d + "")
// convert to ("a" + String(b) + "c" + String(d) + "")
let length = tree.elements.length;
if (length === 0) {
let loc = tree.location;
Expand All @@ -283,6 +267,9 @@ export class TemplateLiteralTransformer extends TempVarTransformer {
binaryExpression = binaryExpression.right;
}
let transformedTree = this.transformAny(tree.elements[i]);
if (element.type === TEMPLATE_SUBSTITUTION) {
transformedTree = parseExpression `String(${transformedTree})`;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

String() is not really correct (won't throw on symbols) but I dunno if it matters much

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point.

Not sure what to do here. Doing a real ToString requires a typeof test. At this point I'm tempted to just not care about this and close this PR.

}
binaryExpression = createBinaryExpression(binaryExpression, plusToken,
transformedTree);
}
Expand Down
41 changes: 41 additions & 0 deletions test/feature/TemplateLiterals/TaggedToStringSustitutionOrder.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
var subs = [];
var log = [];
var tagged = [];
function getter(name, value) {
return {
get: function() {
log.push('get' + name);
return value;
},
set: function(v) {
log.push('set' + name);
}
};
}
Object.defineProperties(subs, {
0: getter(0, 1),
1: getter(1, 2),
2: getter(2, 3)
});
function tag(cs) {
var substitutions = arguments.length - 1;
var cooked = cs.length;
var e = cs[0];
var i = 0;
assert.equal(cooked, substitutions + 1);
while (i < substitutions) {
var sub = arguments[i++ + 1];
var tail = cs[i];
tagged.push(sub);
e = e.concat(sub, tail);
}
return e;
}
assert.equal('-1-2-3-', tag`-${subs[0]}-${subs[1]}-${subs[2]}-`);
assert.deepEqual(['get0', 'get1', 'get2'], log);
assert.deepEqual([1, 2, 3], tagged);
tagged.length = 0;
log.length = 0;
assert.equal('-1-', tag`-${subs[0]}-`);
assert.deepEqual(['get0'], log);
assert.deepEqual([1], tagged);
16 changes: 16 additions & 0 deletions test/feature/TemplateLiterals/ToStringSubstitutions.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
var a = {
toString: function() { return 'a'; },
valueOf: function() { return '-a-'; }
};
var b = {
toString: function() { return 'b'; },
valueOf: function() { return '-b-'; }
};
assert.equal('a', `${a}`);
assert.equal('ab', `${a}${b}`);
assert.equal('-a--b-', `${a + b}`);
assert.equal('-a-', `${a + ''}`);
assert.equal('1a', `1${a}`);
assert.equal('1a2', `1${a}2`);
assert.equal('1a2b', `1${a}2${b}`);
assert.equal('1a2b3', `1${a}2${b}3`);
20 changes: 20 additions & 0 deletions test/feature/TemplateLiterals/ToStringSustitutionOrder.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
var subs = [];
var log = [];
function getter(name, value) {
return {
get: function() {
log.push('get' + name);
return value;
},
set: function(v) {
log.push('set' + name);
}
};
}
Object.defineProperties(subs, {
0: getter(0, 'a'),
1: getter(1, 'b'),
2: getter(2, 'c')
});
assert.equal('-a-b-c-', `-${subs[0]}-${subs[1]}-${subs[2]}-`);
assert.deepEqual(['get0', 'get1', 'get2'], log);