teal-language/cyan

Add support for teal's `--keep-hashbang` compiler option in `build` and `gen`

Open

#70 opened on Feb 20, 2026

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Lua (12 forks)auto 404
feature requestgood first issue

Repository metrics

Stars
 (125 stars)
PR merge metrics
 (PR metrics pending)

Description

Context

I'm building a Lua library to use with Redis Functions. The Lua script must start with a shebang to define metadata, such as the engine to use and the library's name. E.g.

#!lua name=mylib
redis.register_function(
  'knockknock',
  function() return 'Who\'s there?' end
)

which can be loaded in Redis with:

redis-cli  FUNCTION LOAD "$(cat ./build/main.lua)"

Problem

Teal's compiler options supports the --keep-hashbang flag to preserve the shebang at the top of the file. However, this option is missing in cyan's build and gen commands.

It would be nice to support this option in cyan, so we don't have to prepend it post build.

Appreciate all the work, enjoyed using cyan for the first time 🙏🏻

Contributor guide

Research direction
Locate where compiler options are passed in the build and gen commands (likely in the source code) and add the keep hashbang flag, ensuring it is forwarded to the Teal compiler.
Tech stack
luatypescript
Domain
build systemtooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
LuaTealGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80