在Srcbook项目中集成Prettier实现TypeScript代码格式化

前言

在现代代码编辑器和开发环境中，代码格式化已经成为提升开发效率和代码质量的重要工具。本文将详细介绍如何在Srcbook这个TypeScript笔记本项目中集成Prettier代码格式化工具，为开发者提供更流畅的编码体验。

Prettier简介

Prettier是一个流行的代码格式化工具，支持多种编程语言，包括TypeScript。它通过解析代码并重新输出格式化的版本，确保代码风格的一致性，减少团队协作中的风格争议。

集成方案设计

核心功能需求

1. 基础格式化能力：实现对TypeScript代码的格式化功能
2. 自动化格式化：支持在保存时自动格式化代码
3. 手动触发机制：提供按需格式化的操作入口

技术实现要点

1. 依赖安装：需要添加prettier及其TypeScript插件作为项目依赖
2. 编辑器集成：与CodeMirror编辑器深度整合，实现无缝的格式化体验
3. 配置管理：支持自定义格式化规则，满足不同开发者的偏好

详细实现步骤

1. 安装必要依赖

首先需要在项目中添加Prettier核心包和TypeScript支持插件：

npm install prettier @types/prettier --save-dev

2. 创建默认配置

在项目根目录下创建.prettierrc文件，定义基本的格式化规则：

{
  "semi": true,
  "singleQuote": true,
  "tabWidth": 2,
  "trailingComma": "es5",
  "printWidth": 80
}

3. 实现格式化功能

创建格式化服务模块，封装Prettier的调用逻辑：

import * as prettier from 'prettier';

export class FormatterService {
  static async formatCode(code: string): Promise<string> {
    try {
      return await prettier.format(code, {
        parser: 'typescript',
        plugins: [],
      });
    } catch (error) {
      console.error('Formatting error:', error);
      return code; // 返回原始代码以防出错
    }
  }
}

4. 编辑器集成

将格式化功能与CodeMirror编辑器集成：

import { EditorView } from '@codemirror/view';
import { FormatterService } from './formatter-service';

export function formatAction(view: EditorView) {
  const selectedCode = view.state.sliceDoc(
    view.state.selection.main.from,
    view.state.selection.main.to
  );
  
  FormatterService.formatCode(selectedCode || view.state.doc.toString())
    .then((formatted) => {
      view.dispatch({
        changes: {
          from: 0,
          to: view.state.doc.length,
          insert: formatted
        }
      });
    });
}

export const formatKeyBinding = [
  {
    key: "Shift-Alt-F",
    run: formatAction,
    preventDefault: true
  }
];

5. 用户界面集成

在单元格操作栏添加格式化按钮：

function createFormatButton(onClick: () => void) {
  const button = document.createElement('button');
  button.className = 'cell-format-button';
  button.innerHTML = '<svg>...</svg>'; // 格式化图标
  button.title = '格式化代码 (Shift+Alt+F)';
  button.addEventListener('click', onClick);
  return button;
}

6. 自动格式化设置

实现自动格式化选项，可存储在用户设置中：

interface AppSettings {
  autoFormat: boolean;
  // 其他设置...
}

export class SettingsService {
  private static STORAGE_KEY = 'srcbook-settings';
  
  static getSettings(): AppSettings {
    const saved = localStorage.getItem(this.STORAGE_KEY);
    return saved ? JSON.parse(saved) : { autoFormat: false };
  }
  
  static updateSettings(updates: Partial<AppSettings>) {
    const current = this.getSettings();
    localStorage.setItem(
      this.STORAGE_KEY,
      JSON.stringify({ ...current, ...updates })
    );
  }
}

进阶优化方向

1. 性能优化：对于大文件实现增量格式化
2. 错误处理：优雅处理格式化过程中的语法错误
3. 配置覆盖：支持项目级和用户级的配置覆盖
4. 格式差异高亮：在格式化前显示变更预览
5. 多语言支持：扩展支持JavaScript、JSX等其他语言

替代方案考量

虽然本文以Prettier为例，但团队也可以考虑其他格式化工具如Biome。Biome作为新兴工具，具有更快的速度和更现代的架构，但社区生态和成熟度可能不如Prettier。选择时应考虑：

1. 性能需求
2. 功能完整性
3. 社区支持度
4. 配置灵活性
5. 维护活跃度

结语

在Srcbook项目中集成代码格式化功能，可以显著提升开发者的编码体验和代码质量。通过合理的架构设计和细致的实现，我们不仅能够提供基础的格式化能力，还能为未来的功能扩展奠定良好基础。这种集成也体现了现代开发工具对开发者体验的重视，是提升生产力工具价值的重要一环。