VS Code でプロジェクトから console.log 文を削除する方法

著者:Sayaib Sarkar更新日:5 分で読めます

このページの内容 6 セクション

要点:VS Code の検索で正規表現を使った「すべて置換」をすれば、1 行の単純な呼び出しは消せますが、同じ行にあるコードまで消してしまい、複数行にまたがる呼び出しは見逃します。安全に片付けるには、コメントと文字列を理解し、1 行で完結する文だけを削除するツールを使い、さらに ESLint のルールを追加して新しいものをレビューで検出しましょう。DevSnip Pro の Clean Debug Logs は、JavaScript、TypeScript、Python、Java、Kotlin、C#、Dart、Swift で前半を担います。

デバッグログは、値の正体を確かめるいちばん手っ取り早い方法です。問題は後片付けです。消し忘れた console.log はブラウザーのコンソールにデータを漏らし、残った print は本番のログを埋め、コミットのたびに手で探すのは面倒です。

方法 1:正規表現で検索・置換(手早いが注意点あり)

Ctrl/Cmd+Shift+H でファイル横断の検索を開き、.* ボタンで正規表現を有効にして、次を検索します:

Text
^[ \t]*console\.log\([^;\n]*\);?[ \t]*\n

Replace は空のままにし、サイドバーで一致箇所を確認してから置換します。このパターンは行全体を占める呼び出しにだけ一致し、最初のセミコロンで止まるので、同じ行のログの後ろにあるコードを消すことはありません。その代わり、; を含むログ(文字列の中など)はスキップされます。

それでも限界があります:

  • console.log(\n user,\n order\n) のような複数行の呼び出しには一致しないので、残ってしまいます。
  • コメントや文字列にも一致します。テンプレートリテラル内の行や、コメントアウトした例が消えてしまいます。
  • 空のブロックが残ることがあります。Python では、if の本体にある唯一の print を消すと構文エラーになります。
  • 1 回の検索で扱えるのは 1 つの言語と 1 つの関数名だけです。

files to include フィールド(src/** など)を使って、node_modules、生成されたファイル、取り込んだサードパーティのコードを対象から外しましょう。

方法 2:DevSnip Pro の Clean Debug Logs

コマンドパレット(Ctrl/Cmd+Shift+P)から DevSnip Pro: Clean Debug Logs を実行します。ワークスペースをスキャンし、何かを変更する前に見つかったものを一覧表示します:

  • console.log、print、pprint、breakpoint()、System.out.println、Log.d、Console.WriteLine、Debug.WriteLine、debugPrint、NSLog、dump などの呼び出し。HTML、Vue、Svelte、PHP ファイルの <script> ブロックも対象です。
  • コメントや文字列の中の呼び出しは無視されます。
  • 1 行で完結する文だけが削除されます。ほかのコードと同じ行にある呼び出し、式の続き、波括弧のない if の本体になっている呼び出しは、削除されずに確認用として一覧表示されます。
  • コードは有効なまま保たれます。空になった Python のブロックには pass、空になった Swift や Dart の case には break が入ります。改行コードも保持されます。

削除前に確認が入ります。設定 devsnip.consoleLogCleanup.confirmBeforeDelete で制御できます。今開いているファイルだけなら Remove Debug Logs in This File を実行し、気が変わったら Undo で元に戻せます。

本来のロギングは安全です。プロジェクトのロガーを通した呼び出し(logger.info、_logger.LogInformation など)は、DevSnip Pro 自身が書いたものでない限り触れられません。

あとで見つけやすいデバッグログを書く

後片付けの問題の半分は、本物のコードに見えてしまうログです。Insert Debug Log(Ctrl+Alt+Shift+L)は、カーソル位置の変数を [file:line] のラベル付きで、適切な場所にログ出力します。代入の後、引数なら関数の先頭、ループ変数ならループの先頭です。

TypeScript
const total = items.reduce((sum, item) => sum + item.price * item.qty, 0);
console.log('[cart.ts:14] total:', total);

ファイルにすでにロガーがあれば、print や console.log の代わりにそれを使います:

Python
total = sum(item.price * item.qty for item in items)
logger.debug("[orders.py:12] total=%r", total)

挿入したログにはすべてラベルが付いているので、プロジェクトのロガーを通していても、Clean Debug Logs があとで認識して削除できます。

方法 3:レビューの時点で新しいログを止める

クリーンアップツールが直すのは今日のログ、lint のルールが止めるのは明日のログです。ESLint のフラット設定なら:

JavaScript
// eslint.config.js
export default [
  {
    rules: {
      'no-console': ['warn', { allow: ['warn', 'error'] }],
    },
  },
];

これは console.log を指摘し、意図的なことが多い console.warn と console.error は許可します。CI で ESLint を実行すれば、残ったログは本番に届く前にチェックで落ちます。Python のプロジェクトでは、Ruff の T20 ルール(flake8-print)で同じことができ、print と pprint を指摘します。

ビルド時にログを取り除くのは?

バンドラーやミニファイアーは、本番ビルドからコンソールの呼び出しを取り除けます。たとえば esbuild の drop オプションや Terser の drop_console です。配布するバンドルには入らなくなりますが、ソースやコードレビューには残ったままです。クリーンアップと lint のルールの代わりではなく、それに加える安全網として使うのが最適です。

うまくいく手順

  1. ラベル付きのログ(Insert Debug Log)でデバッグし、ひと目でわかるようにします。
  2. コミット前に Clean Debug Logs を実行し、一覧を読み、削除されずに指摘されたものを確認します。
  3. すり抜けたものは、CI で ESLint や Ruff に捕まえてもらいます。

自分のエディターで試してみよう

無料・アカウント不要・ローカルで動作。Windows、macOS、Linux の VS Code 1.93 以降と JetBrains IDE に対応。

code --install-extension sayaib.hue-console