Shebang callback support in language bindings

未关闭
#4,344 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
30/100
Issue 类型
功能
描述清晰度
需要澄清
活跃度
活跃
技术栈
c, ruby, rust

调研方向

Start with the Rust binding callback branch and the referenced main_script option in ext/prism/extension.c, then compare how Prism’s language bindings handle parser options. The issue asks whether shebang processing belongs in Prism or in each binding, including the effects of flags such as -n on the AST. Done means that design question is resolved and the chosen behavior is supported consistently.

由索引模型根据 Issue 内容生成。

描述

related to https://github.com/fables-tales/rubyfmt/issues/916

Some files are only syntactically valid after they've been processed with shebang comments, e.g.

#!/usr/bin/env ruby -np
next

Currently, the way these are handled is by passing a shebang_callback which reads the flags and sets the appropriate options (like here in CRuby).

I'd like for rubyfmt to be able to support files like this, and as for the immediate solution it wouldn't be too hard to add support for shebang callbacks in the Rust bindings (I've got a branch with those changes), but I suppose my broader question is whether or not language bindings all having to reinvent shebang handling is the desired end result.

Right now, this example also fails in the prism gem (Prism::parse('#!/usr/bin/env ruby -np\nnext') returns errors), and presumably does the same for all the language bindings, and yet echo '#!/usr/bin/ruby -n\nnext' | ruby -c says the syntax is OK, which is somewhat surprising and leads to things like ruby-lsp also reporting errors on similar files. That said, a reasonable argument for Prism not doing this handling by default is that some shebang flags (like -n) result in nodes being inserted into the AST, and it might not be ideal to do that without some kind of explicit choice -- though as it currently stands it does require the main_script option to be set, which may be sufficient.

So my question is, is the preferred approach for users of Prism to re-implement shebang handling (and it can be exposed as an option by the various language bindings), or is there some world where Prism itself handles shebangs?

主要语言
C
星标
1k
派生
202
平均合并
6 小时 18 分钟
30 天内合并 PR
77

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

ruby/prism 的其他 Issue

查看 ruby/prism 的全部 Issue

相似的 Issue

更多 C Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。