Skip to content

Commit

Permalink
Fix removal of quotes from property names (#543)
Browse files Browse the repository at this point in the history
* Fix removal of quotes from property names

* Fix implementation - use utils from shift's codegen

* Fix tests

* Fix computed properties and linting
  • Loading branch information
boopathi committed Jun 13, 2017
1 parent 7e2b315 commit 30d5eea
Show file tree
Hide file tree
Showing 5 changed files with 177 additions and 15 deletions.
Expand Up @@ -40,7 +40,13 @@ describe("transform-property-literals-plugin", () => {
"import": null
});
`);
expect(transform(source)).toBe(source);
const expected = unpad(`
({
default: null,
import: null
});
`);
expect(transform(source)).toBe(expected);
});

it("should not transform non-string properties", () => {
Expand All @@ -60,4 +66,48 @@ describe("transform-property-literals-plugin", () => {
`);
expect(transform(source)).toBe(source);
});

it("should not transform invalid es5 property names", () => {
const source = unpad(`
({
"\u2118": "wp",
"𐊧": "foo"
});
`);
expect(transform(source)).toBe(source);
});

it("should transform valid ES5 unicodes as property names", () => {
const source = unpad(`
({
"ಠ_ಠ": "bar",
"12e34": "wut",
"\u01FC": "AE"
})
`);
const expected = unpad(`
({
ಠ_ಠ: "bar",
"12e34": "wut",
\u01FC: "AE"
});
`);
expect(transform(source)).toBe(expected);
});

it("should transform computed properties which are strings", () => {
const source = unpad(`
({
[ಠ_ಠ]: "foo",
["ಠ_ಠ"]: "bar"
});
`);
const expected = unpad(`
({
[ಠ_ಠ]: "foo",
ಠ_ಠ: "bar"
});
`);
expect(transform(source)).toBe(expected);
});
});
Expand Up @@ -11,6 +11,8 @@
"keywords": [
"babel-plugin"
],
"dependencies": {},
"dependencies": {
"esutils": "^2.0.2"
},
"devDependencies": {}
}
@@ -0,0 +1,68 @@
"use strict";

/**
* Original Source:
* https://github.com/shapesecurity/shift-codegen-js/blob/0d09bd8a/src/coderep.js#L122
*
* The following function is an exact copy of the original implementation
*
* LICENSE
Copyright 2014 Shape Security, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
module.exports = function escapeStringLiteral(stringValue) {
let result = "";
let nSingle = 0,
nDouble = 0;
for (let i = 0, l = stringValue.length; i < l; ++i) {
let ch = stringValue[i];
if (ch === '"') {
++nDouble;
} else if (ch === "'") {
++nSingle;
}
}
let delim = nDouble > nSingle ? "'" : '"';
result += delim;
for (let i = 0; i < stringValue.length; i++) {
let ch = stringValue.charAt(i);
switch (ch) {
case delim:
result += "\\" + delim;
break;
case "\n":
result += "\\n";
break;
case "\r":
result += "\\r";
break;
case "\\":
result += "\\\\";
break;
case "\u2028":
result += "\\u2028";
break;
case "\u2029":
result += "\\u2029";
break;
default:
result += ch;
break;
}
}
result += delim;
return result;
};
23 changes: 10 additions & 13 deletions packages/babel-plugin-transform-property-literals/src/index.js
@@ -1,27 +1,24 @@
"use strict";

const { reduceStaticPropertyNameES5 } = require("./property-name");

module.exports = function({ types: t }) {
return {
name: "transform-property-literals",
visitor: {
// { 'foo': 'bar' } -> { foo: 'bar' }
ObjectProperty: {
exit({ node }) {
const key = node.key;
if (!t.isStringLiteral(key)) {
exit(path) {
const key = path.get("key");
if (!key.isStringLiteral()) {
return;
}

if (key.value.match(/^\d+$/)) {
const newProp = parseInt(node.key.value, 10);
if (newProp.toString() === node.key.value) {
node.key = t.numericLiteral(newProp);
node.computed = false;
}
} else if (t.isValidIdentifier(key.value)) {
node.key = t.identifier(key.value);
node.computed = false;
}
const newNode = t.clone(path.node);
newNode.key = reduceStaticPropertyNameES5(t, key.node);
newNode.computed = false;

path.replaceWith(newNode);
}
}
}
Expand Down
@@ -0,0 +1,45 @@
"use strict";

const { keyword } = require("esutils");
const escapeStringLiteral = require("./escape-string-literal");

module.exports = {
reduceStaticPropertyNameES5
};

/**
*
* Original Source:
* https://github.com/shapesecurity/shift-codegen-js/blob/0d09bd8a/src/minimal-codegen.js#L635
*
* This implementation modifies the original source in the following ways
* + Check for ES5 Identifier name instead of ES6 Identifier name
* + Use Babel-Types & Babel's AST instead of ShiftAST
*
* LICENSE
Copyright 2014 Shape Security, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
function reduceStaticPropertyNameES5(t, node) {
if (keyword.isIdentifierNameES5(node.value)) {
return t.Identifier(node.value);
}
let n = parseFloat(node.value);
if (n >= 0 && n.toString() === node.value) {
return t.NumericLiteral(n);
}
return t.Identifier(escapeStringLiteral(node.value));
}

0 comments on commit 30d5eea

Please sign in to comment.