如何在XTEXT文件存在编译错误时避免执行格式化操作？

你可以通过两种方式实现需求，以下是具体方案：

方案1：重写createFormatterStream方法直接返回原始流 #

当检测到资源存在编译错误时，直接返回方法传入的out参数（原始TokenStream），这样格式化逻辑不会对原文本做任何修改，相当于跳过格式化操作：

@Override
public ITokenStream createFormatterStream(EObject context, String indent, ITokenStream out,
        boolean preserveWhitespaces) {
    if (!context.eResource().getErrors().isEmpty()) {
        // 存在编译错误，返回原始流，不执行格式化
        return out;
    }
    return super.createFormatterStream(context, indent, out, preserveWhitespaces);
}

方案2：重写format方法前置检查 #

相比修改流的创建，直接在格式化入口方法format里做检查更直观，有错误时直接跳过父类的格式化逻辑：

@Override
public void format(EObject context, IFormattableDocument document) {
    // 仅当无编译错误时执行格式化
    if (context.eResource().getErrors().isEmpty()) {
        super.format(context, document);
    }
}

可选：抛出异常终止格式化（带提示） #

如果你希望在有错误时明确提示用户，可以抛出OperationCanceledException，Xtext会终止格式化并显示错误信息：

@Override
public ITokenStream createFormatterStream(EObject context, String indent, ITokenStream out,
        boolean preserveWhitespaces) {
    if (!context.eResource().getErrors().isEmpty()) {
        throw new OperationCanceledException("DSL存在编译错误，无法执行格式化");
    }
    return super.createFormatterStream(context, indent, out, preserveWhitespaces);
}

内容的提问来源于stack exchange，提问作者A.Goel