Skip to content

Latest commit

 

History

History
42 lines (37 loc) · 3.85 KB

README.md

File metadata and controls

42 lines (37 loc) · 3.85 KB
Raw

awesome-shell-actions

a claim of "action base programing"

就我自己的观察来看,日常的程序员的工作由一系列action组成,这种action的组合可以类比于所有在emacs上的操作由一系列command组成. unix哲学所带来的强大的复用和组合的能力所导致的一个后果是,为了表达出这些有明确语义的action我们往往要组合多个命令行工具(awk,sed,grep etc).在这时关注的重点不由得从具体的语义(想做什么)变成了繁琐的实现(该怎么做),在这种模式下对象的方法是undiscoverble的。 正如emacs的精华(在我看来)在于强大的自定义command的能力,和良好的交流这些command的场所(包管理市场),我们也应当将那些常用的对象和action整理出来,使的对于这些actions的讨论能够有一个场所.从而能够帮助我们找到action的最佳实现,和发现那些之前没有意识到的actions.

本项目(包括整个awesome-code-actions)旨在整理出那些常用对象的action,给他们一个名字,给程序常与之交互的对象一个抽象一些的方法,使的我们的焦点更关注于对象的语义(对象可以那些方法,我可以对其做什么)而不是语法(具体怎么组合使用工具去达到我们的目的). awesome-shell-actions 关注于对于组合和调用命令行所能表达的action的整理与维护 每个对象由scripts下的××-actions.sh 定义,脚本中的每个以xx-开始的函数定义了一个以这个对象为主体的action.

a claim of "action base programming" as a programmer, I observed that all of my normal work is combined with a series of actions. although UNIX philosophy is the philosophy of “do one thing and do better” “split the question into sub tasks and deal each”， however the consequence of that is we seems more focus on how to deal with question(combine a lot of UNIX tools awk sed grep etc) than what the question is(is this a common action or pattern the object which we manipulated have?). if it is an action, we should name it. take a place summary it and talk about it. this project awesome-shell-actions aims to provide a place to save all the actions which could be express by combining UNIX shell tools,I found those pattern/action repeats emerge in my normal work. those *.actions.sh under scripts folder expose all of function/action named which start with *-, read how to load section to checkout how to use it in zsh

how to load

add below code to you zshrc/bashrc

export AWESOME_SHELL_ACTION_DIR=YOU_PATH_HERE
. $AWESOME_SHELL_ACTION_DIR/scripts/awesome-shell-actions.sh
zmx-load-shell-action $AWESOME_SHELL_ACTION_DIR

protocol

  • 所有的脚本用bash暴露interface,建议以前缀做namespace的隔离
  • 建议所有脚本使用普通用户权限 在脚本中自己sudo
  • scripts下存在所有的脚本,递归所有文件夹层级遍历
  • 使用,xm做呼出快捷键
  • 一个脚本文件只能 描绘一个namespace下的action
  • 使用前必需自己安装fzf等依赖项
  • scripts/awesome-shell-actions.sh 中存放一些元actions 如load list edit
  • 目前支持的装饰器
    • 带参指令标识 位置: 函数名下 语法: # @arg-len: NotZeroNumber 标识action需要参数,此时eval action时不会直接执行,而是会把action写入到zsh LBUFFER上(可以理解为终端上)
    • TODO 指令类型标识 位置: 函数名下 语法: # @catalog: warapp 标识action会修改LBUFFER,只会在LBUFFER不为空时出现
    • TODO 语义指令集 位置: 文件开始处 语法 # @interface: app(APP) 标识此脚本中存在 app interface的指令集,即存在APP-is-install APP-install APP-uninstall等指令 详细协议见下
    • TODO discover 自动检测出是否可执行当前指令

interface

app

TODO

term

LBUFFER: 存放着用户当前输入到终端的指令