Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

commandline: Refactor and streamline special syntaxes #2264

Merged
merged 1 commit into from
Jun 13, 2022
Merged

commandline: Refactor and streamline special syntaxes #2264

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 38 additions & 18 deletions source/dub/commandline.d
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -391,6 +391,11 @@ unittest {
*/
int runDubCommandLine(string[] args)
{
static string[] toSinglePackageArgs (string args0, string file, string[] trailing)
{
return [args0, "run", "-q", "--temp-build", "--single", file, "--"] ~ trailing;
}

logDiagnostic("DUB version %s", getDUBVersion());

version(Windows){
Expand All @@ -403,28 +408,43 @@ int runDubCommandLine(string[] args)
auto handler = CommandLineHandler(getCommands());
auto commandNames = handler.commandNames();

// special stdin syntax
if (args.length >= 2 && args[1] == "-")
// Special syntaxes need to be handled before regular argument parsing
if (args.length >= 2)
{
auto path = getTempFile("app", ".d");
stdin.byChunk(4096).joiner.toFile(path.toNativeString());
args = args[0] ~ [path.toNativeString()] ~ args[2..$];
}

// Shebang syntax support for files without .d extension
if (args.length >= 2 && !args[1].endsWith(".d") && !args[1].startsWith("-") && !commandNames.canFind(args[1])) {
if (exists(args[1])) {
// Read input source code from stdin
if (args[1] == "-")
{
auto path = getTempFile("app", ".d");
copy(args[1], path.toNativeString());
args[1] = path.toNativeString();
} else if (exists(args[1].setExtension(".d"))) {
args[1] = args[1].setExtension(".d");
stdin.byChunk(4096).joiner.toFile(path.toNativeString());
args = toSinglePackageArgs(args[0], path.toNativeString(), args[2 .. $]);
}
}

// special single-file package shebang syntax
if (args.length >= 2 && args[1].endsWith(".d")) {
args = args[0] ~ ["run", "-q", "--temp-build", "--single", args[1], "--"] ~ args[2 ..$];
// Dub has a shebang syntax to be able to use it as script, e.g.
// #/usr/bin/env dub
// With this approach, we need to support the file having
// both the `.d` extension, or having none at all.
// We also need to make sure arguments passed to the script
// are passed to the program, not `dub`, e.g.:
// ./my_dub_script foo bar
// Gives us `args = [ "dub", "./my_dub_script" "foo", "bar" ]`,
// which we need to interpret as:
// `args = [ "dub", "./my_dub_script", "--", "foo", "bar" ]`
else if (args[1].endsWith(".d"))
args = toSinglePackageArgs(args[0], args[1], args[2 .. $]);

// Here we have a problem: What if the script name is a command name ?
// We have to assume it isn't, and to reduce the risk of false positive
// we only consider the case where the file name is the first argument,
// as the shell invocation cannot be controlled.
else if (!commandNames.canFind(args[1]) && !args[1].startsWith("-")) {
if (exists(args[1])) {
auto path = getTempFile("app", ".d");
copy(args[1], path.toNativeString());
args = toSinglePackageArgs(args[0], path.toNativeString(), args[2 .. $]);
} else if (exists(args[1].setExtension(".d"))) {
args = toSinglePackageArgs(args[0], args[1].setExtension(".d"), args[2 .. $]);
}
}
}

auto common_args = new CommandArgs(args[1..$]);
Expand Down