🌐 Язык

unplugin-check-syntax

Универсальный плагин для проверки синтаксиса, поддерживающий различные сборщики (Webpack, Vite, Rollup, esbuild, Rspack и др.), предназначен для проверки совместимости синтаксиса ECMAScript в файлах JavaScript и HTML. Этот плагин основан на rsbuild-plugin-check-syntax.

Особенности

🔧 Поддержка нескольких сборщиков: поддержка Webpack, Vite, Rollup, esbuild, Rspack и др.
📝 Различные типы файлов: поддержка JavaScript-файлов и встроенных скриптов в HTML
🎯 Точное определение местоположения: поддержка sourcemap, можно отследить исходное расположение файла
⚙️ Гибкая настройка: поддержка исключения файлов, ручного включения, фильтрации по типу ошибок и др.
📁 Интеллектуальный поиск файлов: поддержка glob-масок для ручного добавления дополнительных JS/HTML файлов
🌐 Интеграция с Browserslist: поддержка автоматического преобразования конфигурации browserslist в версию ECMAScript

Установка

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

Способ использования

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'],
    }),
  ],
}

Параметры конфигурации

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')[];
}

Использование примера

Базовая конфигурация

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

Исключить файлы

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

Включение дополнительных файлов

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

Пользовательский вывод ошибок

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

Руководство по миграции

Если вы переходите с @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'],
    }),
  ],
})

Принцип работы

Проверка после сборки: Плагин проверяет выходные файлы после завершения сборки
Синтаксический разбор: Использует парсер Acorn для проверки синтаксиса JavaScript
Проверка совместимости: Проверяет совместимость синтаксиса в соответствии с настроенной версией ECMAScript
Отчет об ошибках: Предоставляет подробную информацию об ошибках, включая расположение в файле и фрагмент исходного кода
Поддержка sourcemap: Если присутствует sourcemap, осуществляется обратная трассировка до исходного файла

Лицензия

MIT License

Вклад

Приветствуются Issue и Pull Request!

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