ログイン

フォーマッターとリンターについて

 2021.4.23 ゴリラーブログ ブログ マッシュゴリラー上野

 

 

こんにちは。マッシュゴリラー上野です。

 

今までのブログではパソコンの作業の効率化等について話してきましたが、

今回はプログラミングでの作業効率化のお話になります。

 

話の内容としてはタイトルにもある通り、フォーマッターとリンターについてです。

 

今までフォーマッターやリンターを使いたいとは思っていたのですが、複数人で

同じコードを修正するときに、最初から導入しておかないとフォーマッターの機能で

自動的に修正されて、今回修正したかった部分以外にgitの修正がたくさん入ってしまうので

避けていました。

 

あと、リンターも古いコード等はエラー表示まみれになるのであまり使っていませんでした。

しかし、最近コードを書いている所では僕が触る頃にはすでに導入されており、

初めて本格的にフォーマッターとリンターを使ってみて、やっぱりいいな~と思ったので

紹介していきます。

 

 

「フォーマッター」

フォーマッターとは、簡単に言えばコードをきれいになるように自動で修正してくれる物です。

 

ちなみにこれは、ターミナルなどでコマンドを打ち込んで整形させるような使い方や、

ファイルを保存したタイミングで整形させるような使い方ができます。

 

個人的にはファイルを保存したタイミングで整形される使い方が好きです。

 

 

「リンター」

リンターとは、簡単に言えば、コードの悪い書き方を指摘してくれる物です。

 

そう聞くと、先ほど紹介したフォーマッターを使えばリンターは必要ないんじゃないかと

思われるかもしれませんが、実際はフォーマッターでどんなコードでも修正できるわけでは

ないので、一部人間の手で修正が必要ということです。

 

といってもたいていの場合はフォーマッターで事足ります。

 

 

使い方

私は最近pythonばかり触っているので、pythonの場合の使い方を紹介していきます。

pythonの場合は他の言語に比べるとフォーマッターの恩恵は少ないですが、

実際使ってみると細かいところで助かります。

 

ちょっと脱線しますが、htmlとかのコーディングするときにフォーマッターを使うと、

インデントなどを気にせずぐちゃぐちゃに書いてからフォーマッターかけると楽だし、

一気に整頓されてめちゃくちゃ気持ちいいですよね(笑)

 

話を戻しまして、pythonの実行環境なのですが、

docker上でpythonをインストールして使う場合と、anaconda上で使う場合と試しましたが、

どちらも快適に使用できてます。

 

 

めちゃめちゃ簡潔に説明すると、以下の4ステップで使用できます。

1.ターミナル上で「pip install black flake8」を実行 ←ライブラリをインストール

2.ぐちゃぐちゃのソースコードを記述してindex.pyとして保存

3.ターミナル上で「black index.py」を実行 →きれいに整頓orエラー

4.ターミナル上で「flake8 index.py」を実行 →きれいであれば何もなし、汚いと指摘

 

※注意点

・環境が準備されている前提の話

・使用するライブラリの説明は長くなるので省略

・コマンドで実行する場合の例です。

・場合によっては正常に動作しないかもしれません。

 

↓実際にフォーマッターを実行した例

 

 

※もしかしたら画像が小さくて見えづらいかもしれませんが、ご了承ください。

 

 

おわりに

いかがでしたでしょうか?

今回書いていて思ったのは、こういう技術的なことを書いていると

めちゃくちゃ話が長くなってしまうなと思いました。

 

簡潔に書くつもりなのですが、どうしても長くなってしまいます。

色々話したくなるからという理由もあると思いますが、

文章力がないことが一番の原因だと思います。

 

最後まで読んでくださりありがとうございました。

 

 

© 2021 Mountain Gorilla Co., Ltd. 

プライバシーポリシー

%d人のブロガーが「いいね」をつけました。