Improve names of generated executables for scripts

bacchanalia · bacchanalia · commit fe556df38afd · 2022-01-28T14:15:42.000-05:00
diff --git a/cabal-install/src/Distribution/Client/ScriptUtils.hs b/cabal-install/src/Distribution/Client/ScriptUtils.hs
@@ -42,7 +42,7 @@ import Distribution.Client.Types
 import Distribution.FieldGrammar
     ( parseFieldGrammar, takeFields )
 import Distribution.Fields
-    ( ParseResult, parseFatalFailure, readFields )
+    ( ParseResult, Field(..), SectionArg(..), parseFatalFailure, readFields )
 import Distribution.PackageDescription.FieldGrammar
     ( executableFieldGrammar )
 import Distribution.PackageDescription.PrettyPrint
@@ -86,7 +86,7 @@ import Data.ByteString.Lazy ()
 import System.Directory
     ( canonicalizePath, doesFileExist, getTemporaryDirectory, removeDirectoryRecursive )
 import System.FilePath
-    ( (</>) )
+    ( (</>), takeFileName )
 import qualified Text.Parsec as P
 
 -- A note on multi-module script support #6787:
@@ -255,9 +255,16 @@ updateContextAndWriteProjectFile ctx scriptPath scriptExecutable = do
 
   absScript <- canonicalizePath scriptPath
   let
+    -- Replace characters which aren't allowed in the executable component name with '_'
+    -- Prefix with "cabal-script-" to make it clear to end users that the name may be mangled
+    scriptExeName = "cabal-script-" ++ map censor (takeFileName scriptPath)
+    censor c = case readFields (fromString $ "executable " ++ [c]) of
+      Right [Section _ [SecArgName _ _] _] -> c
+      _                                    -> '_'
+
     sourcePackage = fakeProjectSourcePackage projectRoot
       & lSrcpkgDescription . L.condExecutables
-      .~ [("script", CondNode executable (targetBuildDepends $ buildInfo executable) [])]
+      .~ [(fromString scriptExeName, CondNode executable (targetBuildDepends $ buildInfo executable) [])]
     executable = scriptExecutable
       & L.modulePath .~ absScript
 
diff --git a/cabal-testsuite/PackageTests/ListBin/Script/cabal.out b/cabal-testsuite/PackageTests/ListBin/Script/cabal.out
@@ -2,4 +2,4 @@
 Resolving dependencies...
 Build profile: -w ghc-<GHCVER> -O1
 In order, the following will be built:
- - fake-package-0 (exe:script) (first run)
+ - fake-package-0 (exe:cabal-script-script.hs) (first run)
diff --git a/cabal-testsuite/PackageTests/NewBuild/CmdBuild/Script/cabal.out b/cabal-testsuite/PackageTests/NewBuild/CmdBuild/Script/cabal.out
@@ -2,6 +2,6 @@
 Resolving dependencies...
 Build profile: -w ghc-<GHCVER> -O1
 In order, the following will be built:
- - fake-package-0 (exe:script) (first run)
-Configuring executable 'script' for fake-package-0..
-Building executable 'script' for fake-package-0..
+ - fake-package-0 (exe:cabal-script-script.hs) (first run)
+Configuring executable 'cabal-script-script.hs' for fake-package-0..
+Building executable 'cabal-script-script.hs' for fake-package-0..
diff --git a/cabal-testsuite/PackageTests/NewBuild/CmdBuild/ScriptBuildRepl/cabal.out b/cabal-testsuite/PackageTests/NewBuild/CmdBuild/ScriptBuildRepl/cabal.out
@@ -2,10 +2,10 @@
 Resolving dependencies...
 Build profile: -w ghc-<GHCVER> -O1
 In order, the following will be built:
- - fake-package-0 (exe:script) (first run)
-Configuring executable 'script' for fake-package-0..
-Building executable 'script' for fake-package-0..
+ - fake-package-0 (exe:cabal-script-script.hs) (first run)
+Configuring executable 'cabal-script-script.hs' for fake-package-0..
+Building executable 'cabal-script-script.hs' for fake-package-0..
 # cabal v2-repl
 Build profile: -w ghc-<GHCVER> -O1
 In order, the following will be built:
- - fake-package-0 (exe:script) (ephemeral targets)
+ - fake-package-0 (exe:cabal-script-script.hs) (ephemeral targets)
diff --git a/cabal-testsuite/PackageTests/NewBuild/CmdBuild/ScriptBuildRun/cabal.out b/cabal-testsuite/PackageTests/NewBuild/CmdBuild/ScriptBuildRun/cabal.out
@@ -2,8 +2,8 @@
 Resolving dependencies...
 Build profile: -w ghc-<GHCVER> -O1
 In order, the following will be built:
- - fake-package-0 (exe:script) (first run)
-Configuring executable 'script' for fake-package-0..
-Building executable 'script' for fake-package-0..
+ - fake-package-0 (exe:cabal-script-script.hs) (first run)
+Configuring executable 'cabal-script-script.hs' for fake-package-0..
+Building executable 'cabal-script-script.hs' for fake-package-0..
 # cabal v2-run
 Up to date
diff --git a/cabal-testsuite/PackageTests/NewBuild/CmdBuild/ScriptRerun/cabal.out b/cabal-testsuite/PackageTests/NewBuild/CmdBuild/ScriptRerun/cabal.out
@@ -2,8 +2,8 @@
 Resolving dependencies...
 Build profile: -w ghc-<GHCVER> -O1
 In order, the following will be built:
- - fake-package-0 (exe:script) (first run)
-Configuring executable 'script' for fake-package-0..
-Building executable 'script' for fake-package-0..
+ - fake-package-0 (exe:cabal-script-script.hs) (first run)
+Configuring executable 'cabal-script-script.hs' for fake-package-0..
+Building executable 'cabal-script-script.hs' for fake-package-0..
 # cabal v2-build
 Up to date
diff --git a/cabal-testsuite/PackageTests/NewBuild/CmdClean/Keep/cabal.out b/cabal-testsuite/PackageTests/NewBuild/CmdClean/Keep/cabal.out
@@ -2,14 +2,14 @@
 Resolving dependencies...
 Build profile: -w ghc-<GHCVER> -O1
 In order, the following will be built:
- - fake-package-0 (exe:script) (first run)
-Configuring executable 'script' for fake-package-0..
-Building executable 'script' for fake-package-0..
+ - fake-package-0 (exe:cabal-script-script.hs) (first run)
+Configuring executable 'cabal-script-script.hs' for fake-package-0..
+Building executable 'cabal-script-script.hs' for fake-package-0..
 # cabal v2-build
 Resolving dependencies...
 Build profile: -w ghc-<GHCVER> -O1
 In order, the following will be built:
- - fake-package-0 (exe:script) (configuration changed)
-Configuring executable 'script' for fake-package-0..
-Building executable 'script' for fake-package-0..
+ - fake-package-0 (exe:cabal-script-script2.hs) (first run)
+Configuring executable 'cabal-script-script2.hs' for fake-package-0..
+Building executable 'cabal-script-script2.hs' for fake-package-0..
 # cabal v2-clean
diff --git a/cabal-testsuite/PackageTests/NewBuild/CmdClean/Orphan/cabal.out b/cabal-testsuite/PackageTests/NewBuild/CmdClean/Orphan/cabal.out
@@ -2,14 +2,14 @@
 Resolving dependencies...
 Build profile: -w ghc-<GHCVER> -O1
 In order, the following will be built:
- - fake-package-0 (exe:script) (first run)
-Configuring executable 'script' for fake-package-0..
-Building executable 'script' for fake-package-0..
+ - fake-package-0 (exe:cabal-script-script.hs) (first run)
+Configuring executable 'cabal-script-script.hs' for fake-package-0..
+Building executable 'cabal-script-script.hs' for fake-package-0..
 # cabal v2-build
 Resolving dependencies...
 Build profile: -w ghc-<GHCVER> -O1
 In order, the following will be built:
- - fake-package-0 (exe:script) (configuration changed)
-Configuring executable 'script' for fake-package-0..
-Building executable 'script' for fake-package-0..
+ - fake-package-0 (exe:cabal-script-script2.hs) (first run)
+Configuring executable 'cabal-script-script2.hs' for fake-package-0..
+Building executable 'cabal-script-script2.hs' for fake-package-0..
 # cabal v2-clean
diff --git a/cabal-testsuite/PackageTests/NewBuild/CmdClean/Script/cabal.out b/cabal-testsuite/PackageTests/NewBuild/CmdClean/Script/cabal.out
@@ -2,7 +2,7 @@
 Resolving dependencies...
 Build profile: -w ghc-<GHCVER> -O1
 In order, the following will be built:
- - fake-package-0 (exe:script) (first run)
-Configuring executable 'script' for fake-package-0..
-Building executable 'script' for fake-package-0..
+ - fake-package-0 (exe:cabal-script-script.hs) (first run)
+Configuring executable 'cabal-script-script.hs' for fake-package-0..
+Building executable 'cabal-script-script.hs' for fake-package-0..
 # cabal v2-clean
diff --git a/cabal-testsuite/PackageTests/NewBuild/CmdRepl/Script/cabal.out b/cabal-testsuite/PackageTests/NewBuild/CmdRepl/Script/cabal.out
@@ -2,5 +2,5 @@
 Resolving dependencies...
 Build profile: -w ghc-<GHCVER> -O1
 In order, the following will be built:
- - fake-package-0 (exe:script) (first run)
-Configuring executable 'script' for fake-package-0..
+ - fake-package-0 (exe:cabal-script-script.hs) (first run)
+Configuring executable 'cabal-script-script.hs' for fake-package-0..
diff --git a/cabal-testsuite/PackageTests/NewBuild/CmdRepl/ScriptRerun/cabal.out b/cabal-testsuite/PackageTests/NewBuild/CmdRepl/ScriptRerun/cabal.out
@@ -2,9 +2,9 @@
 Resolving dependencies...
 Build profile: -w ghc-<GHCVER> -O1
 In order, the following will be built:
- - fake-package-0 (exe:script) (first run)
-Configuring executable 'script' for fake-package-0..
+ - fake-package-0 (exe:cabal-script-script.hs) (first run)
+Configuring executable 'cabal-script-script.hs' for fake-package-0..
 # cabal v2-repl
 Build profile: -w ghc-<GHCVER> -O1
 In order, the following will be built:
- - fake-package-0 (exe:script) (first run)
+ - fake-package-0 (exe:cabal-script-script.hs) (first run)
diff --git a/cabal-testsuite/PackageTests/NewBuild/CmdRun/Script/cabal.out b/cabal-testsuite/PackageTests/NewBuild/CmdRun/Script/cabal.out
@@ -2,6 +2,6 @@
 Resolving dependencies...
 Build profile: -w ghc-<GHCVER> -O1
 In order, the following will be built:
- - fake-package-0 (exe:script) (first run)
-Configuring executable 'script' for fake-package-0..
-Building executable 'script' for fake-package-0..
+ - fake-package-0 (exe:cabal-script-script.hs) (first run)
+Configuring executable 'cabal-script-script.hs' for fake-package-0..
+Building executable 'cabal-script-script.hs' for fake-package-0..
diff --git a/cabal-testsuite/PackageTests/NewBuild/CmdRun/ScriptLiterate/cabal.out b/cabal-testsuite/PackageTests/NewBuild/CmdRun/ScriptLiterate/cabal.out
@@ -2,6 +2,6 @@
 Resolving dependencies...
 Build profile: -w ghc-<GHCVER> -O1
 In order, the following will be built:
- - fake-package-0 (exe:script) (first run)
-Configuring executable 'script' for fake-package-0..
-Building executable 'script' for fake-package-0..
+ - fake-package-0 (exe:cabal-script-script.lhs) (first run)
+Configuring executable 'cabal-script-script.lhs' for fake-package-0..
+Building executable 'cabal-script-script.lhs' for fake-package-0..
diff --git a/cabal-testsuite/PackageTests/NewBuild/CmdRun/ScriptNoExtention/cabal.out b/cabal-testsuite/PackageTests/NewBuild/CmdRun/ScriptNoExtention/cabal.out
@@ -2,6 +2,6 @@
 Resolving dependencies...
 Build profile: -w ghc-<GHCVER> -O1
 In order, the following will be built:
- - fake-package-0 (exe:script) (first run)
-Configuring executable 'script' for fake-package-0..
-Building executable 'script' for fake-package-0..
+ - fake-package-0 (exe:cabal-script-script_with_spaces) (first run)
+Configuring executable 'cabal-script-script_with_spaces' for fake-package-0..
+Building executable 'cabal-script-script_with_spaces' for fake-package-0..
diff --git a/cabal-testsuite/PackageTests/NewBuild/CmdRun/ScriptRerun/cabal.out b/cabal-testsuite/PackageTests/NewBuild/CmdRun/ScriptRerun/cabal.out
@@ -2,8 +2,8 @@
 Resolving dependencies...
 Build profile: -w ghc-<GHCVER> -O1
 In order, the following will be built:
- - fake-package-0 (exe:script) (first run)
-Configuring executable 'script' for fake-package-0..
-Building executable 'script' for fake-package-0..
+ - fake-package-0 (exe:cabal-script-script.hs) (first run)
+Configuring executable 'cabal-script-script.hs' for fake-package-0..
+Building executable 'cabal-script-script.hs' for fake-package-0..
 # cabal v2-run
 Up to date
diff --git a/changelog.d/pr-7851 b/changelog.d/pr-7851
@@ -1,6 +1,6 @@
 synopsis:  Better support for scripts
 packages: cabal-install
-prs: #7851 #7925
+prs: #7851 #7925 #7938
 issues: #7842 #7073 #6354 #6149
 
 description: {
@@ -12,5 +12,7 @@ description: {
 - `cabal clean script` added. It will clean the cache for script.
 - `cabal clean` will now remove script caches for which there is no marching script.
 - `cabal list-bin` now works with scripts
+- The name of the generated script executable has been changed from "script" to
+  "cabal-script-<your-sanitized-script-name>" for easier process management.
 
 }
