unplugin-check-syntax

Um plugin genérico de verificação de sintaxe, compatível com múltiplas ferramentas de build (Webpack, Vite, Rollup, esbuild, Rspack, etc.), usado para verificar a compatibilidade de sintaxe ECMAScript em arquivos JavaScript e HTML. Este plugin é inspirado no rsbuild-plugin-check-syntax.

Funcionalidades

• 🔧 Suporte a múltiplas ferramentas de build: Compatível com Webpack, Vite, Rollup, esbuild, Rspack, etc.
• 📝 Suporte a múltiplos tipos de arquivo: Compatível com arquivos JavaScript e scripts inline em arquivos HTML
• 🎯 Localização precisa: Suporte a sourcemap, permitindo rastrear até a posição do arquivo de origem
• ⚙️ Configuração flexível: Suporte para exclusão de arquivos, inclusão manual, filtragem de tipos de erro e outras opções
• 📁 Descoberta inteligente de arquivos: Suporte ao modo glob para inclusão manual de arquivos JS/HTML adicionais
• 🌐 Integração com Browserslist: Suporte à configuração browserslist para conversão automática em versões ECMAScript

Instalação

npm install @winner-fed/unplugin-check-syntax --save-dev

Como Usar

Vite

// vite.config.ts
import { defineConfig } from 'vite'
import checkSyntax from '@winner-fed/unplugin-check-syntax/vite'
export default defineConfig({
  plugins: [
    checkSyntax({
      targets: ['> 1%', 'last 2 versions'],
      // 或者直接指定 ECMAScript 版本
      // ecmaVersion: 'es2015'
    }),
  ],
})

Webpack

// webpack.config.js
const checkSyntax = require('@winner-fed/unplugin-check-syntax/webpack')
module.exports = {
  plugins: [
    checkSyntax({
      targets: ['> 1%', 'last 2 versions'],
    }),
  ],
}

Rollup

// rollup.config.js
import checkSyntax from '@winner-fed/unplugin-check-syntax/rollup'
export default {
  plugins: [
    checkSyntax({
      targets: ['> 1%', 'last 2 versions'],
    }),
  ],
}

esbuild

// esbuild.config.js
const { build } = require('esbuild')
const checkSyntax = require('@winner-fed/unplugin-check-syntax/esbuild')
build({
  plugins: [
    checkSyntax({
      targets: ['> 1%', 'last 2 versions'],
    }),
  ],
})

Rspack

// rspack.config.js
const checkSyntax = require('@winner-fed/unplugin-check-syntax/rspack')
module.exports = {
  plugins: [
    checkSyntax({
      targets: ['> 1%', 'last 2 versions'],
    }),
  ],
}

Opções de configuração

interface CheckSyntaxOptions {
  /
   
目标浏览器范围，使用 browserslist 格式
   
*/
  targets?: string[];
  
  /
   
直接指定 ECMAScript 版本（优先级高于 targets）
   
*/
  ecmaVersion?: 'es3' | 'es5' | 'es2015' | 'es2016' | 'es2017' | 'es2018' | 'es2019' | 'es2020' | 'es2021' | 'es2022' | 'latest';
  
  /
   
排除源文件检查，支持正则表达式
   
*/
  exclude?: RegExp | RegExp[];
  
  /
   
排除输出文件检查，支持正则表达式  
   
*/
  excludeOutput?: RegExp | RegExp[];
  
  /
   
手动包含额外的 JS 或 HTML 文件进行语法检查
   
支持文件路径（相对于项目根目录）或 glob 模式
   
*/
  include?: string[];
  
  /
   
排除特定的错误日志类型
   
*/
  excludeErrorLogs?: ('source' | 'output' | 'reason' | 'code')[];
}

Exemplo de Uso

Configuração Básica

// 使用 browserslist 配置
checkSyntax({
  targets: ['> 1%', 'last 2 versions', 'not dead'],
})
// 直接指定 ECMAScript 版本
checkSyntax({
  ecmaVersion: 'es2015',
})

Arquivos de exclusão

checkSyntax({
  targets: ['> 1%', 'last 2 versions'],
  // 排除 node_modules 和测试文件
  exclude: [/node_modules/, /\.test\.js$/],
  // 排除特定输出文件
  excludeOutput: [/vendor\.js$/],
})

Incluir arquivos extras

checkSyntax({
  targets: ['> 1%', 'last 2 versions'],
  // 手动包含额外的文件进行检查
  include: [
    'src/legacy//*.js',        // 包含 legacy 目录下的所有 JS 文件
    'public/scripts/app.js',     // 包含特定的公共脚本文件
    'docs//*.html',            // 包含文档中的 HTML 文件
    '/absolute/path/to/file.js'  // 支持绝对路径
  ],
})

Saída de erro personalizada

checkSyntax({
  targets: ['> 1%', 'last 2 versions'],
  // 只显示错误原因，不显示代码片段
  excludeErrorLogs: ['code', 'output'],
})

Guia de migração

Se você está migrando do @rsbuild/plugin-check-syntax:

- import { pluginCheckSyntax } from '@rsbuild/plugin-check-syntax'
+ import checkSyntax from '@winner-fed/unplugin-check-syntax/vite' // 或其他构建工具
export default defineConfig({
  plugins: [
  pluginCheckSyntax({
+   checkSyntax({
      targets: ['> 1%', 'last 2 versions'],
    }),
  ],
})

Princípio de Funcionamento

• Verificação após a construção: O plugin verifica os arquivos de saída após a conclusão da construção
• Análise sintática: Usa o analisador Acorn para verificar a sintaxe JavaScript
• Validação de compatibilidade: Valida a compatibilidade da sintaxe de acordo com a versão ECMAScript configurada
• Relatório de erros: Fornece informações detalhadas de erro, incluindo a localização do arquivo e trecho do código-fonte
• Suporte a sourcemap: Se houver sourcemap, faz o rastreamento até o arquivo fonte original

Licença

Licença MIT

Contribuição

Envie Issues e Pull Requests!

--- Tranlated By Open Ai Tx | Last indexed: 2025-07-21 ---