Skip to content

Open source website builder and Webflow alternative. Webstudio is an advanced visual builder that connects to any headless CMS, supports all CSS properties, and can be hosted anywhere, including with us.

feat: normalize variable names (#2557)

Bogdan Chadkind05bf1a2017a
diff --git a/apps/builder/app/builder/features/settings-panel/variables.tsx b/apps/builder/app/builder/features/settings-panel/variables.tsx
index a930ceb1a5..8ac1b55a62 100644
--- a/apps/builder/app/builder/features/settings-panel/variables.tsx
+++ b/apps/builder/app/builder/features/settings-panel/variables.tsx
@@ -176,10 +176,8 @@ const VariablePanel = ({
</Button>
<Button
onClick={() => {
- if (/[a-zA-z_]+[a-zA-z0-9_]*/.test(name) === false) {
- setNameErrors([
- `Variable names must start with letter or underscore (_) and can include numbers.`,
- ]);
+ if (name.length === 0) {
+ setNameErrors([`Variable name is required`]);
return;
}
const result = saveVariable(variable?.id, name, value);
diff --git a/packages/sdk/src/scope.test.ts b/packages/sdk/src/scope.test.ts
index 02d79bb124..6ddf8f4809 100644
--- a/packages/sdk/src/scope.test.ts
+++ b/packages/sdk/src/scope.test.ts
@@ -15,3 +15,18 @@ test("allow to predefine already occupied identifiers", () => {
expect(scope.getName("2", "anotherName")).toEqual("anotherName_1");
expect(scope.getName("3", "newName")).toEqual("newName");
});
+
+test("delete non-ascii characters from name", () => {
+ const scope = createScope(["_"]);
+ expect(scope.getName("1", "привет")).toEqual("__1");
+});
+
+test("delete spaces from name", () => {
+ const scope = createScope(["_"]);
+ expect(scope.getName("1", "My Variable")).toEqual("MyVariable");
+});
+
+test("prefix name starting with digit", () => {
+ const scope = createScope(["_"]);
+ expect(scope.getName("1", "123")).toEqual("_123");
+});
diff --git a/packages/sdk/src/scope.ts b/packages/sdk/src/scope.ts
index d80c74b30e..090f7a5573 100644
--- a/packages/sdk/src/scope.ts
+++ b/packages/sdk/src/scope.ts
@@ -7,6 +7,22 @@ export type Scope = {
getName(id: string, preferredName: string): string;
};
+// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Lexical_grammar#identifiers
+const normalizeName = (name: string) => {
+ // only letters, digits, underscores and dollar signs allowed in names
+ // delete everything else
+ name = name.replaceAll(/[^\w$]/g, "");
+ // put at least single underscore in name to avoid syntax error
+ if (name.length === 0) {
+ return "_";
+ }
+ // variable name can start with letter, underscore and dollar signs
+ if (/[A-Za-z_$]/.test(name[0]) === false) {
+ name = `_${name}`;
+ }
+ return name;
+};
+
/**
* Utility to maintain unique variable when generate code.
* Single scope is shared for generated module for simplicity.
@@ -26,6 +42,7 @@ export const createScope = (occupiedIdentifiers: string[] = []): Scope => {
if (cachedName !== undefined) {
return cachedName;
}
+ preferredName = normalizeName(preferredName);
const index = freeIndexByPreferredName.get(preferredName);
freeIndexByPreferredName.set(preferredName, (index ?? 0) + 1);
let scopedName = preferredName;