SalesforceのApexでlinterを利用するには？インストール方法を紹介

Apexでlinterを利用する

SalesforceのApexでlinterを使ったコードチェックができれば、複数人で作業する場合にメンバー同士で統一化されたコード整形が容易になります。 linterなどのチェックツールを利用することで、アンチパターンから適切なパターンにコードを整形することが可能です。 本記事ではSalesforceでアプリケーションを開発するときに利用されるApexでlinter（コードチェック）を行う方法を紹介していきます。 ※本記事のSalesforceにおけるlinterの表記について、linterとはC言語のソースコードをチェックするプログラムですが、コードチェックや解析をすることをlintと表現することがあります。転じて本記事ではlintを行うプログラムをlinterと呼びます。

Salesforceでlinterを使用するケース

linterを使用するケースとしては、C言語を利用してソフトウェア開発などを複数人で行う時に、ソースコードを統一化したい場合などです。 SalesforceではApexが開発に利用されますので、linterを使ってソースコードの統一化ができれば、コードの品質向上を図ることが可能です。 簡単にlinterを利用する為には、コードエディターにパッケージをインストールします。次にvscode（コードエディター）でのインストール手順を見ていきましょう。

vscodeでApex PMDというExtensionsをインストールする方法

Salesforceの開発でvscodeを利用している場合は、こちらの解説をお読みください。 まずvscodeのメニューからExtensions（拡張機能）をクリックします。次にクイック検索フォームへ「Apex PMD」と入力し、インストールしてください。 vscode上でCtrl＋Shift＋Pを押下し「Apex Static Analystic :On File」をクリックすると、 指定したデータファイルのチェックが実行されます。 ステータスバーに「Apex PMD」の文字が表示されますので、クリックします。 選択したデータファイルにエラーがある場合は、vscodeのコンソール画面に内容が表示されます。エラーについての詳細は以下のURLをご参照ください。

オープンソースのApex静的コード分析ツール

SalesforceのApexにC言語チェックプログラムのlinterを利用することはできません。 linterの代わりに利用できるApex静的コード分析ツールについて調べたところ、オープンソースでApexに利用できる複数のサービスが見つかりましたので、次にオープンソースの静的コード分析ツールを紹介します。

• PMD Apex
• apexlint（GitHubリポジトリ）
• Apex PMD VsCode Extension
• Mega-Linter（GitHubリポジトリ）
• sfdx-scanner（Azure）
• Apex Pmd（vscode）
• CodeClimate（オープンソースエンジン）
• Codacy.com（GitHub統合サービス）
• codescan（静的分析ツール）

PMD ApexはSalesforceのForce.comというプラットフォームで利用されるプラグインです。 ちなみにPMDとは、C言語だけでなく様々なソースコードを静的にチェックするツールのことを指します。

SalesforceのLightningWebコンポーネントでlinterを設定する方法

SalesforceのLightningWebコンポーネントでlinterを設定するには、開発組織でデバッグモードを有効にしてください。 Salesforceでlinterを利用するメリットとしては、コンパイル前にコードチェックを行いコードのミスをチェックすることで、アンチパターンからの侵入を極力減らす試みが可能になることです。 次の項で、LightningWebコンポーネントでlinterを設定する手順について解説していきます。

• Salesforceの[設定]を開きクイック検索に「デバッグモード」と入力し選択してください。
• 有効にしたいユーザーを選択し、フィルタリングの設定を行います。
• ユーザーの横にあるチェックボックスにチェックをいれて有効化してください。

SalesforceのLightningWebコンポーネントではJavaScriptコードをデバッグする為に利用されます。 この設定をしておくことでコードの整形や、ミスに対して警告やエラーで知らせてくれます。従って開発におけるデバッグ作業が容易になります。

SalesforceのApexでlinterを利用する場合はオープンソースから利用しよう

SalesforceのApexでlinterを利用することで、複数人で作業する場合にメンバー同士で統一化されたコード整形が可能です。 vscodeではオープンソースでApex PMDというExtensions（拡張機能）が利用できますので、インストールしていきましょう。 インストールの手順は以下です。 まずSalesforceのメニューからExtensionsをクリックします。次にフォームに「Apex PMD」と入力し、インストールします。 他にもGitHubなどのオープンソースではApexの静的コード分析ツールが公開されていますので、ご利用の開発環境に合わせて導入してみてください。]]>