Docs: Built in functions shadow user variables
还没有人认领这个 Issue。
评估
- 难度
- 1/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 62/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 停滞
- 技术栈
- go
调研方向
从 https://expr-lang.org/docs/language-definition 中的语言定义开始，并查看内置函数的文档编写方式。添加关于 count > 0 等名称冲突的警告，提及 $env.count 这一 workaround 以及用于禁用函数的 API 选项，并包含指向 API 文档的链接。
由索引模型根据 Issue 内容生成。
描述
Problem:
When using go-expr in default mode, functions are enabled. The function list includes some commonly defined variables, like count, and leads to expression compilation errors in cases like count > 0.
Solution:
The API exports functions that allow disabling a particular built-in function, or disabling them all. No implementation is necessary to work around the issue, and the issue also has other solutions like $env.count.
Proposal:
The language definition seems to be the canonical source of truth for which functions are implemented in go-expr. I'd like if a warning could be added that mentions the problem, and the option to disable the built in functions is possible via API.
Proposed text (discussion starter, MVP):
The built in functions may cause issues in evaluation when the variables share the same name. It's very common to use
count > 0expressions in simplistic checks, producing an error. You can change the expression to$env.countto avoid the issue. The API allows to disable built in functions, avoiding issues when you don't have control over the input and mainly want to use other features of expr like conditions and ternary operators. See the API documentation
- 主要语言
- Go
- 星标
- 8k
- 派生
- 535
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
expr-lang/expr 的其他 Issue
-
难度 3/5 1-2 天 新手友好度 65/100
-
`find`, `findIndex`, `first` and `get` are type-checked as the element type where they return nil未关闭
难度 3/5 1-2 天 新手友好度 65/100
-
难度 4/5 3-5 天 新手友好度 35/100
-
难度 5/5 一周以上 新手友好度 35/100
-
难度 3/5 1-2 天 新手友好度 55/100
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 84/100
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
linonetwo/cpa-session-archive#25 ·
维护者通常 1 天内回复
-
area/testing kind/bug
难度 2/5 1-3 小时 新手友好度 76/100
维护者通常 1 天内回复
-
agent-butler-finding bug
难度 1/5 1 小时以内 新手友好度 94/100
jordansmall/spindrift#4367 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1 小时以内 新手友好度 90/100
维护者通常 1 天内回复