はじめに

「コードレビューでインデントの指摘ばかり…」「チーム内でコーディングスタイルがバラバラ…」こんな経験はありませんか？ 本記事では、VSCodeでPrettierを使用した自動フォーマット設定について、初心者にもわかりやすく解説します。

自動フォーマットが必要な理由

コードの自動フォーマットには、以下のようなメリットがあります：

• チーム内でコーディングスタイルを統一できる
• コードレビューで本質的な議論に集中できる
• 開発効率が向上する
• コードの可読性が向上する

必要な準備

1. VSCodeのインストール

まだVSCodeをインストールしていない場合は、公式サイトからダウンロードしてください。

2. Prettier拡張機能のインストール

1. VSCodeを開く
2. 左サイドバーの拡張機能アイコンをクリック
3. 検索バーで「Prettier – Code formatter」を検索
4. インストールボタンをクリック

設定手順

1. プロジェクトにPrettierをインストール

# npmの場合
npm install --save-dev prettier

# yarnの場合
yarn add -D prettier

2. 設定ファイルの作成

プロジェクトのルートディレクトリに.prettierrcファイルを作成し、以下の内容を追加します：

{
  "semi": false,
  "singleQuote": true,
  "tabWidth": 2,
  "trailingComma": "es5",
  "printWidth": 100,
  "arrowParens": "avoid",
  "endOfLine": "lf"
}

3. VSCode設定の追加

1. プロジェクトのルートディレクトリに.vscodeフォルダを作成
2. .vscodeフォルダ内にsettings.jsonファイルを作成
3. 以下の設定を追加：

{
  "editor.formatOnSave": true,
  "editor.defaultFormatter": "esbenp.prettier-vscode"
}

トラブルシューティング

よくある問題と解決方法

1. 自動フォーマットが機能しない
   • Prettier拡張機能が正しくインストールされているか確認
   • .prettierrcファイルの構文が正しいか確認
   • VSCodeを再起動
2. 特定のファイルでフォーマットが効かない
   
3. エラーメッセージが表示される
   • .prettierrcファイルにコメントや不要な内容が含まれていないか確認
   • JSON形式が正しいか確認

応用設定

ESLintとの併用

ESLintも使用している場合は、以下の設定を追加することで、保存時にESLintの自動修正も実行できます：

{
  "editor.formatOnSave": true,
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  }
}

カスタム設定例

プロジェクトの要件に応じて、.prettierrcの設定をカスタマイズできます：

{
  "semi": true,           // セミコロンを強制
  "tabWidth": 4,         // インデントを4スペースに
  "printWidth": 120,     // 1行の最大文字数を120に
  "useTabs": true,       // スペースの代わりにタブを使用
  "bracketSpacing": false // オブジェクトリテラルの括弧内のスペースを削除
}

まとめ

本記事では、VSCodeでPrettierを使用した自動フォーマット設定について解説しました。主なポイントは：

1. Prettier拡張機能のインストール
2. .prettierrcファイルでの基本設定
3. .vscode/settings.jsonでのVSCode設定
4. ESLintとの連携方法

これらの設定を行うことで、効率的な開発環境を構築できます。

参考リンク

• Prettier公式ドキュメント
• VSCode公式ドキュメント

キーワード

#VSCode #Prettier #JavaScript #TypeScript #開発環境設定 #自動フォーマット #コーディング規約 #フロントエンド開発 #Web開発 #プログラミング

問題の概要

Certbotを使用して SSL/TLS 証明書を管理している際、ドメインを変更した後に以下のようなエラーが発生することがあります：

[root@server ~]# /usr/bin/certbot renew --quiet --post-hook "systemctl reload nginx"
Renewal configuration file /etc/letsencrypt/renewal/old-domain.example.com.conf is broken.
The error was: target /etc/letsencrypt/archive/old-domain.example.com/cert3.pem of symlink /etc/letsencrypt/live/old-domain.example.com/cert.pem does not exist
Skipping.
0 renew failure(s), 1 parse failure(s)

この問題は、新しいドメインで証明書を作成したにもかかわらず、古いドメインの更新設定ファイルが残っているために発生します。

解決方法

以下の手順で問題を解決できます：

古い証明書の設定ファイルを削除します：

sudo rm /etc/letsencrypt/renewal/old-domain.example.com.conf

古い証明書のアーカイブとライブデータを削除します：

sudo rm -rf /etc/letsencrypt/archive/old-domain.example.com
sudo rm -rf /etc/letsencrypt/live/old-domain.example.com

certbotの更新をドライランで実行し、新しい証明書の設定が正しく機能することを確認します：

sudo certbot renew --dry-run

問題なく動作することを確認したら、実際の更新を実行します：

sudo /usr/bin/certbot renew --quiet --post-hook "systemctl reload nginx"

注意点

• 証明書や設定ファイルを削除する前に、重要なデータのバックアップを取ることをお勧めします。
• 新しいドメインの証明書が正しく作成され、Nginxの設定で使用されていることを確認してください。
• この操作を行うと、古いドメインの証明書は完全に削除されます。もし古いドメインもまだ使用している場合は、別途証明書を取得する必要があります。
  

以上の手順により、Certbotによる証明書の自動更新が新しいドメインに対して正しく機能するようになります。

OpenSSLとNode.jsの http-server モジュールを使って、ローカル環境でHTTPSサーバーを立ち上げる方法を説明。

Subject Alternative Name (SAN) を設定する

vim SAN.txt
---
subjectAltName = DNS:sumito.jp

この手順では、SANを指定するためのファイル SAN.txt を作成します。ここでは sumito.jp をSANとして指定していますが、適宜変更してください。

秘密鍵と証明書の作成

openssl genrsa -out server.key 2048
openssl req -out server.csr -key server.key -new
openssl x509 -req -days 3650 -signkey server.key -in server.csr -out server.crt -extfile SAN.txt

この一連のコマンドで、2048ビットの秘密鍵 server.key と、その秘密鍵に基づく証明書署名リクエスト(CSR) server.csr を作成します。最後に、CSRと秘密鍵から、有効期限3650日の自己署名証明書 server.crt を作成しています。この際、先ほど作成した SAN.txt ファイルを使ってSANを設定しています。

HTTPSサーバーの起動

http-server -S -C server.crt -K server.key -p 443

最後に、http-server コマンドを実行して、HTTPSサーバーを起動します。このコマンドでは、作成した server.crt と server.key を指定し、ポート443でリッスンするように指定しています。

hosts に以下の通り記載します

127.0.0.1       sumito.jp

これで、ローカル環境でHTTPSサーバーが立ち上がりました。ブラウザで https://sumito.jp/ にアクセスすると、自己署名証明書の警告が出る場合がありますが、それを無視して進めばウェブサーバーにアクセスできます。

注意点として、この方法で作成した証明書は自己署名なので、実際の運用環境では使えません。

本番環境で使う場合は、認証局から発行された適切な証明書を取得する必要があります

キーが固定の場合

以下は、シェルスクリプトでJSONデータを読み込み、jqコマンドを使用して同様の処理を行う例です。

#!/bin/bash

json='[{"name":"Worker","no":"123"}, {"name":"User","no":"456"}, {"name":"Organization","no":"789"}, {"name": "Position","no":"123"}, {"name": "PositionTranslation","no":"123"}]'

echo "$json" | jq -c '.[]' | while read -r item; do
  name=$(echo "$item" | jq -r '.name')
  no=$(echo "$item" | jq -r '.no')
  
  echo "$name"
  echo "$no"
  echo "-----"
done

このスクリプトでは:

1. json変数にJSONデータを文字列として格納します。
2. echo "$json" | jq -c '.[]'を使用して、JSONデータをパイプでjqコマンドに渡し、各オブジェクトを個別の行に分割します。
3. while read -r itemを使用して、各オブジェクトを1つずつ読み込みます。
4. echo "$item" | jq -r '.name'とecho "$item" | jq -r '.no'を使用して、各オブジェクトからnameとnoの値を抽出します。
5. 抽出した値とセパレーターを表示します。

結果はこちらです

Worker
123
-----
User
456
-----
Organization
789
-----
Position
123
-----
PositionTranslation
123
-----

キーが固定でない場合（接頭辞が共通の場合）

JSONデータのキーが一部共通している場合、jqコマンドの to_entries、select、mapを組み合わせて目的の値を取得することができます。以下は、public_ip で始まるキーに対応する値を取得する例です。

#!/bin/bash

json='{"public_ip01": "1.2.3.4", "public_ip02": "2.3.4.5", "public_ip03": "12.2.3.4"}'

echo "$json" | jq -r 'to_entries | map(select(.key | startswith("public_ip")).value)'

このスクリプトでは:

1. json 変数にJSONデータを文字列として格納します。
2. echo "$json" | jq -r 'to_entries | map(select(.key | startswith("public_ip")).value)' を使用して、JSONデータを jq コマンドに渡し、以下の処理を行います:
   • to_entries で、JSONオブジェクトをキーと値のペアの配列に変換します。
   • map(select(.key | startswith("public_ip"))) で、キーが "public_ip" で始まるエントリーのみを選択します。
   • .value で、選択されたエントリーの値のみを取得します。
3. jq の出力は、選択された値の配列になります。

このスクリプトを実行すると、以下のような結果が得られます

"1.2.3.4" "2.3.4.5" "12.2.3.4"

これにより、public_ip で始まるキーに対応する値が取得できました。必要に応じて、この出力を変数に格納したり、ループ処理で個別に処理したりすることができます。

SendGridのSMTPサーバーを使ったメール送信をシェルスクリプトで確認する方法

SendGridは、メールの配信を専門とするクラウドベースのサービスであり、多くの開発者やビジネスに利用されています。SendGridのSMTPサーバーを利用することで、アプリケーションからメールを送信することができます。ここでは、シェルスクリプトを使ってSendGridのSMTPサーバー経由でメールを送信する方法を紹介します。

SendGridを使うメリット

• 高い配信率: SendGridは、高い配信率を実現するために、メールの配信に関する様々な技術を駆使しています。
• スパムフィルタリング: SendGridは、スパムメールの送信を防ぐために、高度なスパムフィルタリング技術を採用しています。
• 分析とトラッキング: SendGridは、メールの開封率やクリック率などの詳細な分析データを提供し、メールマーケティングのパフォーマンスを追跡することができます。
• シンプルなインテグレーション: SendGridは、SMTPリレーやWebAPIなど、様々なインテグレーション方法を提供しており、開発者にとって使いやすいサービスになっています。

必要なもの

• SendGridのアカウント
• SendGridのAPIキー

シェルスクリプト

以下のシェルスクリプトを使って、SendGridのSMTPサーバー経由でメールを送信できます。

#!/bin/bash

smtp_server="smtp.sendgrid.net"
smtp_port=587
smtp_username="apikey"
smtp_password="SG.xxxxxxxx"

from_address="from@hoge.jp"
to_address="to@hoge.jp"

subject="Bash SMTP テスト"
body="mail test"

message="From: $from_address
To: $to_address
Subject: $subject

$body"

# メッセージをファイルに書き出す
echo "$message" > message.txt

# SMTPサーバーに接続してメールを送信
curl --ssl-reqd \
--url "${smtp_server}:${smtp_port}" \
--user "${smtp_username}:${smtp_password}" \
--mail-from "${from_address}" \
--mail-rcpt "${to_address}" \
--upload-file message.txt

# 一時ファイルを削除
rm message.txt

手順

1. SendGridのアカウントを作成し、APIキーを取得します。
2. シェルスクリプトの smtp_password の部分を、取得したAPIキーに置き換えます。
3. from_address と to_address を、実際の送信元と送信先のメールアドレスに置き換えます。
4. シェルスクリプトを実行します。

 chmod +x script_name.sh ./script_name.sh

5. メールが送信されたことを確認します。

解説

このシェルスクリプトでは、curlコマンドを使ってSendGridのSMTPサーバーに接続し、PLAINタイプの認証を使ってメールを送信します。

メッセージ本文は一時ファイルに書き出され、curlコマンドの --upload-file オプションを使ってSMTPサーバーに送信されます。メール送信後、一時ファイルは削除されます。

SendGridを使ったメール送信のテストの重要性

SendGridを使ってメール送信機能を実装する前に、実際にメールが送信できることを確認することは非常に重要です。以下のような理由から、メール送信のテストを行うことが推奨されます。

• メールの配信設定の確認: SendGridの設定が正しく行われているかどうかを確認することができます。
• メールの内容の確認: メールの件名や本文が意図した通りに表示されるかどうかを確認することができます。
• エラーの早期発見: メール送信に関する問題を早期に発見し、修正することができます。

シェルスクリプトを使ったメール送信のテストは、手軽に実行できる方法の一つであり、SendGridを使ったメール送信機能の実装前に行うことをお勧めします。

まとめ

シェルスクリプトを使うことで、SendGridのSMTPサーバー経由でメールを送信できることを確認しました。この方法は、SendGridを使ってメール送信機能を実装する前の動作確認に役立ちます。メール送信のテストを行うことで、メールの配信設定やメールの内容を確認し、エラーを早期に発見することができます。SendGridを使ったメール送信機能の実装では、このようなテストを行うことが重要です。

SendGridは、高い配信率やスパムフィルタリング、分析とトラッキング機能など、多くのメリットを提供するサービスです。SendGridを使うことで、信頼性の高いメール配信を実現することができます。