Cliff的工作室
一种保存常用脚本的方式

背景问题说明

将常用脚本放在一处是个方便的做法,实现方式也很多,但常见的实现方式有以下问题:

解决方案

有一种较好的方式,可以一次解决上面的问题。具体来说,是利用 just 这个命令行解释器。

实现的关键点,在于按顺序执行以下几个步骤:

  1. 安装 just ,方法很多,我使用 cargo 安装;这样得到一个可执行的 just 命令
  2. 将所有脚本放在同一个 justfile 中,放到一个方便访问的位置,比如 ~/ ;作为辅助,可以将默认(第一个) receipt 作为 help,内容包括:
    1. 打印一些环境变量,
    2. 通过 --list 打印该 justfile 所包含的 receipt
  3. 使用alias方式简化 just 的调用命令(比如用 j ),通过 --justfile--working-directory 指定共用的 justfile 和当前目录

经过以上几步后,能做到以下几点:

  1. 所有小脚本集中在 ~/justfile 中
  2. 在任何路径下,通过 j 命令,可以查看共用脚本中的默认 help
  3. 在任何路径下,通过 j 命令,配合参数,可以执行目标脚本
  4. 使用just命令,可以执行当前目录下的just脚本(注意:不是 ~/justfile)

具体范例

Windows环境

Windows7以上使用PowerShell,需要修改下面两个文件:

# %USERPROFILE%\Documents\PowerShell\Microsoft.PowerShell_profile.ps1

Function EXEC_JUST {just --justfile $env:USERPROFILE\justfile --working-directory . $args}

Set-Alias -Name j -Value EXEC_JUST
# %USERPROFILE%\justfile

# pwsh.exe is latest store version of PowerShell
# powershell.exe is windows default version of PowerShell
# cmd.exe is for windows older than XP
set shell := ["pwsh.exe", "-c"]

help:
	@Write-Host "Shell='pwsh.exe', Dir='$PWD', Using '$env:USERPROFILE\justfile'"
	@just --justfile $env:USERPROFILE\justfile --list

ps-show-version:
	Get-Host | Select-Object Version
	
ps-show-disks:
	Get-CimInstance -query "SELECT * from Win32_DiskDrive"
	
ps-show-env:
	dir env:

Ubuntu / WSL2 环境

# ~/.bashrc
alias j='just --justfile ~/justfile --working-directory .'
# ~/justfile

# sh/bash/dash/... is for different Linux
set shell := ["bash", "-c"]

help:
	@echo "Shell=$0; Dir=`pwd`; Using ~/justfile"
	@just --justfile ~/justfile --list

view-aosp-build-log:
	gzip -cd out/verbose.log.gz | less -R

tar destfile srcdir:
	tar -cvf {{destfile}} -C {{srcdir}} .

tar-gz destfile srcdir:
	tar -cvzf {{destfile}} -C {{srcdir}} .
2021 年 11 月 24 日 10 时 40 分