🌐 言語

unplugin-check-syntax

さまざまなビルドツール（Webpack、Vite、Rollup、esbuild、Rspack など）をサポートする汎用的な構文チェックプラグインで、JavaScript および HTML ファイル内の ECMAScript 構文の互換性をチェックします。本プラグインは rsbuild-plugin-check-syntax を参考にしています。

機能特長

🔧 マルチビルドツール対応: Webpack、Vite、Rollup、esbuild、Rspack などに対応
📝 複数ファイルタイプ対応: JavaScript ファイルおよび HTML ファイル内のインラインスクリプトに対応
🎯 正確な位置特定: ソースマップ対応で、元ファイルの位置まで追跡可能
⚙️ 柔軟な設定: ファイル除外、手動追加、エラータイプのフィルタリング等のオプションに対応
📁 スマートなファイル検出: 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.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 ライセンス

貢献

Issue と Pull Request の提出を歓迎します！

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