👾

paclear: PAC-MANによるターミナルクリーニング

2023/10/26に公開

はじめに

PAC-MANがターミナルを掃除するpaclearというコマンドを作りました。

paclear-demo

この記事はpaclearコマンドの宣伝です。

https://github.com/orangekame3/paclear

なぜ作ったか

こちらの記事が直接的なきっかけです。

かねてよりsheeplaさん作のpinguコマンドであったり、有名なslコマンドのようないわゆるジョークコマンドをひとつは作ってみたいなと思っていました。

記事中、以下の文言を目にしたためPAC-MANを使った何かしらを作りたいなと思い立ちました。

個人の「パックマン及び自社IPゲームシリーズ」ファンの皆様がゲームソフトウェア及びゲーム実況を除く形式で、自由にファンメイドコンテンツを制作し、あらゆるメディアやフォーマットでご共有いただくことについて、著作権侵害を主張しません。

私は95年生まれで、PAC-MANをプレイしたことはないのですが、口を開閉させながら動いているアニメーションは知っていました。
直感的にですが、clearコマンドと組み合わせると良さそうだなと思いPAC(-MAN)とCLEARということでpaclearコマンドを作ってみようと思ったわけです。

機能

clearコマンドのようにターミナルの文字列を削除します。clearコマンドと異なる点はパクパクと口を動かすPAC-MANのアニメーションが左から右へと横切る点です。

画面に表示されている文字列全てを削除するまで繰り返すようなアニメーションにしています。

オプション

いくつかのオプションを用意してます。

`--color(-c)`オプション

--color(-c)で色を変更できます。

paclear -c yellow

demo-with-color

`--speed(-s)`オプション

--speed(-s)でアニメーションの速さを変更できます。
指定した数値だけデフォルトの速さを倍速します。

paclear -s 2

demo-with-speed

使用方法一覧

以下、使用方法一覧です。

❯ paclear --help
paclear is a clear command with pacman animation

Usage:
  paclear [flags]

Flags:
  -c, --color string   Set pacman color (available: red, green, blue, yellow, pink) (default "white")
  -h, --help           help for paclear
  -s, --speed int32    Set pacman multiple speed (default: 1) (default 1)
  -v, --version        version for paclear

Tips

デフォルトの色やスピードを設定する機能は設けていませんが、aliasを組むことで同じようなことはできます。
以下のスクリプトを利用しているshell(.bashrcもしくは.zshrc)に設定するとデフォルト設定を反映できます。(設定後source ~/.bashrc(.zshrc)をお忘れずに)

alias paclear="paclear -c y -s 3"

インストール方法

4通りの方法を用意しています。
GoもしくはHomebrew経由のインストール方法をオススメします。

Go

go install github.com/orangekame3/paclear@latest

Homebrew

brew install orangekame3/tap/paclear

Winget

一応、私の環境ではwingetでインストールできることを確認していますが、正式な方法としてMicrosoftから提供されてる手法ではないため、他のインストール方法の方が良いかもしれません。

模索しつつwinget対応したため、GoReleaserでwinget対応した記事は別途まとめる予定です。

まず最初にLocalManifestFilesを有効化する必要があります。これはローカル上のマニフェスト(設定ファイル)からアプリをインストール可能にするために必要です。
管理者権限のPowershellで以下を実行してください、

winget settings --enable LocalManifestFiles

次にwingetのスクリプトを含んだインストーラーをダウンロードして実行します。
これはGitBashで行うことを推奨します。

curl -L https://raw.githubusercontent.com/orangekame3/paclear/main/win-installer.sh
.\win-installer.sh

マニュアルダウンロード

各環境用にビルド済みのフアイルをアップロードしているのでこちらからダウンロードして実行することも可能です。

ここからダウンロード

さいごに

良ければpaclearコマンド、実際に使ってみてください。
Issue、PR、Star、Fork大歓迎(嬉しい)ですので遠慮なくしていただければと思います。
コントリビューションお待ちしています。