Feature: Actually explain shell constructs
还没有人认领这个 Issue。
评估
调研方向
该 issue 没有指出文件、测试或入口点。首先定位现有的命令行 flag 和参数说明路径，然后确定哪些 shell 构造和 shell 变体属于范围；完成的标准是对受支持的构造进行说明，并正确区分不同的 shell 语义。
由索引模型根据 Issue 内容生成。
描述
Hello @idank and thank you so much for making such a useful project!
One of its limitations is that, currently, it supports explaining command-line flags and arguments, from various things which have man-pages.
It does NOT support explaining basic shell contracts, let alone complicated shell constructs -- and is not opinionated on WHICH shell is being explained (sh/bash/dash/ksh/csh/zsh/etc.).
It would be nice to be able to paste in something like this:
if (( VARIABLE )); then
To inform me that the condition is taken IFF the variable $VARIABLE has been set.
This is distinct from e.g.
if [ -n "$VARIABLE" ]; then
Which takes the "true" condition only when $VARIABLE is defined AND has a nonzero content.
A similar shell construct might be
if [ -v VARIABLE ]; then
Which is identical to the first -- the -v flag returns true if its argument (VARIABLE) is a shell variable that is set at all --even if it's empty.
Do you have any plans to support something like this?
A stretch goal would be to support complicated shell expansion, e.g.
for k v in "${(@kv)zsh_associative_array}"; do
Which iterates over an associative array (in zsh, and possibly ksh) where k and v are set to the key and value of each entry.
- 主要语言
- Python
- 星标
- 14.3k
- 派生
- 851
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
idank/explainshell 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 75/100
idank/explainshell#367 ·
-
难度 3/5 1-2 天 新手友好度 65/100
idank/explainshell#368 ·
-
难度 3/5 1-2 天 新手友好度 65/100
idank/explainshell#365 · 2 条评论 ·
-
难度 4/5 3-5 天 新手友好度 35/100
idank/explainshell#354 · 2 条评论 · 4 个 reaction ·
-
难度 3/5 1-2 天 新手友好度 45/100
idank/explainshell#343 ·
查看 idank/explainshell 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 84/100
PedestrianDynamics/pyFDS-Evac#343 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 88/100
theskumar/python-dotenv#708 ·
-
难度 1/5 1 小时以内 新手友好度 88/100
维护者通常 2 天内回复
-
Docs Timedelta
难度 2/5 1-3 小时 新手友好度 72/100
pandas-dev/pandas#69919 ·
维护者通常 1 天内回复
-
API documentation
难度 2/5 1-3 小时 新手友好度 72/100
zephyrproject-rtos/west#1009 · 2 条评论 ·
维护者通常 3 天内回复