feat!: parseModule and parseExpression

README.md

@@ -32,10 +32,10 @@ Import utilities:
 
 ```js
 // ESM / Bundler
-import { parseCode, generateCode, builders, createNode } from "magicast";
+import { parseModule, generateCode, builders, createNode } from "magicast";
 
 // CommonJS
-const { parseCode, generateCode, builders, createNode } = require("magicast");
+const { parseModule, generateCode, builders, createNode } = require("magicast");
 ```
 
 ## Examples
@@ -73,10 +73,10 @@ export default {
 **Example:** Directly use AST utils:
 
 ```js
-import { parseCode, generateCode } from "magicast";
+import { parseModule, generateCode } from "magicast";
 
 // Parse to AST
-const mod = parseCode(`export default { }`);
+const mod = parseModule(`export default { }`);
 
 // Ensure foo is an array
 mod.exports.default.foo ||= [];
@@ -99,9 +99,9 @@ export default {
 **Example:** Get the AST directly:
 
 ```js
-import { parseCode, generateCode } from "magicast";
+import { parseModule, generateCode } from "magicast";
 
-const mod = parseCode(`export default { }`);
+const mod = parseModule(`export default { }`);
 
 const ast = mod.exports.default.$ast
 // do something with ast
@@ -110,9 +110,9 @@ const ast = mod.exports.default.$ast
 **Example:** Function parameters:
 
 ```js
-import { parseCode, generateCode } from "magicast";
+import { parseModule, generateCode } from "magicast";
 
-const mod = parseCode(`export default defineConfig({ foo: 'bar' })`);
+const mod = parseModule(`export default defineConfig({ foo: 'bar' })`);
 
 // Support for both bare object export and `defineConfig` wrapper
 const options = mod.exports.default.$type === 'function-call'

src/code.ts

@@ -5,12 +5,14 @@ import {
  ASTNode,
  GenerateOptions,
  ParsedFileNode,
+ Proxified,
  ProxifiedModule,
 } from "./types";
 import { proxifyModule } from "./proxy/module";
 import { detectCodeFormat } from "./format";
+import { proxify } from "./proxy/proxify";
 
-export function parseCode<Exports extends object = any>(
+export function parseModule<Exports extends object = any>(
  code: string,
  options?: ParseOptions
 ): ProxifiedModule<Exports> {
@@ -21,11 +23,36 @@ export function parseCode<Exports extends object = any>(
  return proxifyModule(node, code);
 }
 
+export function parseExpression<T>(
+ code: string,
+ options?: ParseOptions
+): Proxified<T> {
+ const root: ParsedFileNode = parse("(" + code + ")", {
+ parser: options?.parser || getBabelParser(),
+ ...options,
+ });
+ let body: ASTNode = root.program.body[0];
+ if (body.type === "ExpressionStatement") {
+ body = body.expression;
+ }
+ if (body.extra?.parenthesized) {
+ body.extra.parenthesized = false;
+ }
+
+ const mod = {
+ $ast: root,
+ $code: " " + code + " ",
+ $type: "module",
+ } as any as ProxifiedModule;
+
+ return proxify(body, mod);
+}
+
 export function generateCode(
  node: { $ast: ASTNode } | ASTNode | ProxifiedModule<any>,
  options: GenerateOptions = {}
 ): { code: string; map?: any } {
- const ast = "$ast" in node ? node.$ast : node;
+ const ast = (node as Proxified).$ast || node;
 
  const formatOptions =
  options.format === false || !("$code" in node)
@@ -46,7 +73,7 @@ export async function loadFile<Exports extends object = any>(
 ): Promise<ProxifiedModule<Exports>> {
  const contents = await fsp.readFile(filename, "utf8");
  options.sourceFileName = options.sourceFileName ?? filename;
- return parseCode(contents, options);
+ return parseModule(contents, options);
 }
 
 export async function writeFile(

test/array.test.ts

@@ -1,10 +1,10 @@
 import { describe, expect, it } from "vitest";
-import { parseCode } from "../src";
+import { parseModule } from "../src";
 import { generate } from "./_utils";
 
 describe("array", () => {
  it("array operations", () => {
- const mod = parseCode<{ default: (number | any | string)[] }>(
+ const mod = parseModule<{ default: (number | any | string)[] }>(
  `export default [1, 2, 3, 4, 5]`
  );
 
@@ -43,7 +43,7 @@ describe("array", () => {
  });
 
  it("array should be iterable", () => {
- const mod = parseCode(`
+ const mod = parseModule(`
  export const config = {
  array: ['a']
  }

test/builders.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it } from "vitest";
-import { builders, parseCode } from "../src";
+import { builders, parseModule } from "../src";
 import { generate } from "./_utils";
 
 describe("builders", () => {
@@ -19,7 +19,7 @@ describe("builders", () => {
  ]
  `);
 
- const mod = parseCode("");
+ const mod = parseModule("");
  mod.exports.a = call;
 
  expect(generate(mod)).toMatchInlineSnapshot(`

test/errors.test.ts

@@ -1,10 +1,10 @@
 import { expect, describe, it } from "vitest";
-import { parseCode } from "../src";
+import { parseExpression, parseModule } from "../src";
 import { generate } from "./_utils";
 
 describe("errors", () => {
  it("ternary", () => {
- const mod = parseCode(
+ const mod = parseModule(
  `
 export default {
  a: 1 + 1 === 2
@@ -30,7 +30,7 @@ export default {
  });
 
  it("expression", () => {
- const mod = parseCode(
+ const mod = parseModule(
  `
 export default {
  a: 1 + 1
@@ -53,7 +53,7 @@ export default {
 
  // TODO: This could be supported
  it("identifier", () => {
- const mod = parseCode(
+ const mod = parseModule(
  `
 const foo = {
  bar: 1
@@ -81,7 +81,7 @@ export default {
 
  // TODO: This could be supported
  it("object shorthand", () => {
- const mod = parseCode(
+ const mod = parseModule(
  `
 const foo = {
  bar: 1
@@ -108,7 +108,7 @@ export default {
  });
 
  it("array destructuring", () => {
- const mod = parseCode(
+ const mod = parseModule(
  `
 export default {
  foo: [
@@ -147,7 +147,7 @@ export default {
  });
 
  it("object destructuring", () => {
- const mod = parseCode(
+ const mod = parseModule(
  `
 export default {
  foo: {
@@ -187,4 +187,24 @@ export default {
  `
  );
  });
+
+ it("parseExpression", () => {
+ expect(() => parseExpression<any>("foo ? {} : []"))
+ .toThrowErrorMatchingInlineSnapshot(`
+ "Casting \\"ConditionalExpression\\" is not supported
+
+ 1 | foo ? {} : [] 
+ ^
+ "
+ `);
+
+ const exp = parseExpression<any>("{ a: foo ? {} : [] }");
+ expect(() => exp.a).toThrowErrorMatchingInlineSnapshot(`
+ "Casting \\"ConditionalExpression\\" is not supported
+
+ 1 | { a: foo ? {} : [] } 
+ ^
+ "
+ `);
+ });
 });

test/exports.test.ts

@@ -1,10 +1,10 @@
 import { expect, it, describe } from "vitest";
-import { parseCode } from "../src";
+import { parseModule } from "../src";
 import { generate } from "./_utils";
 
 describe("exports", () => {
  it("manipulate exports", () => {
- const mod = parseCode("");
+ const mod = parseModule("");
 
  expect(mod.exports).toMatchInlineSnapshot(`{}`);
  expect(generate(mod)).toMatchInlineSnapshot('""');

test/function-call.test.ts

@@ -1,10 +1,10 @@
 import { describe, expect, it } from "vitest";
-import { builders, parseCode, ProxifiedModule } from "../src";
+import { builders, parseModule, ProxifiedModule } from "../src";
 import { generate } from "./_utils";
 
 describe("function-calls", () => {
  it("function wrapper", () => {
- const mod = parseCode(`
+ const mod = parseModule(`
  export const a: any = { foo: 1}
  export default defineConfig({
  // Modules
@@ -73,12 +73,12 @@ describe("function-calls", () => {
  );
  };
 
- const mod1 = parseCode(`
+ const mod1 = parseModule(`
  import { defineConfig } from 'vite'
 
  export default defineConfig({})
  `);
- const mod2 = parseCode("");
+ const mod2 = parseModule("");
 
  installVuePlugin(mod1);
  installVuePlugin(mod2);

test/general.test.ts

@@ -1,10 +1,10 @@
 import { expect, it, describe } from "vitest";
-import { generateCode, parseCode } from "../src";
+import { generateCode, parseModule, parseExpression } from "../src";
 import { generate } from "./_utils";
 
 describe("general", () => {
  it("basic object and array", () => {
- const mod = parseCode(`export default { a: 1, b: { c: {} } }`);
+ const mod = parseModule(`export default { a: 1, b: { c: {} } }`);
 
  mod.exports.default.a = 2;
 
@@ -89,8 +89,8 @@ describe("general", () => {
  });
 
  it("mix two configs", () => {
- const mod1 = parseCode(`export default { a: 1 }`);
- const mod2 = parseCode(`export default { b: 2 }`);
+ const mod1 = parseModule(`export default { a: 1 }`);
+ const mod2 = parseModule(`export default { b: 2 }`);
 
  mod1.exports.default.b = mod2.exports.default;
 
@@ -108,7 +108,7 @@ describe("general", () => {
  });
 
  it("delete property", () => {
- const mod = parseCode(`export default { a: 1, b: [1, { foo: 'bar' }] }`);
+ const mod = parseModule(`export default { a: 1, b: [1, { foo: 'bar' }] }`);
 
  delete mod.exports.default.b[1].foo;
 
@@ -130,7 +130,7 @@ describe("general", () => {
  });
 
  it("should preserve code styles", () => {
- const mod = parseCode(`
+ const mod = parseModule(`
  export const config = {
  array: ['a']
  }
@@ -142,4 +142,40 @@ describe("general", () => {
  }"
  `);
  });
+
+ describe("parseExpression", () => {
+ it("object", () => {
+ const exp = parseExpression<any>("{ a: 1, b: 2 }");
+
+ expect(exp).toEqual({ a: 1, b: 2 });
+
+ exp.a = [1, 3, 4];
+
+ expect(generateCode(exp).code).toMatchInlineSnapshot(`
+ "{
+ a: [1, 3, 4],
+ b: 2
+ }"
+ `);
+ });
+
+ it("array", () => {
+ const exp = parseExpression<any>("[1, { foo: 2 }]");
+
+ expect(exp).toMatchInlineSnapshot(`
+ [
+ 1,
+ {
+ "foo": 2,
+ },
+ ]
+ `);
+
+ exp[2] = "foo";
+
+ expect(generateCode(exp).code).toMatchInlineSnapshot(
+ '"[1, { foo: 2 }, \\"foo\\"]"'
+ );
+ });
+ });
 });

test/imports.test.ts

@@ -1,10 +1,10 @@
 import { expect, it, describe } from "vitest";
-import { parseCode } from "../src";
+import { parseModule } from "../src";
 import { generate } from "./_utils";
 
 describe("imports", () => {
  it("manipulate imports", () => {
- const mod = parseCode(`
+ const mod = parseModule(`
 import { defineConfig, Plugin } from 'vite'
 import Vue from '@vitejs/plugin-vue'
 import * as path from 'path'

test/object.test.ts

@@ -1,10 +1,10 @@
 import { describe, expect, it } from "vitest";
-import { parseCode } from "../src";
+import { parseModule } from "../src";
 import { generate } from "./_utils";
 
 describe("object", () => {
  it("object property", () => {
- const mod = parseCode(
+ const mod = parseModule(
  `
 export default {
  foo: {