premake / premake/premake-core

Running `./premake5 --help` in a directory with corrupted premake5.lua will only show error

Open
#1,967 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
C
Stars
3.6k
Forks
654
Avg merge
1d 1h
Merged PRs (30d)
13

Description

Before opening a new bug report, please read Reporting Bugs and consider if this is something you can contribute yourself. If this a new bug, help us help you by filling in the template below.

What seems to be the problem?
Running ./premake5 --help in a directory with corrupted premake5.lua will only show error.

What did you expect to happen?
premake5 --help show warning, ignore the premake5.lua file, and show other help information.

What have you tried so far?
Delete or rename bad premake5.lua.

How can we reproduce this?

mkdir test-premake
cd test-premake
cp /whatever/path/to/premake5.exe .
./premake5 --help
echo aaaaa > premake5.lua
./premake5 --help

What version of Premake are you using?
Error: F:/Works/test-premake/premake5.lua:2: syntax error near

Anything else we should know?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the problem in a clean directory using the documented premake5 and premake5.lua commands, then inspect the CLI path that handles help requests and configuration-file errors. Done means ./premake5 --help warns about a corrupted premake5.lua, ignores it, and still displays the remaining help information.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
cli, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.