rstudio/plumber

Add ability to register a plumb block method

Open

#763 创建于 2021年2月5日

在 GitHub 查看
 (0 评论) (1 反应) (0 负责人)R (1,437 star) (257 fork)batch import
effort: mediumhelp wanted

描述

https://github.com/rstudio/plumber/blob/5d2070089849e05bb356537de266c2464b544a5f/R/plumb-block.R#L16-L243

☝️ has a lot of repetitive behaviors and is closed off to other developers.

It would be great if plumber (and others) could register the functions (similar to parsers and serializers) and allow them to parse a block independently.

Example:

#* @mycustomplumbertag key value value2

Thoughts:

  • Only a single line should be attempt at one time. (This is current behavior)
  • Once a block parser is a hit, the remaining block parsers should not attempted.
  • Don't know what should be supplied or be returned from the block parsers. There is a lot of global state that is currently being altered in the function above. This state should be continued throughout the block's parsing.
  • Should we be allowed to overwrite? Maybe a verbose argument? (like the parsers and serializers)
  • "block parser" or "plumb block" is a confusing name. Need a better one.

贡献者指南

技术栈
无
领域
backendapi
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
unclear
前置要求
R programmingPlumber package internals
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
20
研究方向
Review the linked file `R/plumb block.R` to understand the current repetitive behavior. Consider how other plumber components like parsers and serializers register functions. The issue raises questions about single line parsing, hit logic, global state, and naming; these need resolution before implementation. Look for similar registration patterns in the codebase or existing issues for guidance.