写経するときに気をつけること

はじめに

記事を書いた動機

• 本筋から逸れたところで詰まったときに、検索しても思ったものが出てこないのが辛かった
• 今度謎エラーで詰まった時に最初に見れるものを作りたい

写経するときに気をつけること

最後の一文字が抜けていないか

singleQuote: true
trailingComma: 'all'

このような文字列をコピペする際、

singleQuote: true
trailingComma: 'all

になっていないか確認する。

コードチェックが走る拡張子のものだと見つけやすいですが、拡張子がない設定ファイルだと見つけにくいので特に注意してください。

(記事執筆のきっかけになったミスです)

シングルクオートがバッククオートになっていないか

コピペ元によっては、シングルクオート(「'」)がバッククオート(「`」)になっていることがあるので確認する。

コピペ後、コメントインする際にインデントが間違っていないか

プログラムコードの場合、IDEがいい感じにやってくれることが多いと思いますが、設定ファイルは見た目ではわかりにくいです。

以下はyamlファイルの抜粋です(Railsのstorage.yml)

# amazon:
#   service: S3
#   access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %>
#   secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %>
#   region: us-east-1
#   bucket: your_own_bucket

のコメントアウトをショートカットで解除すると

 amazon:
   service: S3
   access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %>
   secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %>
   region: us-east-1
   bucket: your_own_bucket

という風に、冒頭1文字分のスペースが残っています。
yamlのインデントが云々~というエラーが出るのでインデントが変なんだと気づくとこまではすぐでしたが、一見しただけではどこが変なんだと気づきにくいので注意が必要です。

まとめ

• pdfからのコピペはミスりやすいので注意
• 設定ファイルにコピペする場合は特に注意
  • プログラムコードはエディタでなんとかしてくれることが多い