Judoka

Judoka 是一个命令行工具，允许您定义项目范围的命令并通过它们的别名调用它们。它让您只需（=柔道）完成工作。

安装

使用 pip 安装此库

$ pip install judoka

用法

在您的项目根目录中创建一个 .judorc 文件，如下例所示

greet = "cowsay 'Hi!'"

[frontend]
start = "npm run start"

[backend]
start = "docker compose up -d"

然后，只需运行任何别名

$ judo greet
$ judo frontend:start
$ judo backend:start

或者，查看您项目中所有可用的命令列表

$ judo

您也可以选择在您的 $HOME 文件夹中包含一个 .judorc 文件（~/.judorc）。在此文件中定义的命令将始终首先加载，如果找到重叠的命令，则将被覆盖。

Shell补全

要安装 judo shell补全，执行 judo-completions [--apply] {bash|fish|zsh} 以获取有关如何为所选shell安装补全的说明。通过包含 --apply 选项，安装说明将为您应用。

注意： 不要忘记在安装后重新加载shell会话以加载补全。

开发

要为此库做出贡献，首先检出代码。然后创建一个新的虚拟环境

cd judoka
python -mvenv venv
source venv/bin/activate

或者如果您正在使用 pipenv

pipenv shell

现在安装依赖项和测试依赖项

pip install -e '.[test]'

要运行测试

pytest