Introduce `stack run` command line option #3952

rszibele · Apr 1, 2018

This pull request introduces stack run which allows directly building and running a specified executable similar to cabal run. If no executable is specified, it defaults to the first available executable in the project. This implements the whishlist issue: #233

Any changes that could be relevant to users have been recorded in the ChangeLog.md

I tested it by running the newly built stack through stack:

stack exec stack run
stack exec -- stack run help
stack exec -- stack run -- help

I also tested it with a simple project which prints out the command line arguments:

stack run -> []
stack run "Hello, world!" -> ["Hello world"]
stack run "Hello" "World" -> ["Hello", "World"]
stack run -- "Hello" "World" -> ["Hello", "World"]
stack run hello-exe "Hello World" -> ["Hello world"]
stack run hello-exe "Hello" "World" -> ["Hello", "World"]
stack run -- hello-exe "Hello" "World" -> ["Hello", "World"]
After removing all executables from the project:
stack run -> No executables found.

Any thoughts on the code? improvements? I'm pretty new to Haskell and stack.

AshleyYakeley · Apr 15, 2018

Does stack run build the executable first?

rszibele · Apr 15, 2018

@AshleyYakeley No, just like with stack exec the stack run command requires the project to already be built.

AshleyYakeley · Apr 15, 2018

OK, so this does not implement #233, which is for a stack run command that builds and then runs.

rszibele · Apr 15, 2018

@AshleyYakeley good catch, the original issue was with a build before execution. I went off @johnynek suggestion with running the first available executable without building like stack exec.

I'll be implementing that after my exams are over.

AshleyYakeley · Apr 15, 2018

OK, so will it build the entire project, or just enough to build the executable in question?

rszibele · Apr 16, 2018

I'm tending towards only building the package which contains the executable. Given that the dependencies are properly defined, it shouldn't be required to build all packages, at least that's my line of thinking. Thoughts?

AshleyYakeley · Apr 16, 2018

I think that's sensible.

rszibele · Jun 4, 2018

stack run now also builds the executable prior to running it, like directly running stack build :myexecutable. It now also supports specifying an executable as the first command and if it is omitted, it will default to the first available executable in the project.

I have edited my pull request to reflect these changes.

snoyberg · Jun 15, 2018

snoyberg requested changes Jun 15, 2018

View changes

Thanks for the PR! I've left some comments below, let me know if you have any questions.

snoyberg · Jun 15, 2018

src/main/Main.hs

+      getRunCmd args = do
+          pkgComponents <- liftM (map lpvComponents . Map.elems . lpProject) getLocalPackages
+          let executables = filter isCExe $ concatMap Set.toList pkgComponents
+          let argExe = if not (null args) then find (\x -> x == (CExe $ T.pack $ head args)) executables


I realize that the not (null args) ensures that head args is total. However, I still prefer to avoid partial function calls, since they can easily turn into bugs with a refactor. Would it be possible to replace this with a pattern match, e.g.:

case args of [] -> Nothing firstArg:_ -> ...

snoyberg · Jun 15, 2018

src/main/Main.hs

+          let executables = filter isCExe $ concatMap Set.toList pkgComponents
+          let argExe = if not (null args) then find (\x -> x == (CExe $ T.pack $ head args)) executables
+                                          else Nothing
+          let firstExe = if not (null executables) then Just $ head executables else Nothing


Same applies here, though I think you can also use listToMaybe.

snoyberg · Jun 15, 2018

src/main/Main.hs

+          let argExe = if not (null args) then find (\x -> x == (CExe $ T.pack $ head args)) executables
+                                          else Nothing
+          let firstExe = if not (null executables) then Just $ head executables else Nothing
+          let (exe, args') = if isJust argExe then (argExe, tail args) else (firstExe, args)


And this could be combined with the pattern match in the above let binding to avoid the partial tail call.

snoyberg · Jun 15, 2018

src/main/Main.hs

+          let (exe, args') = if isJust argExe then (argExe, tail args) else (firstExe, args)
+          case exe of
+              Just (CExe exe') -> do
+                Stack.Build.build (const (return ())) Nothing defaultBuildOptsCLI{boptsCLITargets = [T.concat [T.pack ":", exe']]}


Slightly more idiomatic may be: T.cons ':' exe'.

snoyberg · Jun 15, 2018

src/main/Main.hs

+                Stack.Build.build (const (return ())) Nothing defaultBuildOptsCLI{boptsCLITargets = [T.concat [T.pack ":", exe']]}
+                return (T.unpack exe', args')
+              _                -> liftIO $ do
+                  hPutStrLn stderr "No executables found."


This should probably use logError instead, which would need to be outside of liftIO.

snoyberg · Jun 15, 2018

src/main/Main.hs

@@ -786,6 +792,7 @@ execCmd ExecOpts {..} go@GlobalOpts{..} =
        ExecOptsPlain -> do
          (cmd, args) <- case (eoCmd, eoArgs) of
                (ExecCmd cmd, args) -> return (cmd, args)
+                (ExecRun, args) -> return ("", args)


Can you explain why we need an empty command case here? Is this a code path which shouldn't be triggered? If so, I would rather generate an error message here, since the exec call below will fail anyway.

rszibele · Jun 23, 2018

Hello @snoyberg, thank you for your code review, it has been very insightful. I have updated my pull request according to your suggestions. I have also added docker support, as it was the code path (ExecOptsPlain) which I mistakenly left out during the implementation.

I have re-tested everything and also tested it with docker enabled.

snoyberg · Jun 24, 2018

snoyberg approved these changes Jun 24, 2018

View changes

LGTM!

Wizek · Jun 24, 2018

🎉 Hooray! Thanks guys!

rszibele added some commits Apr 1, 2018

Add run command to stack.

89108f4

Add a changelog record

Loading status checks…

32c64f2

Fix warnings

Loading status checks…

c5f2747

rszibele referenced this pull request Apr 2, 2018
Closed
can't upgrade to latest; lacking `happy` #3950

snoyberg added the needs changes label Apr 17, 2018

Merge branch 'master' into master

Verified

This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.

GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits

Loading status checks…

e1ba5a6

rszibele added some commits Jun 23, 2018

Merge https://github.com/commercialhaskell/stack

c7f3fae

changes according to code review and docker support

Loading status checks…

06e693d

improve readability

Loading status checks…

437741b

dbaynard added the awaiting review label Jun 23, 2018

readability

Loading status checks…

555f359

snoyberg merged commit e727913 into commercialhaskell:master Jun 24, 2018
2 checks passed

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details

continuous-integration/travis-ci/pr The Travis CI build passed
Details

dbaynard removed awaiting review needs changes labels Jun 25, 2018

commercialhaskell/stack

Join GitHub today

Introduce `stack run` command line option #3952

Conversation

rszibele commented Apr 1, 2018 • edited

rszibele added some commits Apr 1, 2018

rszibele referenced this pull request Apr 2, 2018

can't upgrade to latest; lacking `happy` #3950

This comment has been minimized.

AshleyYakeley commented Apr 15, 2018 • edited

This comment has been minimized.

rszibele commented Apr 15, 2018

This comment has been minimized.

AshleyYakeley commented Apr 15, 2018 • edited

This comment has been minimized.

rszibele commented Apr 15, 2018

This comment has been minimized.

AshleyYakeley commented Apr 15, 2018

This comment has been minimized.

rszibele commented Apr 16, 2018 • edited

This comment has been minimized.

AshleyYakeley commented Apr 16, 2018

snoyberg added the needs changes label Apr 17, 2018

rszibele added some commits Jun 2, 2018

This comment has been minimized.

rszibele commented Jun 4, 2018 • edited

snoyberg requested changes Jun 15, 2018 View changes

This comment has been minimized.

snoyberg Jun 15, 2018

This comment has been minimized.

snoyberg Jun 15, 2018

This comment has been minimized.

snoyberg Jun 15, 2018

This comment has been minimized.

snoyberg Jun 15, 2018

This comment has been minimized.

snoyberg Jun 15, 2018

This comment has been minimized.

snoyberg Jun 15, 2018

rszibele added some commits Jun 23, 2018

This comment has been minimized.

rszibele commented Jun 23, 2018

dbaynard added the awaiting review label Jun 23, 2018

snoyberg approved these changes Jun 24, 2018 View changes

Hide details View details snoyberg merged commit e727913 into commercialhaskell:master Jun 24, 2018 2 checks passed

2 checks passed

This comment has been minimized.

Wizek commented Jun 24, 2018

dbaynard removed awaiting review needs changes labels Jun 25, 2018

rszibele commented Apr 1, 2018 •

edited

AshleyYakeley commented Apr 15, 2018 •

edited

AshleyYakeley commented Apr 15, 2018 •

edited

rszibele commented Apr 16, 2018 •

edited

rszibele commented Jun 4, 2018 •

edited

snoyberg requested changes Jun 15, 2018

View changes

snoyberg approved these changes Jun 24, 2018

View changes

snoyberg merged commit `e727913` into commercialhaskell:master Jun 24, 2018
2 checks passed