Baklavajs 项目中使用 `<script setup>` 语法指南

Baklavajs 是一个基于 Vue.js 的可视化节点编辑器框架，随着 Vue 3 的 Composition API 和 <script setup> 语法的普及，许多开发者希望在 Baklavajs 项目中使用这种更简洁的语法格式。

传统语法与 <script setup> 对比

在传统 Vue 组件中，Baklavajs 的典型使用方式如下：

<script lang="ts">
import { defineComponent } from "vue";
import { EditorComponent, useBaklava } from "@baklavajs/renderer-vue";

export default defineComponent({
    components: {
        "baklava-editor": EditorComponent,
    },
    setup() {
        const baklava = useBaklava();
        return { baklava };
    },
});
</script>

而使用 <script setup> 语法可以简化为：

<script setup lang="ts">
import { EditorComponent, useBaklava } from "@baklavajs/renderer-vue";

const baklava = useBaklava();
</script>

节点定义的最佳实践

在定义自定义节点时，需要注意 <script setup> 的一些限制：

1. 避免在 <script setup> 中直接使用 export default
2. 节点定义应该放在单独的文件中

推荐的做法是：

// MyNode.ts
import { defineNode, NodeInterface, NumberInterface, SelectInterface } from "baklavajs";

export const MyNode = defineNode({
    type: "MyNode",
    inputs: {
        number1: () => new NumberInterface("Number", 1),
        number2: () => new NumberInterface("Number", 10),
        operation: () => new SelectInterface("Operation", "Add", ["Add", "Subtract"]).setPort(false),
    },
    outputs: {
        output: () => new NodeInterface("Output", 0),
    },
});

然后在组件中导入使用：

<script setup lang="ts">
import { MyNode } from "./MyNode";
// 其他逻辑...
</script>

常见问题解决方案

1. ESLint 错误：如果遇到 vue/no-export-in-script-setup 错误，确保不在 <script setup> 中直接导出内容。

2. 组件注册：在 <script setup> 中，导入的组件会自动注册，无需显式声明。

3. 类型支持：使用 TypeScript 时，可以利用 defineProps 和 defineEmits 来获得完整的类型支持。

性能考虑

虽然 <script setup> 提供了更简洁的语法，但在大型节点编辑器应用中：

1. 考虑将复杂节点逻辑拆分为独立组合式函数
2. 对于频繁更新的节点，可以使用 shallowRef 优化性能
3. 节点定义保持纯函数形式，避免副作用

总结

Baklavajs 完全支持 Vue 3 的 <script setup> 语法，开发者可以享受更简洁的代码结构。关键在于正确组织节点定义文件和遵循组合式 API 的最佳实践。通过将节点逻辑模块化，可以构建出既高效又易于维护的可视化编辑器应用。